Enabling Debug Logs for OIDC

For better error analysis, you can enable a debug log output for OIDC.

Note:

WildFly Elytron provides only limited meaningful log messages. For detailed analysis, manual debugging is sometimes required. However, X4 provides its own log messages that allow an initial analysis.

To enable debug logs for OIDC

Open the standalone.xml file in the <server_directory>\wildfly\standalone\configuration directory.

Search for the following item:

XML

<subsystem xmlns="urn:jboss:domain:logging:x.x">

Add this handler below to print the debug logs into the WildFly console:

XML

<console-handler name="CONSOLE_DEBUG">
      <level name="DEBUG"/>
      <formatter>
          <named-formatter name="COLOR-PATTERN"/>
      </formatter>
</console-handler>

Then add this logger to enable the debug log for each class below package de.softproject.x4.auth:

XML

<logger category="de.softproject.x4.auth">
  <level name="DEBUG"/>
  <handlers>
    <handler name="CONSOLE_DEBUG"/>
  </handlers>
</logger>

Example output

If everything is set up correctly, debug messages such as the following appear in the WildFly console when an HTTP request is received by the server:

...
13:30:36,184 DEBUG [de.softproject.x4.auth.filter.X4JaxRSOidcAuthFilter] (default task-1) X4JaxRSOidcAuthFilter called for /X4/webapp/rest/metadata/dpr/WebAppProject_4 with 83edf835-9a8c-4eab-aa90-d1b97bd9d23e
13:30:36,185 DEBUG [de.softproject.x4.auth.filter.X4JaxRSOidcAuthFilter] (default task-4) X4JaxRSOidcAuthFilter called for /X4/webapp/rest/metadata/messages/WebAppProject_4 with 81fbc671-cbcd-4723-94af-447c54411888
13:30:36,196 DEBUG [de.softproject.x4.auth.filter.X4JaxRSOidcAuthFilter] (default task-1) X4JaxRSOidcAuthFilter authenticated =  true for /X4/webapp/rest/metadata/dpr/WebAppProject_4 with 83edf835-9a8c-4eab-aa90-d1b97bd9d23e
13:30:36,200 DEBUG [de.softproject.x4.auth.filter.X4JaxRSOidcAuthFilter] (default task-4) X4JaxRSOidcAuthFilter authenticated =  true for /X4/webapp/rest/metadata/messages/WebAppProject_4 with 81fbc671-cbcd-4723-94af-447c54411888
13:30:36,276 DEBUG [de.softproject.x4.auth.tokenhandler.elytron.filter.TokenHandlerServletFilter] (default task-4) TokenHandlerServletFilter called for /X4/webapp/rest/appconfig/WebAppProject_4/component/1e875f200630522ef9c09481f341830f3e36651126e0edf9f16152289a3d9305 with bb1d2f0a-8aef-47ba-93f9-e491b29782bb will be SKIPPED
13:30:36,277 DEBUG [de.softproject.x4.auth.filter.X4ServletOidcAuthFilter] (default task-4) X4ServletOidcAuthFilter called for /X4/webapp/rest/appconfig/WebAppProject_4/component/1e875f200630522ef9c09481f341830f3e36651126e0edf9f16152289a3d9305 with cd69be98-18bb-4add-92aa-42882afd0f26
13:30:36,278 DEBUG [de.softproject.x4.auth.filter.X4ServletOidcAuthFilter] (default task-4) X4ServletOidcAuthFilter  authenticated =  true for /X4/webapp/rest/appconfig/WebAppProject_4/component/1e875f200630522ef9c09481f341830f3e36651126e0edf9f16152289a3d9305 with cd69be98-18bb-4add-92aa-42882afd0f26
13:30:36,283 DEBUG [de.softproject.x4.auth.tokenhandler.elytron.filter.TokenHandlerJaxRsFilter] (default task-4) TokenHandlerJaxRsFilter called for /X4/webapp/rest/appconfig/WebAppProject_4/component/1e875f200630522ef9c09481f341830f3e36651126e0edf9f16152289a3d9305 with 4d158364-6a1b-47bb-8631-2f899eda2b9c
13:30:36,289 DEBUG [de.softproject.x4.auth.tokenhandler.elytron.filter.TokenHandlerJaxRsFilter] (default task-4) TokenHandlerJaxRsFilter result EXCHANGE_AUTHENTICATION for /X4/webapp/rest/appconfig/WebAppProject_4/component/1e875f200630522ef9c09481f341830f3e36651126e0edf9f16152289a3d9305 with 4d158364-6a1b-47bb-8631-2f899eda2b9c
...