nginx 日志配置

一时失言乱红尘 2022-12-17 01:22 146阅读 0赞

### **1、nginx 日志介绍** ###

`nginx` 有一个非常灵活的日志记录模式,每个级别的配置可以有各自独立的访问日志, 所需日志模块 `ngx_http_log_module` 的支持，日志格式通过 `log_format` 命令来定义，日志对于统计和排错是非常有利的，下面总结了 `nginx` 日志相关的配置 包括 `access_log`、`log_format`、`rewrite_log`、`error_log`。

# 设置访问日志
    access_log path [format [buffer=size] [gzip[=level]] [flush=time];
    # 关闭访问日志
    access_log off;

*  **path** 指定日志的存放位置。
 *  **format** 指定日志的格式。默认使用预定义的`combined`。
 *  **buffer** 用来指定日志写入时的缓存大小。默认是64k。
 *  **gzip** 日志写入前先进行压缩。压缩率可以指定，从1到9数值越大压缩比越高，同时压缩的速度也越慢。默认是1。
 *  **flush** 设置缓存的有效时间。如果超过flush指定的时间，缓存中的内容将被清空。

**作用域：**

可以应用`access_log`指令的作用域分别有`http`，`server`，`location`，也就是说，在这几个作用域外使用该指令，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分钟。

### **3、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, $http_x_forwarded_for   #记录客户端IP地址
    $remote_user                    #记录客户端用户名称
    $request                   #记录请求的URL和HTTP协议
    $status                     #记录请求状态
    $body_bytes_sent      #发送给客户端的字节数，不包括响应头的大小
    $bytes_sent               #发送给客户端的总字节数
    $connection               #连接的序列号
    $connection_requests  #当前通过一个连接获得的请求数量。
    $msec                      #日志写入时间。单位为秒，精度是毫秒。
    $pipe                       #如果请求是通过HTTP流水线(pipelined)发送，pipe值为“p”，否则为“.”。
    $http_referer            #记录从哪个页面链接访问过来的,可以根据该参数进行防盗链设置
    $http_user_agent      #记录客户端浏览器相关信息
    $request_length        #请求的长度（包括请求行，请求头和请求正文）。
    $request_time           #请求处理时间，单位为秒，精度毫秒； 从读入客户端的第一个字节开始，直到把最后一个字符发送给客户端后进行日志写入为止。
    $time_iso8601           #ISO8601标准格式下的本地时间。
    $time_local               #通用日志格式下的本地时间。

自定义日志格式的使用：

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"';
    注意:
    注：如果Nginx位于负载均衡器，nginx反向代理之后，web服务器无法直接获取到客户端真实的IP地址。
    $remote_addr获取的是反向代理的IP地址。反向代理服务器在转发请求的http头信息中，可以增加X-Forwarded-For信息，用来记录客户端IP地址。

使用`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`都对应了一个`-`，这是因为这几个变量为空。

**面试时：注意日志里面的ip地址一定要在第一列。**

### **5、error\_log 指令** ###

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

**语法**

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

error_log file [level];
    Default:    
    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`。

### **7、rewrite\_log 指令** ###

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

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

配置段: `http`, `server`, `location`, `if`作用域。

### **8、nginx 日志配置总结** ###

Nginx中通过`access_log`和`error_log`指令配置访问日志和错误日志，通过`log_format`我们可以自定义日志格式。

详细的日志配置信息可以参考[Nginx官方文档][Nginx]

9、单独开启server的访问日志

[root@nginx-client ~]# cd /etc/nginx/conf.d/
    [root@nginx-client 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@nginx-client conf.d]# nginx -s reload
    访问
    [root@nginx-client conf.d]# curl -I http://192.168.1.10

![a9a1f16e56954cc6968ef0c7018b4948.png][]

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

![3037d99b3aa1575efc917714e5ab699a.png][]

**9、nginx的日志轮转**

[root@192 ~]# rpm -ql nginx |grep log
    /etc/logrotate.d/nginx
    /var/log/nginx
    [root@192 ~]# 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
                    fi
            endscript
    }
    
    执行命令:
    [root@192 nginx]# /usr/sbin/logrotate -f /etc/logrotate.conf
    创建计划任务:
    [root@192 nginx]# crontab -e
    59 23 * * * /usr/sbin/logrotate -f /etc/logrotate.conf

作业:编写一个nginx的切割脚本。

[Nginx]: https://link.zhihu.com/?target=https%3A//link.juejin.im/%3Ftarget%3Dhttp%253A%252F%252Fnginx.org%252Fen%252Fdocs%252Fvarindex.html
[a9a1f16e56954cc6968ef0c7018b4948.png]: /images/20221123/d9f0632dfacc4314ba95c16bacae8149.png
[3037d99b3aa1575efc917714e5ab699a.png]: /images/20221123/4d13fc1292174694af52946a1209116b.png