Complete token list for access log format

Technical Discussion
1

I’m looking for some reference documentation describing tokens that are allowed in Format field of Access Logging HTTP Service configuration (the default setting is “%client.name% %auth-user-name% %datetime% %request% %status% %response.length%”.

2

Hi,

Firstly, go to the admin console → Configurations → server-config → HTTP Service and then click on Help at the top right.

001
0011001×589 91.4 KB

At the pop-up help page scroll to the Format, the available access log fields are there.

002
0021201×765 95.8 KB

Furthermore, the following are the copied from that help page.

Format

    String value that specifies what information is to be captured in the access log and the order in which it is captured. The default value is as follows:

    %client.name% %auth-user-name% %datetime% %request% %status% %response.length%

    The following values are available for inclusion in the format string:

    %attribute.name%
        Logs the value (by calling its toString method) of the request attribute with the given name

    %auth-user-name%
        Name of authorized user

    %client.name%
        Client host name

    %client.dns%
        Client DNS

    %cookie.name%
        The value of the request cookie with the given name

    %cookie.value%
        The value of the first cookie found in the request

    %datetime%
        System date

    %request%
        Full HTTP request line

    %status%
        Status

    %response.length%
        Response content length

    %header.referer%
        Referer header

    %header.user-agent%
        User agent header

    %http-method%
        HTTP method

    %http-uri%
        HTTP URI

    %query-str%
        HTTP query string
    %http-version%

        HTTP protocol version

    %header.accept%
        Accept header

    %header.date%
        Date header

    %header.if-mod-since%
        If-Modified-Since header

    %header.auth%
        Authorization header

    %header.any%
        Any valid HTTP header value defined in RFC 2616 (any is also a valid header value; it is specified as a variable here)

    %session.name%
        The value of the session attribute with the name name, or NULL-SESSION-ATTRIBUTE-name if the named attribute does not exist in the session, or NULL-SESSION if no session exists

    %time-taken%
        Time (in milliseconds) it took to service each request

    %vs.id%
        Virtual server ID
1 Like
3

Thank you. That’s what I was looking for.

1 Like