View source for Undertow WildFly Subsystem Configuration - access-log

=Internal=

* [[Undertow WildFly Subsystem Configuration#access-log|Undertow WildFly Subsystem Configuration]]

=Overview=

This page documents the configuration of the Undertow <tt>AccessLogHandler</tt>. The handler generates log entries for each request. The handler can log any attributed that is provided with the <tt>ExchangeAttribute</tt> mechanism. The most common are presented below in the [[#Log_Patterns|Log Patterns]] section.

<pre>
<subsystem xmlns="urn:jboss:domain:undertow:3.0">

   ...

   <server name="default-server">
      ...
      <host name="default-host" alias="localhost">
         <location name="/" .../>
         <access-log/>
         ...
      </host>
   </server>

   <servlet-container .../>

   ...

 </subsystem>
</pre>

=Configurable Attributes=

==pattern==

<pre>
<access-log pattern='%h %l %u %t "%r" %s %b %D'/>
</pre>

The default value is "common".

==worker==

The default value is "default".

==directory==

The default value is "${jboss.server.log.dir}"

==relative-to==

The default value is "access_log"

==suffix==

The default value is ".log"

==rotate==

The default value is "true"

==use-server-log==

The default value is "false"

==extended==

The default value is "false"

==predicate==

=Log Patterns=

==Named Patterns==

"<tt>common</tt>": <tt>%h %l %u %t "%r" %s %b</tt>

"<tt>combined</tt>": <tt> %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"</tt>

==Pattern Elements==

* <tt>%a</tt> remote IP address
* <tt>%A</tt> local IP address
* <tt>%b</tt> bytes sent, excluding HTTP headers, or '-' if no bytes were sent
* <tt>%B</tt> bytes sent, excluding HTTP headers
* <tt>%h</tt> remote host name
* <tt>%H</tt> request protocol
* <tt>%l</tt> remote logical username from identd (always returns '-')
* <tt>%m</tt> request method
* <tt>%p</tt> local port
* <tt>%q</tt> query string (excluding the '?' character)
* <tt>%r</tt> first line of the request
* <tt>%s</tt> HTTP status code of the response
* <tt>%t</tt> date and time, in Common Log Format format
* <tt>%u</tt> remote user that was authenticated
* <tt>%U</tt> requested URL path
* <tt>%v</tt> local server name
* <tt>%D</tt> time taken to process the request, in milliseconds. If under a millisecond, it will show as "-".
* <tt>%T</tt> time taken to process the request, in seconds
* <tt>%I</tt> current request thread name

The handler can also log cookie, header or session information. The patterns are borrowed from the apache log syntax:

* <tt>%{i,xxx}</tt> incoming headers
* <tt>%{o,xxx}</tt> outgoing response headers
* <tt>%{c,xxx}</tt> specific cookie
* <tt>%{r,xxx} xxx</tt> an attribute in the ServletRequest
* <tt>%{s,xxx} xxx</tt> an attribute in the HttpSession