nginx配置系列(三)日志配置(ngx_http_log_module)

ngx_http_log_module 模块

ngx_http_log_module模块按指定的格式记录访问日志。请求在处理结束时,会按请求路径的配置上下文记访问日志,通过访问日志,你可以得到用户地域来源、跳转来源、使用终端、某个URL访问量等相关信息。你也可以记录错误日志,通过错误日志,你可以得到系统某个服务或server的性能瓶颈等。


配置 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 指令的基本语法和参数的含义。下面我们看一几个例子加深一下理解。

基本用法

access_log /home/wwwlogs/nginx-access.log

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


access_log /home/wwwlogs/nginx-access.log buffer=32k gzip flush=1m

该例子指定日志的写入路径为/home/wwwlogs/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 name [escape=default|json] string ...;
  • name 格式的名称。在 access_log 指令中引用。

  • escape 设置变量中的字符编码方式是json还是default,默认是default。

  • string 要定义的日志格式内容。该参数可以有多个。参数中可以使用Nginx变量。


下面是 log_format 指令中常用的一些变量:


$remote_addr    客户端的IP地址(代理服务器,显示代理服务器的ip)

$remote_user    记录远程客户端的用户名称,针对启用了用户认证的请求,通常情况下为“-”

$time_local    记录访问时间和时区,如"24/May/2017:18:31:27 +0800"

$request    记录请求的url以及请求方法

$status    响应状态码 例如:200成功、404页面找不到等......

$bytes_sent    发送给客户端的总字节数

$body_bytes_sent    给客户端发送的主体内容字节数,不包括响应头的大小

$http_user_agent    客户端浏览器信息

$http_x_forwarded_for    可以记录客户端IP,通过代理服务器来记录客户端的IP地址。当前端有代理服务器时,设置web节点记录客户端地址的配置,此参数生效的前提是代理服务器也要进行相关的x_forwarded_for设置。

$http_referer    记录用户是从哪个链接访问过来的

$time_iso8601    标准格式的本地时间,形如“2017-05-24T18:31:27+08:00”

$msec    日志写入时间,单位为秒,精度是毫秒

$request_length    请求长度(包括请求行,请求头和请求体)

$request_time    请求处理时长,单位为秒,精度为毫秒,从读入客户端的第一个字节开始,直到把最后一个字符发送给客户端进行日志写入为止


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

access_log /home/wwwlogs/nginx-access.log main
log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                  '$status $body_bytes_sent "$http_referer" '
                  '"$http_user_agent" "$http_x_forwarded_for"';

使用 log_format 指令定义了一个main的格式,并在access_log指令中引用了它。假如客户端有发起请求:

nginx.css3er.com,注意,如果你要测试的话,请把nginx.css3er.com换成对应你自己的域名进行访问。看一下我截取的一个请求的日志记录:

111.231.138.248 - - [20/Feb/2018:12:12:14 +0800] "GET / HTTP/1.1" 200 190 "-" "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Mobile Safari/537.36" "-"

我们看到最终的日志记录中$remote_user、$http_referer、$http_x_forwarded_for都对应了一个-,这是因为这几个变量为空。


配置 error_log 来记录错误日志

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

语法

配置错误日志文件的路径和日志级别。

error_log file [level];
Default:    
error_log logs/error.log error;

第一个参数指定日志的写入路径。


第二个参数指定日志的级别。level可以是debug, info, notice, warn, error, crit, alert,emerg 中的任意值。可以看到其取值范围是按紧急程度从低到高排列的。只有日志的错误级别等于或高于level指定的值才会写入错误日志中。默认值是error。

基本用法

error_log /home/wwwlogs/nginx-error.log crit;

它可以配置在:main, http, mail, stream, server, location 作用域。


例子中指定了错误日志的路径为:/home/wwwlogs/nginx-error.log,日志级别使用的是crit。


open_log_file_cache

每一条日志记录的写入都是先打开文件再写入记录,然后关闭日志文件。如果你的日志文件路径中使用了变量,如 access_log /home/wwwlogs/$host/nginx-access.log,为了提高性能,可以使用 open_log_file_cache 指令设置日志文件描述符的缓存。当然了,即使你在路径中使用了变量,你也可以选择不用配置 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;


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

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


尾声

在Nginx中我们可以通过 access_log 和 error_log 指令配置访问日志和错误日志,通过 log_format 我们可以自定义日志格式。如果日志文件路径中使用了变量,我们可以通过open_log_file_cache指令来设置缓存,提升性能。


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



声明:禁止任何非法用途使用,凡因违规使用而引起的任何法律纠纷,本站概不负责。

扫码支持
扫码打赏,你说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

精彩评论

全部回复12人评论7,777人参与