Nginx 日志配置详细介绍

1. Nginx 日志介绍

• nginx 有一个非常灵活的日志记录模式，每个级别的配置可以有各自独立的访问日志，所需日志模块 ngx_http_log_module 的支持，日志格式通过 log_format 命令来定义，日志对于统计和排错是非常有利的，下面总结了 nginx 日志相关的配置 包括 access_log、log_format、rewrite_log、error_log。
  • 设置访问日志 access_log path;
  • 关闭访问日志 access_log off;
• path 指定日志的存放位置。
• 作用域：
  • 可以应用access_log指令的作用域分别有http，server，location
  • 也就是说，在这几个作用域外使用该指令，Nginx会报错。

access_log /var/logs/nginx-access.log：表示指定日志的写入路径为/var/logs/nginx-access.log，日志格式使用默认的main。

2. log_format 指令

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

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

注：如果Nginx位于负载均衡器(后端服务器/源站服务器/上游服务器)，nginx反向代理之后，web服务器无法直接获取到客户端真实的IP地址。
$remote_addr获取的是反向代理的IP地址。反向代理服务器在转发请求的http头信息中，可以增加X-Forwarded-For信息，用来记录客户端IP地址。

如果不想使用 Nginx 预定义的格式，可以通过 log_format 指令来自定义。
语法：log_format name [escape=default|json] string ...;
- name 格式名称。在 access_log 指令中引用。
- escape 设置变量中的字符编码方式是json还是default，默认是default。
- string 要定义的日志格式内容。该参数可以有多个。参数中可以使用Nginx变量。

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

变量	含义
$remote_addr, $http_x_forwarded_for	记录客户端IP地址
$remote_user	记录客户端用户名称
$request	记录请求的URL和HTTP协议
$status	记录请求状态
$body_bytes_sent	发送给客户端的字节数，不包括响应头的大小
$bytes_sent	发送给客户端的总字节数
$connection	连接的序列号
$connection_requests	当前通过一个连接获得的请求数量
$msec	日志写入时间。单位为秒，精度是毫秒。
$http_referer	记录从哪个页面链接访问过来的,可以根据该参数进行防盗链设置
$http_user_agent	记录客户端浏览器相关信息
$request_length	请求的长度（包括请求行，请求头和请求正文）
$request_time	请求处理时间，单位为秒，精度毫秒； 从读入客户端的第一个字节开始，直到把最后一个字符发送给客户端后进行日志写入为止。
$time_iso8601ISO8601	标准格式下的本地时间
$time_local	通用日志格式下的本地时间

使用 log_format 指令定义了一个main的格式，并在 access_log 指令中引用了它。客户端发起请求访问：http://192.168.246.154/，看一下请求的日志记录:

10.0.105.207 - - [01/Jul/2019:10:44:36 +0800] "GET / HTTP/1.1" 304 0 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36" "-"

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

3. error_log 指令

错误日志在 Nginx 中是通过 error_log 指令实现的。该指令记录服务器和请求处理过程中的错误信息。
语法（配置错误日志文件的路径和日志级别）：

error_log file [level];
ult：
error_log logs/error.log error;

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

扩展日志级别：
debug级别：低级别，包含的信息非常详细
info级别：稍微的高一点了。用的多一些。
notice 和warning
notice：相当于提示
warning：警告 和warn 一样
err和error 一样。
crit：比较严重了
alert：告警，很严重
emerg：恐慌级别，级别最高的

基本用法：error_log /var/logs/nginx/nginx-error.log

• 配置段： http ， server ， location作用域。
• 例子中指定了错误日志的路径为：/var/logs/nginx/nginx-error.log，日志级别使用默认的 error。

4. rewrite_log 指令

由ngx_http_rewrite_module模块提供的。用来记录重写日志的。对于调试重写规则建议开启，启用时将在error log中记录notice级别的重写日志。
基本语法：

rewrite_log on | off;
默认值: 
rewrite_log off;

配置段：http ， server ， location ， if 作用域。

5. Nginx 日志配置总结

• Nginx中通过access_log和error_log指令配置访问日志和错误日志，通过log_format我们可以自定义日志格式。
• 详细的日志配置信息可以参考Nginx官方文档：http://nginx.org/en/docs/varindex.html
• 单独开启server的访问日志

[root@localhost ~]# cd /etc/nginx/conf.d/
[root@localhost conf.d]# vim nginx.conf
server {
    listen       80;
    server_name  localhost;

    charset koi8-r;
    access_log  /var/log/nginx/test.access.log  main;

    location / {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
    }
    location /admin {
        root /usr/share/nginx/html;
        index index.html index.htm;
        }
}
[root@localhost conf.d]# nginx -s reload

//访问
[root@localhost conf.d]# curl -I http://192.168.1.10

当我们访问的这个server的时候日志将会输出到test.access.log.

6. Nginx 的日志轮转

6.1. 利用 logrotate 做日志轮转

[root@localhost ~]$ rpm -ql nginx |grep log
/etc/logrotate.d/nginx
/var/log/nginx
[root@localhost ~]$ vim /etc/logrotate.d/nginx
/var/log/nginx/*.log {      # 指定需要轮转处理的日志文件
        daily     # 日志文件轮转周期，可用值为: daily/weekly/yearly
        missingok           # 忽略错误信息
        rotate 7            # 轮转次数，即最多存储7个归档日志，会删除最久的归档日志
        minsize 5M          # 限制条件，大于5M的日志文件才进行分割，否则不操作
        dateext             # 以当前日期作为命名格式
        compress            # 轮循结束后，已归档日志使用gzip进行压缩
        delaycompress       # 与compress共用，最近的一次归档不要压缩
        notifempty          # 日志文件为空，轮循不会继续执行
        create 640 nginx nginx     # 新日志文件的权限
        sharedscripts       # 有多个日志需要轮询时，只执行一次脚本
        postrotate    # 将日志文件转储后执行的命令。以endscript结尾，命令需要单独成行
                if [ -f /var/run/nginx.pid ]; then    # 判断nginx的PID。
                # 默认logrotate会以root身份运行
                   kill -USR1 `cat /var/run/nginx.pid`
                   #USR1: 重新打开日志文件
                fi
        endscript
}

执行命令：

[root@localhost ~]# /usr/sbin/logrotate -f /etc/logrotate.conf

创建计划任务：

[root@localhost ~]# crontab -e
59 23 * * * /usr/sbin/logrotate -f /etc/logrotate.conf

6.2. 利用 shell 脚本做日志轮转

[root@localhost ~]# vim /data/shell/nginx-log.sh
#!/bin/bash
s_log="/usr/local/nginx/logs/access.log"
d_log="${s_log}-$(date +%Y%m%d%H%M%S)"
if [ -f "$s_log" ];then
        mv "$s_log" "$d_log"
fi
kill -USR1 `cat /usr/local/nginx/logs/nginx.pid`
cat >>/var/spool/cron/root<<EOF
59 23 * * * /bin/bash /data/shell/nginx-log.sh>/dev/null
EOF