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	LogEntry Attribute	Type
%%	N/A	N/A
%a	entry.remote_address	str
%{c}a	entry.remote_client_address	str
%A	entry.local_address	str
%b	entry.bytes_sent	int or None
%B	entry.bytes_sent	int
%{name}c	entry.cryptography[name] [1]	str or None
%{name}C	entry.cookies[name] [1]	str* or None
%D	entry.request_duration_microseconds	int
%{name}e	entry.env_vars[name] [1]	str* or None
%f	entry.request_file	str* or None
%h	entry.remote_host	str*
%{c}h	entry.remote_underlying_host	str*
%H	entry.request_protocol	str* or None
%{name}i	entry.headers_in[name] [1]	str* or None
%I	entry.bytes_in	int
%k	entry.requests_on_connection	int
%l	entry.remote_logname	str* or None
%L	entry.request_log_id	str or None
%{c}L	entry.connection_log_id	str or None
%m	entry.request_method	str* or None
%{name}n	entry.notes[name] [1]	str* or None
%{name}o	entry.headers_out[name] [1]	str* or None
%O	entry.bytes_out	int
%p	entry.server_port	int
%{canonical}p	entry.server_port	int
%{local}p	entry.local_port	int
%{remote}p	entry.remote_port	int
%P	entry.pid	int
%{hextid}P [2]	entry.tid	int
%{pid}P	entry.pid	int
%{tid}P	entry.tid	int
%q	entry.request_query	str*
%r	entry.request_line	str* or None
%R	entry.handler	str* or None
%s	entry.status	int or None
%S	entry.bytes_combined	int
%t	entry.request_time_fields["timestamp"]	aware datetime.datetime
%{sec}t	entry.request_time_fields["epoch"]	int
%{msec}t	entry.request_time_fields["milliepoch"]	int
%{usec}t	entry.request_time_fields["microepoch"]	int
%{msec_frac}t	entry.request_time_fields["msec_frac"]	int
%{usec_frac}t	entry.request_time_fields["usec_frac"]	int
%{strftime_format}t	entry.request_time_fields (See below)	(See below)
%T	entry.request_duration_seconds	int
%{ms}T	entry.request_duration_milliseconds	int
%{us}T	entry.request_duration_microseconds	int
%{s}T	entry.request_duration_seconds	int
%u	entry.remote_user	str* or None
%U	entry.request_uri	str* or None
%v	entry.virtual_host	str*
%V	entry.server_name	str*
%{name}x	entry.variables[name] [1]	str or None
%X	entry.connection_status	str
%^FB	entry.ttfb	int or None
%{name}^ti	entry.trailers_in[name] [1]	str* or None
%{name}^to	entry.trailers_out[name] [1]	str* or None

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	request_time_fields key	Type
%%	N/A	N/A
%a	"abbrev_wday"	str
%A	"full_wday"	str
%b	"abbrev_mon"	str
%B	"full_mon"	str
%C	"century"	int
%d	"mday"	int
%D	"date"	datetime.date
%e	"mday"	int
%F	"date"	datetime.date
%g	"abbrev_iso_year"	int
%G	"iso_year"	int
%h	"abbrev_mon"	str
%H	"hour"	int
%I	"hour12"	int
%j	"yday"	int
%m	"mon"	int
%M	"min"	int
%n	N/A	N/A
%p	"am_pm"	str
%R	"hour_min"	datetime.time
%s	"epoch"	int
%S	"sec"	int
%t	N/A	N/A
%T	"time"	datetime.time
%u	"iso_wday"	int
%U	"sunday_weeknum"	int
%V	"iso_weeknum"	int
%w	"wday"	int
%W	"monday_weeknum"	int
%y	"abbrev_year"	int
%Y	"year"	int
%z	"timezone"	datetime.timezone or None
%Z	"tzname"	str

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, and variables attributes are case-insensitive dicts.

[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 to apachelogs.