DOC: configuration: rework the custom log format table

Rework the custom log format table to add sample fetch alternatives.

Split the timestamps and the timers from the rest of the tags.
This commit is contained in:
William Lallemand 2023-07-28 10:46:24 +02:00
parent 2f8c44cfb7
commit d52da4ef70

View File

@ -23516,75 +23516,176 @@ Flags are :
Please refer to the table below for currently defined variables : Please refer to the table below for currently defined variables :
+---+------+-----------------------------------------------+-------------+ +---+------+------------------------------------------------------+---------+
| R | var | field name (8.2.2 and 8.2.3 for description) | type | | R | var | field name (8.2.2 and 8.2.3 for description) | type |
+---+------+-----------------------------------------------+-------------+ | | | sample fetch alternative | |
| | %o | special variable, apply flags on all next var | | +===+======+======================================================+=========+
+---+------+-----------------------------------------------+-------------+ | | %o | special variable, apply flags on all next var | |
| | %B | bytes_read (from server to client) | numeric | +---+------+------------------------------------------------------+---------+
| H | %CC | captured_request_cookie | string | | date formats |
| H | %CS | captured_response_cookie | string | +---+------+------------------------------------------------------+---------+
| | %H | hostname | string | | | %T | Accept date UTC + timezone | |
| H | %HM | HTTP method (ex: POST) | string | | | | %[accept_date,utime("%d/%b/%Y:%H:%M:%S %z")] | date |
| H | %HP | HTTP request URI without query string | string | +---+------+------------------------------------------------------+---------+
| H | %HPO | HTTP path only (without host nor query string)| string | | | %Tl | Accept date local + timezone | |
| H | %HQ | HTTP request URI query string (ex: ?bar=baz) | string | | | | %[accept_date,ltime("%d/%b/%Y:%H:%M:%S %z")] | date |
| H | %HU | HTTP request URI (ex: /foo?bar=baz) | string | +---+------+------------------------------------------------------+---------+
| H | %HV | HTTP version (ex: HTTP/1.0) | string | | | %Ts | Accept date as a UNIX timestamp | numeric |
| | %ID | unique-id | string | +---+------+------------------------------------------------------+---------+
| | %ST | status_code | numeric | | | %t | Accept date local (with millisecond resolution) | |
| | %T | gmt_date_time | date | | | | %[accept_date(ms),ms_ltime("%d/%b/%Y:%H:%M:%S.%3N")] | date |
| H | %Ta | Active time of the request (from TR to end) | numeric | +---+------+------------------------------------------------------+---------+
| | %Tc | Tc | numeric | | | %ms | Accept date milliseconds | |
| | %Td | Td = Tt - (Tq + Tw + Tc + Tr) | numeric | | | | %[accept_date(ms),ms_utime("%3N") | numeric |
| | %Tl | local_date_time | date | +---+------+------------------------------------------------------+---------+
| | %Th | connection handshake time (SSL, PROXY proto) | numeric | | H | %tr | Request date local (with millisecond resolution) | |
| H | %Ti | idle time before the HTTP request | numeric | | | | %[request_date(ms),ms_ltime("%d/%b/%Y:%H:%M:%S.%3N")]| date |
| H | %Tq | Th + Ti + TR | numeric | +---+------+------------------------------------------------------+---------+
| H | %TR | time to receive the full request from 1st byte| numeric | | H | %trg | Request date UTC + timezone | |
| H | %Tr | Tr (response time) | numeric | | | | %[request_date,utime("%d/%b/%Y:%H:%M:%S %z")] | date |
| | %Ts | timestamp | numeric | +---+------+------------------------------------------------------+---------+
| | %Tt | Tt | numeric | | H | %trl | Request date local + timezone | |
| | %Tu | Tu | numeric | | | | %[request_date,ltime("%d/%b/%Y:%H:%M:%S %z")] | date |
| | %Tw | Tw | numeric | +---+------+------------------------------------------------------+---------+
| | %U | bytes_uploaded (from client to server) | numeric | | Timing events |
| | %ac | actconn | numeric | +---+------+------------------------------------------------------+---------+
| | %b | backend_name | string | | H | %Ta | Active time of the request (from TR to end) | |
| | %bc | beconn (backend concurrent connections) | numeric | | | | %[txn.timer.total] | numeric |
| | %bi | backend_source_ip (connecting address) | IP | +---+------+------------------------------------------------------+---------+
| | %bp | backend_source_port (connecting address) | numeric | | | %Tc | Tc | |
| | %bq | backend_queue | numeric | | | | %[bc.timer.connect] | numeric |
| | %ci | client_ip (accepted address) | IP | +---+------+------------------------------------------------------+---------+
| | %cp | client_port (accepted address) | numeric | | | %Td | Td = Tt - (Tq + Tw + Tc + Tr) | |
| | %f | frontend_name | string | | | | %[res.timer.data] | numeric |
| | %fc | feconn (frontend concurrent connections) | numeric | +---+------+------------------------------------------------------+---------+
| | %fi | frontend_ip (accepting address) | IP | | | %Th | connection handshake time (SSL, PROXY proto) | |
| | %fp | frontend_port (accepting address) | numeric | | | | %[fc.timer.handshake] | numeric |
| | %ft | frontend_name_transport ('~' suffix for SSL) | string | +---+------+------------------------------------------------------+---------+
| | %lc | frontend_log_counter | numeric | | H | %Ti | idle time before the HTTP request | |
| | %hr | captured_request_headers default style | string | | | | %[req.timer.idle] | numeric |
| | %hrl | captured_request_headers CLF style | string list | +---+------+------------------------------------------------------+---------+
| | %hs | captured_response_headers default style | string | | H | %Tq | Th + Ti + TR | |
| | %hsl | captured_response_headers CLF style | string list | | | | %[req.timer.tq] | numeric |
| | %ms | accept date milliseconds (left-padded with 0) | numeric | +---+------+------------------------------------------------------+---------+
| | %pid | PID | numeric | | H | %TR | time to receive the full request from 1st byte | |
| H | %r | http_request | string | | | | %[req.timer.hdr] | numeric |
| | %rc | retries | numeric | +---+------+------------------------------------------------------+---------+
| | %rt | request_counter (HTTP req or TCP session) | numeric | | H | %Tr | Tr (response time) | |
| | %s | server_name | string | | | | %[res.timer.hdr] | numeric |
| | %sc | srv_conn (server concurrent connections) | numeric | +---+------+------------------------------------------------------+---------+
| | %si | server_IP (target address) | IP | | | %Tt | Tt | |
| | %sp | server_port (target address) | numeric | | | | %[fc.timer.total] | numeric |
| | %sq | srv_queue | numeric | +---+------+------------------------------------------------------+---------+
| S | %sslc| ssl_ciphers (ex: AES-SHA) | string | | | %Tu | Tu | |
| S | %sslv| ssl_version (ex: TLSv1) | string | | | | %[txn.timer.user] | numeric |
| | %t | date_time (with millisecond resolution) | date | +---+------+------------------------------------------------------+---------+
| H | %tr | date_time of HTTP request | date | | | %Tw | Tw | |
| H | %trg | gmt_date_time of start of HTTP request | date | | | | %[req.timer.queue] | numeric |
| H | %trl | local_date_time of start of HTTP request | date | +---+------+------------------------------------------------------+---------+
| | %ts | termination_state | string | | Others |
| H | %tsc | termination_state with cookie status | string | +---+------+------------------------------------------------------+---------+
+---+------+-----------------------------------------------+-------------+ | | %B | bytes_read (from server to client) | numeric |
+---+------+------------------------------------------------------+---------+
| H | %CC | captured_request_cookie | string |
+---+------+------------------------------------------------------+---------+
| H | %CS | captured_response_cookie | string |
+---+------+------------------------------------------------------+---------+
| | %H | hostname | string |
+---+------+------------------------------------------------------+---------+
| H | %HM | HTTP method (ex: POST) | string |
+---+------+------------------------------------------------------+---------+
| H | %HP | HTTP request URI without query string | string |
+---+------+------------------------------------------------------+---------+
| H | %HPO | HTTP path only (without host nor query string) | string |
+---+------+------------------------------------------------------+---------+
| H | %HQ | HTTP request URI query string (ex: ?bar=baz) | string |
+---+------+------------------------------------------------------+---------+
| H | %HU | HTTP request URI (ex: /foo?bar=baz) | string |
+---+------+------------------------------------------------------+---------+
| H | %HV | HTTP version (ex: HTTP/1.0) | string |
+---+------+------------------------------------------------------+---------+
| | %ID | unique-id | string |
+---+------+------------------------------------------------------+---------+
| | %ST | status_code | numeric |
+---+------+------------------------------------------------------+---------+
| | %U | bytes_uploaded (from client to server) | numeric |
+---+------+------------------------------------------------------+---------+
| | %ac | actconn | |
| | | %[act_conn] | numeric |
+---+------+------------------------------------------------------+---------+
| | %b | backend_name | string |
+---+------+------------------------------------------------------+---------+
| | %bc | beconn (backend concurrent connections) | numeric |
+---+------+------------------------------------------------------+---------+
| | %bi | backend_source_ip (connecting address) | |
| | | %[bc_src] | IP |
+---+------+------------------------------------------------------+---------+
| | %bp | backend_source_port (connecting address) | |
| | | %[bc_src_port] | numeric |
+---+------+------------------------------------------------------+---------+
| | %bq | backend_queue | numeric |
+---+------+------------------------------------------------------+---------+
| | %ci | client_ip (accepted address) | |
| | | %[src] | IP |
+---+------+------------------------------------------------------+---------+
| | %cp | client_port (accepted address) | |
| | | %[src_port] | numeric |
+---+------+------------------------------------------------------+---------+
| | %f | frontend_name | string |
+---+------+------------------------------------------------------+---------+
| | %fc | feconn (frontend concurrent connections) | numeric |
+---+------+------------------------------------------------------+---------+
| | %fi | frontend_ip (accepting address) | |
| | | %[dst] | IP |
+---+------+------------------------------------------------------+---------+
| | %fp | frontend_port (accepting address) | |
| | | %[dst_port] | numeric |
+---+------+------------------------------------------------------+---------+
| | %ft | frontend_name_transport ('~' suffix for SSL) | string |
+---+------+------------------------------------------------------+---------+
| | %lc | frontend_log_counter | numeric |
+---+------+------------------------------------------------------+---------+
| | %hr | captured_request_headers default style | string |
+---+------+------------------------------------------------------+---------+
| | %hrl | captured_request_headers CLF style | string |
| | | | list |
+---+------+------------------------------------------------------+---------+
| | %hs | captured_response_headers default style | string |
+---+------+------------------------------------------------------+---------+
| | %hsl | captured_response_headers CLF style | string |
| | | | list |
+---+------+------------------------------------------------------+---------+
| | %pid | PID | |
| | | %[pid] | numeric |
+---+------+------------------------------------------------------+---------+
| H | %r | http_request | string |
+---+------+------------------------------------------------------+---------+
| | %rc | retries | numeric |
+---+------+------------------------------------------------------+---------+
| | %rt | request_counter (HTTP req or TCP session) | numeric |
+---+------+------------------------------------------------------+---------+
| | %s | server_name | string |
+---+------+------------------------------------------------------+---------+
| | %sc | srv_conn (server concurrent connections) | numeric |
+---+------+------------------------------------------------------+---------+
| | %si | server_IP (target address) | |
| | | %[bc_dst] | IP |
+---+------+------------------------------------------------------+---------+
| | %sp | server_port (target address) | |
| | | %[bc_dst_port] | numeric |
+---+------+------------------------------------------------------+---------+
| | %sq | srv_queue | numeric |
+---+------+------------------------------------------------------+---------+
| S | %sslc| ssl_ciphers (ex: AES-SHA) | |
| | | %[ssl_fc_cipher] | string |
+---+------+------------------------------------------------------+---------+
| S | %sslv| ssl_version (ex: TLSv1) | |
| | | %[ssl_fc_protocol] | string |
+---+------+------------------------------------------------------+---------+
| | %ts | termination_state | string |
+---+------+------------------------------------------------------+---------+
| H | %tsc | termination_state with cookie status | string |
+---+------+------------------------------------------------------+---------+
R = Restrictions : H = mode http only ; S = SSL only R = Restrictions : H = mode http only ; S = SSL only