nginx-日志配置

Author Avatar
丁起男 03月 30,2021
  • 在其它设备中阅读本文章

nginx-日志配置

nginx日期对于统计、系统服务排错很有用

nginx日期主要分为两种:

  • access_log(访问日志):用户的ip地址、浏览器的信息,请求的处理时间等信息
  • error_log(错误日志):访问出错的信息,可以帮助我们定位错误的原因

access_log

访问日志主要记录客户端的请求。客户端向nginx服务器发起的每一次请求都记录在这里。客户端ip、浏览器信息、referer、请求处理时间、请求url等都可以在访问日志中得到。当然具体要记录哪些信息,你可以通过log_format指令定义

语法

access_log path [format[buffer=size][gzip[=level]][flush-time][if=condition]];#设置访问日志
access_log off;#关闭访问日志
  • path:指定存放日志的位置
  • format:指定日志的格式。默认使用预定义的combined
  • buffer:用来指定日志写入时的缓存大小。默认是64k
  • gzip:日志写入前先进行压缩。压缩率可以指定,从1-9数值越大压缩比越高,同时压缩的速度也越慢,默认是1
  • flush:设置缓存的有效时间。如果超过flush指定的时间,缓存中的内容将被清空
  • if:条件判断。如果指定的条件计算为0或空字符串,那么该请求不会 写入日志

另外,还有一个特殊的值off。如果指定了该值,当前作用域下的所有的请求日志都被关闭

作用域

可以应用access_log指令的作用域有:http、server、location、limit_except。也就是说,在这几个作用域外使用该指令,nginx会报错

基本用法

access_log /var/logs/nginx-access.log

该例子指定日志的写入路径为 /var/logs/nginx-access.log,日志格式使用默认的combined

access_log /var/logs/nginx-access.log buffer=32k gzip flush=1m

该例子指定日志的写入路径为/var/logs/nginx-access.log,日志格式使用默认的combined,指定日志的缓存大小为32k,日志写入前启用gzip进行压缩,压缩比使用默认值1,缓存数据的有效时间为1分钟

自定义日志格式

nginx预定义了名为combined日志格式,如果没有明确指定日志格式默认使用该格式:

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

如果不想使用nginx预定义的格式,可以通过log_format指令来自定义

语法

log_format name [escape=default|json] string...;
  • name:格式名称。在access_log指令中引用
  • escape:设置变量中的字符编码方式是json还是default,默认是default
  • string:要定义的日志格式内容。该参数可以有多个。参数中可以使用nginx变量

常用变量

变量含义
$bytes_sent发送给客户端的总字节数
$body_bytes_sent发送给客户端的字节数,不包括响应头的大小
$connection连接序列号
$connection_requests当前通过连接发出的请求数量
$msec日志写入时间,单位为2秒,精度是毫秒
$pipe如果请求是通过http流水线发送,则其值为“p”,否则为“.”
$request_length请求长度(包括请求行,请求头和请求体)
$request_time请求处理时长,单位为秒,精度为毫秒,从读入客户端的第一个字节开始,知道把最后一个字符发送到客户端进行日志写入为止
$status响应状态码
$time_iso8601标准格式的本地时间,如“2017-05-24T18:31:27+08:00”
$time_local通用日志格式下的本地时间,如“24/May/2017:18:31:27+0800”
$http_referer请求的referer地址
$http_user_agent客户端浏览器信息
$remote_addr客户端ip
$http_x_forwarded_for当前端有代理服务器时,设置web节点记录客户端地址的配置,此参数生效的前提是代理服务器也要进行相关x_forwarded_for设置
$request完整的原生请求行,如“GET /HTTP/1.1”
$remote_user客户端用户名称,针对启用了用户认证的请求
$request_uri网站的请求地址,如“https://www.baidu.com/”

error_log

错误日志在nginx中通过drror_log指令实现。该指令记录服务器和请求处理过程中的错误信息

语法

error_log file [level];
  • file:日志文件写入的位置
  • level:日志级别。可以是debug、info、notice、warn、error、crit、alert、emerg中的任意值。可以看到其取值范围是按紧急程度从低到高排列的。只有日志的错误级别等于或高于level指定的值才会写入到错误日志中。默认值是error

作用域

error_log可以配置在:main、http、mail、stream、server、location作用域中

基本用法

error_log /var/logs/nginx/nginx-error.log

例子中指定了错误日志的路径为/var/logs/nginx/nginx-error.log,日志级别使用默认的error

open_log_file_cache

每一条日志记录的写入都是先打开文件再写入记录,然后关闭日志文件。如果拿到日志文件路径中使用了变量,如果access_log /var/logs/$host/nginx-access.log,为了提高性能,可以使用open_log_file_cache指令设置日志文件标识符的缓存

语法

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:不使用缓存,默认为off

作用域

open_log_file_cache可以配置在http、server、location作用域中

基本用法

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

例子中,设置缓存最多缓存1000个日志文件描述符,20s内如果缓存中的日志文件描述符至少被访问2次,才不会被缓存关闭。每隔1分钟检查缓存中的文件描述符的文件名是否还存在