Supported Directives¶
The following table lists the log format directives supported by this library
along with the names & types of the attributes at which their parsed values are
stored on a LogEntry
. The attribute names for the directives are based off
of the names used internally by the Apache source code.
A directive with the <
modifier (e.g., %<s
) will be stored at
entry.original_attribute_name
, and a directive with the >
modifier will be stored at entry.final_attribute_name
A type of str
marked with an asterisk (*) means that the directive’s values
are decoded according to the encoding
option to LogParser
.
Any directive may evaluate to None
when it is modified by a set of status
codes (e.g., %400,501T
or %!200T
).
See the Apache documentation for information on the meaning of each directive.
Directive |
|
Type |
---|---|---|
|
N/A |
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
aware |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(See below) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Supported strftime
Directives¶
The following table lists the strftime
directives supported for use in the
parameter of a %{*}t
directive along with the keys & types at which they
are stored in the dict
entry.request_time_fields
. See any C
documentation for information on the meaning of each directive.
A %{*}t
directive with the begin:
modifier (e.g.,
%{begin:%Y-%m-%d}t
) will have its subdirectives stored in
entry.begin_request_time_fields
(in turn used to set
entry.begin_request_time
), and likewise for the end:
modifier.
Directive |
|
Type |
---|---|---|
|
N/A |
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Footnotes
- 1(1,2,3,4,5,6,7,8,9)
The
cookies
,cryptography
,env_vars
,headers_in
,headers_out
,notes
,trailers_in
,trailers_out
, andvariables
attributes are case-insensitivedict
s.- 2
Apache renders
%{hextid}P
as either a decimal integer or a hexadecimal integer depending on the APR version available.apachelogs
expects%{hextid}P
to always be in hexadecimal; if your Apache produces decimal integers instead, you must instead use%{tid}P
in the log format passed toapachelogs
.