明月登楼

Nginx的log日志配置
Nginx日志对于统计、系统服务排错很有用。Nginx日志主要分为两种:access_log(访问日志)和erro...
扫描右侧二维码阅读全文
02
2019/02

Nginx的log日志配置

Nginx日志对于统计、系统服务排错很有用。Nginx日志主要分为两种:access_log(访问日志)和error_log(错误日志)。通过访问日志我们可以得到用户的IP地址、浏览器的信息,请求的处理时间等信息。错误日志记录了访问出错的信息,可以帮助我们定位错误的原因。本文将详细描述一下如何配置Nginx日志。

4a1db5fffd2f35ca54363a44bff707ca.jpg

设置access_log

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

access_log设置语法

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指令的作用域分别有httpserverlocationlimit_except。也就是说,在这几个作用域外使用该指令,Nginx会报错。

以上是access_log指令的基本语法和参数的含义。下面我们看一几个例子加深一下理解。

基本用法

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分钟。

使用log_format自定义日志格式

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指令中常用的一些变量:

变量含义
$bytes_sent发送给客户端的总字节数
$body_bytes_sent发送给客户端的字节数,不包括响应头的大小
$connection连接序列号
$connection_requests当前通过连接发出的请求数量
$msec日志写入时间,单位为秒,精度是毫秒
$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.imydl.com"
$brotli_ratioBrotli压缩算法模块压缩比

在access_log和log_format中使用了很多变量,这些变量没有一一列举出来,详细的变量信息可以参考『Nginx官方文档

下面演示一下自定义日志格式的使用:

access_log /var/logs/nginx-access.log main;

log_format  main  '$clientRealIP - $remote_user [$time_local] "$request" '
                  '$status $body_bytes_sent "$http_referer" '
                  '[$brotli_ratio] '
                  '"$http_user_agent"';

我们使用log_format指令定义了一个main的格式,并在access_log指令中引用了它。假如客户端有发起请求:https://www.imydl.com,我们看一下我截取的一个请求的日志记录:

203.208.60.116 - - [02/Feb/2019:01:21:55 +0800] "GET /sszp/6553.html HTTP/1.1" 200 21746 "-" [5.20] "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.96 Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"

我们看到最终的日志记录中$brotli_ratio对应了一个[4.95],这就说明被Brotli模块压缩了,压缩比达到了4.95。

设置日志文件描述符的缓存

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];

max 设置缓存中最多容纳的文件描述符数量,如果被占满,采用LRU算法将描述符关闭。
inactive 设置缓存存活时间,默认是10s。
min_uses 在inactive时间段内,日志文件最少使用几次,该日志文件描述符记入缓存,默认是1次。
valid:设置多久对日志文件名进行检查,看是否发生变化,默认是60s。
off:不使用缓存。默认为off。

基本用法

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

它可以配置在httpserverlocation作用域中。

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

最后修改:2019 年 02 月 02 日 01 : 35 AM
如果觉得我的文章对你有用,请随意赞赏

6 条评论

  1. wordpress建站吧

    额。一大堆看不懂的日志

    1. 明月登楼
      @wordpress建站吧

      哈哈,其实很简单看日志格式配置变量就明白了!

  2. 镜缘轩

    以前很少看这个日志,以后要多看看了

    1. 明月登楼
      @镜缘轩

      嗯,用处很大的其实!

  3. 响石潭

    学习,新春快乐

    1. 明月登楼
      @响石潭

      谢谢支持,新年快乐!

发表评论