nginx的日志配置


1. nginx中日志的种类

nginx中可以记录的日志主要有access日志、error日志和rewrite日志。前两种由ngx_http_log_module模块予以支持,rewrite日志则由ngx_http_rewrite_module模块提供,这两个模块默认都已包含且启用。

2.nginx中日志的作用

  • access日志
    记录nginx处理的请求的过程,包含请求类型、时间、客户端信息、处理结果、处理时长等信息,具体可以通过log_format指令引用特定变量来记录相关信息。

  • error日志
    记录nginx进程启动、停止、重启及处理请求过程中发生的错误信息。

  • rewrite日志
    记录rewrite规则工作的过程,可以用于调试rewrite规则。

3. nginx中日志的配置

  • access日志
    默认情况下就会自动记录access日志,默认存放路径为/usr/local/nginx/logs/access.log
    配置层级:http、server、location、if in location、limit_except。
    配置指令:
    access_log path [format [buffer=size [flush=time]]];
    access_log path format gzip[=level] [buffer=size] [flush=time];
    access_log syslog:server=address[,parameter=value] [format];
    access_log off;
    配置指令说明:

  • path 用于指定access日志存放的路径,需要确保nginx worker process运行的身份对此路径有写权限。

  • format 实际是引用的log_format指令定义好的日志格式模板名称。

  • buffer 用来设置内存中用于存放缓存日志的缓存大小。

  • gzip 表示日志在写入磁盘中时调用gzip进行压缩,level用于指定压缩级别,压缩后的日志文件可以用zcat查看其内容。

  • flush 设置日志保存在缓存中的最长时间。

  • syslog 用于将access日志写入syslog日志中,server用于指定syslog server的地址。如access_log syslog:server=127.0.0.1,facility=local7,tag=nginx,severity=info;

  • off 表示关闭access日志,不记录任何access信息。

  • access日志的格式
    nginx提供了log_format指令用于自定义access日志的格式,它统一在http层级进行配置。
    配置指令:
    log_format name string ...;
    默认值:log_format combined ...;
    默认情况下,只要不明确指定access_log off;,nginx就会使用默认的combined格式记录access日志。
    配置指令说明:
    name 用户自定义的日志格式模板名称。
    string 可以调用很多变量来表示记录哪些字段到日志中。
    默认的combined格式如下:

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

**log_format可使用的变量: **

变量名 含义
$remote_addr 记录客户端IP地址
$http_x_forwarded_for 当nginx处于负载均衡器,squid,反向代理之后时,需要这个字段才能记录用户的实际IP地址
$remote_user 记录客户端用户名称,针对启用了用户认证的请求进行记录
$request 记录用户请求的URL
$status 记录请求结果状态码
$body_bytes_sent 发送给客户端的字节数,不包括响应头的大小
$bytes_sent 发送给客户端的总字节数
$connection 连接的序列号
$msec 日志写入时间,单位为秒,精度是毫秒
$pipe 如果请求是通过http流水线发送,则其值为"p",否则为“."
$http_referer 记录从哪个页面链接过来的
$http_user_agent 记录客户端浏览器相关信息
$request_length 请求的长度(包括请求行,请求头和主体)
$request_time 请求处理时长,单位为秒,精度为毫秒,从读入客户端的第一个字节开始,直到把最后一个字符发送张客户端进行日志写入为止
$time_iso8601 标准格式下的本地时间,形如“2017-05-24T18:31:27+08:00”
$time_local 通过日志格式下的本地时间,形如“24/May/2017:18:31:27 +0800”
  • open_log_file_cache指令
    对于每一条日志 记录都是需要先打开文件再写入日志,然后关闭,可以使用open_log_file_cache来设置日志文件缓存(默认是off)。它可以配置在http、server、location层级之中。
    配置语法:
    open_log_file_cache max=N [inactive=time] [min_uses=N] [valid=time];
    默认值: open_log_file_cache off;
    参数解释:
    max:设置缓存中最大文件描述符数量,如果被占满,采用LRU算法将描述符关闭。
    inactive:设置缓存存活时间,默认是10s。
    min_uses:设置在inactive时间段内,日志文件最少使用多少次后,该日志文件描述符记入缓存中,默认是1次。
    valid:设置检查频率,默认是60s。
    off:禁用缓存。
    示例:
    open_log_file_cache max=1000 inactive=20s valid=1m min_uses=2;

  • log_not_found指令
    这一指令的作用是配置是否将not found错误记录到error_log中。默认值on,即记录至error_log中。可以在http、server、location层级配置。
    配置 指令: log_not_found on|off;

  • log_subrequest指令
    这一指令配置是否在access_log中记录子请求的访问日志 ,默认为不记录。同样也是在http、server、location层级配置 。
    配置语法: log_subrequest on|off;

  • rewrite_log指令
    这一指令是用来记录重写日志的,默认关闭,启用以后会将重写日志记录到error_log中,也是配置在http、server、location层级中。
    配置语法: rewrite_log on|off;

  • error_log指令
    这一指令用于指定记录的错误日志级别,它可以配置在main、http、server、location层级之中。
    配置语法:
    error_log file|stderr|syslog:server=address[,parameter=value] [debug|info|notice|warn|error|crit|alert|emerg];
    默认值:error_log logs/error.log error;

推荐阅读更多精彩内容