Share via


2.2 Logging Message: W3C Syntax

A W3C format logging message consists of the values of various fields, each value separated from the next by a single space character. Logging messages that adhere to this syntax are said to use the W3C format because the syntax is conformant with the syntax for logging entries in the Extended Log File Format (for more information, see [W3C-EXLOG]), which is defined by W3C.

Section 2.2.1 specifies the W3C format syntax used in most logging messages. Section 2.2.2 specifies the W3C format syntax used in certain Rendering Log messages.

The sections mentioned earlier define the ordering of the fields in the W3C format syntax but not how the values of the fields are assigned. The rules governing the values of the individual fields depend on the logging message in which the W3C format syntax is used. For example, the s-ip field is used as defined in section 2.1.43 for some logging messages, while other logging messages provide an alternate definition of the s-ip field.

All W3C format syntax MUST use the UTF-8 character set as specified in [RFC3629]. In any fields that specify a URL, such as cs-url, the URL MUST be encoded using percent-encoding, as specified in [RFC3986] section 2.1.

A single dash character (which is represented by U+002D and by "-" in ABNF syntax) MUST be used to indicate that the value is empty—that is, it is either not available or not applicable.

All spaces embedded within a field value MUST be replaced by an underscore character (which is represented by U+005F and by "_" in ABNF syntax). For example, "MPEG Layer-3" would be transformed into "MPEG_Layer-3" in a W3C-format logging message.

Note Transformations defined in this section are not necessarily reversible. Methods for parsing, analyzing, or extracting information from logging messages are implementation-specific and are outside the scope of this specification.