【NGINX入门】13.Nginx日志详解

1. 摘要

本文讲解Nginx日志的详细信息，包括类别，语法，配合等。

2. nginx日志介绍

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

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

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

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

另外，在access_log和log_format中使用了很多变量，详细的变量信息可以参考Nginx官方文档。

3. 访问日志配置

1、设置访问日志的语法

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或空字符串，那么该请求不会写入日志。

2、访问日志的作用域

可以应用access_log指令的作用域分别有http，server，location，limit_except。也就是说，在这几个作用域外使用该指令，Nginx会报错。

3、访问日志使用实例

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

4. 使用log_format自定义日志格式

1、nginx默认日志格式

Nginx预定义了名为combined日志格式，如果没有明确指定日志格式默认使用该格式：

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

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

2、Nginx自定义日志语法及常用变量

log_format name [escape=default|json] string ...;

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

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

3、自定义日志格式的使用

access_log /var/logs/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指令中引用了它。假如客户端有发起请求：https://suyunfe.com/，我们看一下我截取的一个请求的日志记录:

112.195.209.90 - - [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" "-"

我们看到最终的日志记录中

http_referer、$http_x_forwarded_for都对应了一个”-“，这是因为这几个变量为空。

5、错误日志配置error_log

1、设置错误日志的语法

错误日志主要记录客户端访问Nginx出错时的日志，格式不支持自定义。通过错误日志，你可以得到系统某个服务或server的性能瓶颈等。因此，将日志好好利用，你可以得到很多有价值的信息。错误日志由指令error_log来指定，具体格式如下：

error_log path(存放路径) level(日志等级)

path含义同access_log，level表示日志等级，日志等级分为[ debug | info | notice | warn | error | crit ]，从左至右，日志详细程度逐级递减，即debug最详细，crit最少。

举例说明如下：

error_log logs/error.log info;

需要注意的是：error_log off并不能关闭错误日志，而是会将错误日志记录到一个文件名为off的文件中。正确的关闭错误日志记录功能的方法如下：

error_log /dev/null; 表示将存储日志的路径设置为“垃圾桶”。

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

2、nginx日志设置的基本用法

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

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

例子中指定了错误日志的路径为：/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];

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分钟检查缓存中的文件描述符的文件名是否还存在。

6、Nginx日志分割

1、编写nginx日志分割脚本

[root@localhost ~]# vim /usr/local/nginx/logs/NginxLogRotate.sh

#!/bin/bash 

LOGS_PATH=/usr/local/nginx/logs 

YESTERDAY=$(date -d "yesterday" +%Y-%m-%d) 

cp ${LOGS_PATH}/access.log ${LOGS_PATH}/access_${YESTERDAY}.log && >${LOGS_PATH}/access.log

cp ${LOGS_PATH}/error.log ${LOGS_PATH}/error_${YESTERDAY}.log && >${LOGS_PATH}/error.log

2、设置定时任务运行脚本

[root@localhost ~]# crontab -e

0 0 * * *  /usr/local/nginx/logs/NginxLogRotate.sh

定时任务每天00:00执行脚本/usr/local/nginx/logs/NginxLogRotate.sh，实现定时自动分割Nginx日志（包括访问日志和错误日志），这样Nginx每天都会生成一个新的日志文件。

7. 参考

（1）nginx日志详解 https://blog.51cto.com/longlei/2132170 （2）Nginx教程(三) Nginx日志管理 https://www.cnblogs.com/crazylqy/p/6891991.html