nginx配置指令之log

1. 日志格式定义

Syntax:	log_format name [escape=default|json|none] string ...;
Default:	log_format combined "...";
Context:	http

Specifies log format.

The escape parameter (1.11.8) allows setting json or default characters escaping in variables, by default, default escaping is used. The none value (1.13.10) disables escaping.

The log format can contain common variables, and variables that exist only at the time of a log write:

$bytes_sent

the number of bytes sent to a client

$connection

connection serial number

$connection_requests

the current number of requests made through a connection (1.1.18)

$msec

time in seconds with a milliseconds resolution at the time of the log write

$pipe

“p” if request was pipelined, “.” otherwise

$request_length

request length (including request line, header, and request body)

$request_time

request processing time in seconds with a milliseconds resolution; time elapsed between the first bytes were read from the client and the log write after the last bytes were sent to the client

$status

response status

$time_iso8601

local time in the ISO 8601 standard format

$time_local

local time in the Common Log Format

 

In the modern nginx versions variables  $status (1.3.2, 1.2.2),  $bytes_sent (1.3.8, 1.2.5),  $connection (1.3.8, 1.2.5),  $connection_requests (1.3.8, 1.2.5),  $msec (1.3.9, 1.2.6),  $request_time (1.3.9, 1.2.6),  $pipe (1.3.12, 1.2.7),  $request_length (1.3.12, 1.2.7),  $time_iso8601 (1.3.12, 1.2.7), and  $time_local (1.3.12, 1.2.7) are also available as common variables.

 

Header lines sent to a client have the prefix “sent_http_”, for example, $sent_http_content_range.

The configuration always includes the predefined “combined” format:

log_format combined '$remote_addr - $remote_user [$time_local] '
                    '"$request" $status $body_bytes_sent '
                    '"$http_referer" "$http_user_agent"';

变量说明：

$remote_addr：client address;

$time_local：local time in the Common Log Format;

$request：full original request line;

$status：response status;

$body_bytes_sent：number of bytes sent to a client, not counting the response header; this variable is compatible with the “%B” parameter of the mod_log_config Apache module;

$http_referer：请求报文首部中referer对应的值；

$http_user_agent：请求报文首部中user-agent对应的值，即客户端代理；

2. 错误日志

Syntax:	error_log file [level];
Default:	error_log logs/error.log error;
Context:	main, http, mail, stream, server, location

Configures logging. Several logs can be specified on the same level (1.5.2). If on the main configuration level writing a log to a file is not explicitly defined, the default file will be used.

The first parameter defines a file that will store the log. The special value stderr selects the standard error file. Logging to syslog can be configured by specifying the “syslog:” prefix. Logging to a cyclic memory buffer can be configured by specifying the “memory:” prefix and buffer size, and is generally used for debugging (1.7.11).

The second parameter determines the level of logging, and can be one of the following: debug, info, notice, warn, error, crit, alert, or emerg. Log levels above are listed in the order of increasing severity. Setting a certain log level will cause all messages of the specified and more severe log levels to be logged. For example, the default level error will cause error, crit, alert, and emerg messages to be logged. If this parameter is omitted then error is used.

3. 访问日志

Syntax:	access_log path [format [buffer=size] [gzip[=level]] [flush=time] [if=condition]]; access_log off;
Default:	access_log logs/access.log combined;
Context:	http, server, location, if in location, limit_except

Sets the path, format, and configuration for a buffered log write. Several logs can be specified on the same level. Logging to syslog can be configured by specifying the “syslog:” prefix in the first parameter. The special value off cancels all access_log directives on the current level. If the format is not specified then the predefined “combined” format is used.

If either the buffer or gzip (1.3.10, 1.2.7) parameter is used, writes to log will be buffered.

The buffer size must not exceed the size of an atomic write to a disk file. For FreeBSD this size is unlimited.

 

When buffering is enabled, the data will be written to the file:

• if the next log line does not fit into the buffer;
• if the buffered data is older than specified by the flush parameter (1.3.10, 1.2.7);
• when a worker process is re-opening log files or is shutting down.

 

If the gzip parameter is used, then the buffered data will be compressed before writing to the file. The compression level can be set between 1 (fastest, less compression) and 9 (slowest, best compression). By default, the buffer size is equal to 64K bytes, and the compression level is set to 1. Since the data is compressed in atomic blocks, the log file can be decompressed or read by “zcat” at any time.

Example:

access_log /path/to/log.gz combined gzip flush=5m;

参考文档：

1. https://nginx.org/en/docs/http/ngx_http_log_module.html 

2. https://nginx.org/en/docs/ngx_core_module.html