Logging

The server process logs to the file ${sys:xserver.logdirectory}/xserver.log. Each backend process logs to its own file named ${sys:xserver.logdirectory}/m0001.log, ${sys:xserver.logdirectory}/m0002.log and so on.

To configure which requests and responses are to be logged, set core.logging.logRequests or core.logging.logResponses in conf/xserver.conf to one of the following values:

• true All requests / responses are logged.
• exceptional Only requests / responses which caused an exception are logged. Requests which are rejected or could not be validated against the WSDL / WADL are never logged.
• fatal Only request which caused a fatal exception such as an internal error or a module restart are logged. This value is not a valid option for core.logging.logResponses.
• false Requests / responses are not logged at all.

To log requests and responses to a different log file uncomment the RollingFile appender named RequestLog and the Logger RequestLogging in the configuration conf/logging.xml. The requests and responses will then be written to the file ${sys:xserver.logdirectory}/requests.log.

By default only exceptional requests and no responses are logged.

Synopsis: Configuration steps to have HTTP request headers logged to a certain logfile :

1. Add all HTTP request header names as comma-separated list to core.logging.selectedRequestHeaders in conf/xserver.conf to make them available for logging.
2. Add the conversion specifier %X for the context map to the conversion pattern of the logfile appender in conf/logging.xml

Example: Log HTTP headers Accept and traceparent to ${sys:xserver.logdirectory}/request.statistics.log:

1. conf/xserver.conf:
   

       "core.logging.selectedRequestHeaders" : [ "accept", "traceparent" ]

2. conf/logging.xml:
   

       <RollingFile fileName="${sys:xserver.logdirectory}/request-statistics.log"
                    filePattern="${sys:xserver.logdirectory}/archive/request-statistics-%d{MM-dd-yyyy}.log.gz"
                    name="RequestStatisticsLog">
          <Policies>
           <TimeBasedTriggeringPolicy/>
         </Policies>
         <!-- Notice: Additional pattern provided here to assure that the column names are logged in an appropriate way.
              This works as the line with the column headers is logged with the marker 'LOG_HEADERS'. -->
         <PatternLayout>
           <MarkerPatternSelector defaultPattern="%d;%m;%X%n">
             <PatternMatch key="LOG_HEADERS" pattern="%d;%m;http-headers%n"/>
           </MarkerPatternSelector>
         </PatternLayout>
       </RollingFile>

Additional information:

• HTTP header names can be used as keys for the context map to filter the output with the conversion specifier %X (cf. Log4j documentation).
• HTTP header names are by specification case-insensitive, thus accept is equal to Accept.
• The notation of an HTTP header name should not differ between conf/xserver.conf and conf/logging.xml.
• The logging of HTTP headers can be applied to any logfile appender that is defined in conf/logging.xml.
• To preserve the structure of the logfiles some characters like ';' etc. are by default converted to a replacement before they are logged.

For scripting there's also a separate log file called ${sys:xserver.logdirectory}/scripting.log. To enable scripting logs uncomment the RollingFile appender named ScriptingLog and the Logger ScriptingLogger in the configuration conf/logging.xml.