To customize the access log output format:

1. Define the format name of the access log.
   To create a new format, add the new format name in the webserver.logger.access_log.format_list parameter in the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file.
   

   Example settings

   ... <param> <param-name>webserver.logger.access_log.format_list</param-name> <param-value>formatA</param-value> </param> ...

   For creating a new format, reference the access log format provided by default. For details on the format, see (2) Access log format.
   
2. Define the output format for the access log.
   Define the access log output format in the format specified in format-name with the webserver.logger.access_log.format-name parameter within the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. Specify the argument for the access log format in the output format definition.
   

   Example settings

   ... <param> <param-name>webserver.logger.access_log.formatA</param-name> <param-value>%h %u %t &quot;%r&quot; %&gt;s HostHeader=&quot;%{host}i&quot;</param-value> </param> ...

   For details on the specifiable format arguments, see (3) Arguments of the access log format.
   
3. Specify the format that will be used to output the access log.
   Specify the format name that will be used to output the access log with the webserver.logger.access_log.inprocess_http.usage_format parameter within the <configuration> tag of the logical J2EE server (j2ee-server) in the Easy Setup definition file. An access log is output in the format specified here:
   

   Example settings

   ... <param> <param-name>webserver.logger.access_log.inprocess_http.usage_format</param-name> <param-value>formatA</param-value> </param> ...

Application Server provides two types of formats namely common (default format) and combined (extended format) as the access log formats of the in-process HTTP server. When creating a new format, reference these formats.

(a) Output format

The output format of access log is described below. Note that indicates one-byte space. Also, for the convenience of expression, the log is output across multiple lines, but the log is actually output in one line.

The output format of a default format is as follows:

 
Host-name-or-IP-address-of-Web-client Remote-log-name Authentication-user-name
Start-time-of- Web-client-request-processing Request-line
Final-status-code  Number-of-bytes-sent-excluding-the-HTTP-header

The output format of an extended format is described below:

 
Host-name-or-IP-address-of-Web-client Remote-log-name Authentication-user-name
Start-time-of- Web-client-request-processing Request-line
Final-status-code  Number-of-bytes-sent-excluding-the-HTTP-header
 "Referer-header-contents"  "User-Agent-header-contents"
 

The underlined part is the difference between the default format and extended format. In the extended format, Referer header contents and User-Agent header contents is output in addition to the output contents of the default format.

(b) Example of output

An example of access log output in the default format is as follows:

10.20.30.40 - user [20/Dec/2004: 15: 45: 01 +0900] "GET /index.html HTTP/1.1" 200 8358
10.20.30.40 - user [20/Dec/2004: 15: 45: 01 +0900] "GET /left.html HTTP/1.1" 200 2358
10.20.30.40 - user [20/Dec/2004: 15: 45: 01 +0900] "GET /right.html HTTP/1.1" 200 4358

An example of access log output in the extended format is as follows:

10.20.30.40 - - [18/Jan/2005: 13: 06: 10 +0900] "GET / HTTP/1.0" 200 38 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) "
10.20.30.40 - - [18/Jan/2005: 13: 06: 25 +0900] "GET /demo/ HTTP/1.0" 500 684 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) "

The following table lists the arguments of the access log format that are specified when you define the output format of the format:

Table 5-27 List of arguments of the access log format

#1

The remote log name is the user name in the Web client that can be acquired with the Identification protocol defined in RFC 1413.

#2

The session ID displayed in %S is the value of the Cookie name 'JSESSIONID'. This session ID is different from the global session ID in the memory session failover functionality. When you want to output the global session ID, specify %{GSESSIONID}c. If GIDCookieName is changed, specify the value of the changed GIDCookieName.

#3

The same header name might be sent multiple times in one HTTP request or HTTP response. In this case, the contents of the header read first will be output.

Note

If there is an error in the specification of the format argument, the default format is used. The example of the use of the default format is as follows:

• When strings not existing in the list of format arguments (example: %G) is specified
• When 0 characters (such as %{}i) are specified in the request header contents, response header contents, and Cookie name.

Reference note

If the default format and extended format are coded in the format arguments, the format is as follows:

• Default format
  %h %l %u %t "%r" %>s %b
  
• Extended format
  %h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-Agent}i"