模块 ngx_stream_log_module

ngx_stream_log_module 模块 (1.11.4) 以指定的格式写入会话日志。

log_format basic '$remote_addr [$time_local] '
                 '$protocol $status $bytes_sent $bytes_received '
                 '$session_time';

access_log /spool/logs/nginx-access.log basic buffer=32k;

access_log off;

设置缓冲日志写入的路径、格式和配置。可以在同一配置级别上指定多个日志。可以通过在第一个参数中指定“syslog:”前缀来配置写入 syslog。特殊值 off 会取消当前级别上的所有 access_log 指令。

如果使用 buffer 或 gzip 参数，则日志写入将被缓冲。

缓冲区大小不得超过磁盘文件原子写入的大小。对于 FreeBSD，此大小不受限制。

启用缓冲后，数据将写入文件

• 如果下一条日志行无法放入缓冲区；
• 如果缓冲数据比 flush 参数指定的时间更旧；
• 当工作进程正在 重新打开 日志文件或正在关闭时。

如果使用 gzip 参数，则在写入文件之前，缓冲数据将被压缩。压缩级别可以在 1（最快，压缩率最低）到 9（最慢，压缩率最高）之间设置。默认情况下，缓冲区大小等于 64K 字节，压缩级别设置为 1。由于数据以原子块压缩，因此日志文件可以随时被解压缩或由“zcat”读取。

示例

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

要使 gzip 压缩生效，必须使用 zlib 库构建 nginx。

文件路径可以包含变量，但此类日志有一些限制

• 工作进程使用的凭据对应的 用户 应该有权限在包含此类日志的目录中创建文件；
• 缓冲写入无效；
• 每个日志写入都会打开和关闭文件。但是，由于常用文件的描述符可以存储在 缓存 中，因此在 open_log_file_cache 指令的 valid 参数指定的时间内，可以继续写入旧文件。

if 参数启用条件日志记录。如果 条件 计算结果为“0”或空字符串，则不会记录会话。

指定日志格式，例如

log_format proxy '$remote_addr [$time_local] '
                 '$protocol $status $bytes_sent $bytes_received '
                 '$session_time "$upstream_addr" '
                 '"$upstream_bytes_sent" "$upstream_bytes_received" "$upstream_connect_time"';

escape 参数 (1.11.8) 允许设置变量中 json 或 default 字符的转义，默认情况下，使用 default 转义。none 参数 (1.13.10) 禁用转义。

对于 default 转义，字符“"”、“\”以及其他值小于 32 或大于 126 的字符将转义为“\xXX”。如果找不到变量值，则会记录连字符（“-”）。

对于 json 转义，所有在 JSON 字符串 中不允许的字符都将被转义：字符“"”和“\”分别转义为“\"”和“\\”，值小于 32 的字符转义为“\n”、“\r”、“\t”、“\b”、“\f”或“\u00XX”。

open_log_file_cache off;

定义一个缓存，用于存储名称包含变量的常用日志的文件描述符。该指令具有以下参数

max

设置缓存中描述符的最大数量；如果缓存已满，则关闭最近最少使用 (LRU) 的描述符。

inactive

设置在该时间段内没有访问的情况下，缓存的描述符关闭之前的时间；默认为 10 秒。

min_uses

设置在 inactive 参数定义的时间内，文件使用的最少次数，以使描述符保持在缓存中打开状态；默认为 1。

valid

设置应检查文件是否仍以相同名称存在的时间；默认为 60 秒。

off

禁用缓存。

使用示例

open_log_file_cache max=1000 inactive=20s valid=1m min_uses=2;