request-log-format

Syntax

request-log-format = directives

Description

Contains the format in which a customized request log should be created.

Options

There are two form of directives:
%directive
The value of the directive will be written to the request log.
%!directive
SHA256 hash of the value will be written to the request log.

The following directives can be used:

%a
Remote IP Address.
%A
Local IP Address.
%b
Bytes in the reply excluding HTTP headers in CLF format: '-' instead of 0 when no bytes are returned.
%B
Bytes in the reply excluding HTTP headers.
%{Attribute}C
Attribute from the Security Verify Access credential named "Attribute".
%c
The HTTP response status received from the junctioned server.
%{cookie-name}e
Contents of the cookie "cookiename" in the request.
%{cookie-name}E
Contents of the cookie "cookiename" in the response.
%d
Transaction identifier, or session sequence number.
%F
Time taken to serve the request in microseconds.
%h
Remote host.
%H
Request protocol.
%{header-name}i
Contents of the Header header-name in the request.
%j
The name of the junction in the request.
%J
The length of time, in microseconds, that the junction server spent processing the request. This will include the time that it took to send the request to the server, the length of time that it took the server to process the request, and the length of time that it took to read and process the response header.
%l
Remote logname.
%m
Request method (that is, GET, POST, HEAD).
%M
The time, in Common Log Format, at which the request was received with millisecond precision.
%{header-name}o
Contents of the Header header-name in the reply.
%p
Port of the WebSEAL server the request was served on.
%q
The query string (prepended with '?' or empty).
%Q
Logs raw query strings that the user must decode manually.
%r
First line of the request.
%R
First line of the request including HTTP://HOSTNAME.
%s
Status.
%S
The hostname of the junctioned server which serviced this request.
%t
Time and date in CLF format.
%{format}t
The time and date in the given format.

The "format" is the same format options as the UNIX "date" command. For example:

%a
Displays the locale's abbreviated weekday name.
%A
Displays the locale's full weekday name.
%b
Displays the locale's abbreviated month name.
%B
Displays the locale's full month name.
%c
Displays the locale's appropriate date and time representation. This is the default.
%C
Displays the first two digits of the four-digit year as a decimal number (00-99). A year is divided by 100 and truncated to an integer.
%d
Displays the day of the month as a decimal number (01-31). In a two-digit field, a 0 is used as leading space fill.
%D
Displays the date in the format equivalent to %m/%d/%y.
%e
Displays the day of the month as a decimal number (1-31). In a two-digit field, a blank space is used as leading space fill.
%h
Displays the locale's abbreviated month name (a synonym for %b).
%H
Displays the hour (24-hour clock) as a decimal number (00-23).
%I
Displays the hour (12-hour clock) as a decimal number (01-12).
%j
Displays the day of year as a decimal number (001-366).
%k
Displays the 24-hour-clock hour clock as a right-justified, space-filled number ( 0 to 23).
%m
Displays the month of year as a decimal number (01-12).
%M
Displays the minutes as a decimal number (00-59).
%n
Inserts a <new-line> character.
%p
Displays the locale's equivalent of either AM or PM.
%r
Displays 12-hour clock time (01-12) using the AM-PM notation; in the POSIX locale, this is equivalent to %I:%M:%S %p.
%S
Displays the seconds as a decimal number (00- 59).
%s
Displays the number of seconds since January 1, 1970, Coordinated Universal Time (CUT).
%t
Inserts a <tab> character.
%T
Displays the 24-hour clock (00-23) in the format equivalent to HH:MM:SS.
%u
Displays the weekday as a decimal number from 1-7 (Sunday = 7). Refer to the %w field descriptor.
%U
Displays week of the year(Sunday as the first day of the week) as a decimal number[00 - 53] . All days in a new year preceding the first Sunday are considered to be in week 0.
%V
Displays the week of the year as a decimal number from 01-53 (Monday is used as the first day of the week). If the week containing January 1 has four or more days in the new year, then it is considered week 01; otherwise, it is week 53 of the previous year.
%w
Displays the weekday as a decimal number from 0-6 (Sunday = 0). Refer to the %u field descriptor.
%W
Displays the week number of the year as a decimal number (00-53) counting Monday as the first day of the week.
%x
Displays the locale's appropriate date representation.
%X
Displays the locale's appropriate time representation.
%y
Displays the last two numbers of the year (00-99).
%Y
Displays the four-digit year as a decimal number.
%Z
Displays the time-zone name, or no characters if no time zone is determinable.
%%
Displays a % (percent sign) character.
%T
Time taken to serve the request in seconds.
%u
Remote user.
%U
The URL requested.
%v
Canonical ServerName of the server serving the request.
%z
The path portion of the URL in decoded form.
%Z
The path portion of the URL in raw form.

Usage

The request-log-format string CANNOT contain the # character.

Default value

The default of this parameter is equivalent to the normal default log output. It is commented out by default.

Example

Example on UNIX or Linux®:

request-log-format = %h %l %u %t "%r" %s %b