Nginx日志配置

Nginx日志配置

前言

Nginx日志对于统计、系统服务排错很有用。

​ Nginx日志主要分为两种：access_log(访问日志)和error_log(错误日志)。通过访问日志我们可以得到用户的IP地址、浏览器的信息，请求的处理时间等信息。错误日志记录了访问出错的信息，可以帮助我们定位错误的原因。

access_log

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

语法

1
2

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

基本用法

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

1

access_log /var/logs/nginx-access.log

该例子指定日志的写入路径为/var/logs/nginx-access.log，日志格式使用默认的combined，指定日志的缓存大小为32k，日志写入前启用gzip进行压缩，压缩比使用默认值1，缓存数据有效时间为1分钟。

1

access_log /var/logs/nginx-access.log buffer=32k gzip flush=1m

自定义日志格式

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

1
2
3

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

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

语法

1

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

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

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

示例

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

1
2
3
4

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/，我们看一下我截取的一个请求的日志记录:

1
2
3

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

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

error_log

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

语法

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

1
2
3

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

• 第一个参数指定日志的写入位置。

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

基本用法

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

1

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

例子中指定了错误日志的路径为：/var/logs/nginx/nginx-error.log，日志级别使用默认的error。

open_log_file_cache

​ 每一条日志记录的写入都是先打开文件再写入记录，然后关闭日志文件。如果你的日志文件路径中使用了变量，如access_log /var/logs/$host/nginx-access.log，为提高性能，可以使用open_log_file_cache指令设置日志文件描述符的缓存。

语法

1

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。

基本用法

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

1

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

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

总结

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

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

http://nginx.org/en/docs/varindex.html

日志切割

​ 我们知道，nginx会将访问日志写入到access.log日志文件中，天长日久，access.log文件就会越来越大，如果访问量巨大，并不用多长时间，access.log文件的体积就会变得非常大，对于我们的管理工作来说，这是不利的，首先，当我们打开一个非常大的日志文件时，就会比较慢，而且，从一个非常大的日志中找到某个时间段的日志也会比较慢，所以，我们最好将日志按天分割开（或者按照你觉得合适的时间段分隔开），比如，每天晚上0点5分生成一个新的日志文件，0点5分之后（新的一天）的日志写入到新的日志文件中，之前的日志则保留在老的文件中，这样每天就会生成一个日志文件，而不是将所有日志都写入到同一个日志文件中。

步骤

重命名日志文件

​ 不用担心重命名后nginx找不到日志文件而丢失日志。在你未 重新打开原名字的日志文件前，nginx还是会向你重命名的文件写日志，Linux是靠文件描述 符而不是文件名定位文件

向nginx主进程发送USR1信号

​ nginx主进程接到信号后会从配置文件中读取日志文件名称
​ 重新打开日志文件 (以配置文件中的日志名称命名) ，并以工作进程的用户作为日志文件 的所有者 重新打开日志文件后，nginx主进程会关闭重名的日志文件并通知工作进程使用新打开 的日志文件
​ 工作进程立刻打开新的日志文件并关闭重名名的日志文件 然后你就可以处理旧的日志文件了。[或者重启nginx服务]

编写脚本

nginx日志按每分钟自动切割脚本如下 :

新建shell脚本

1

vi   /opt/nginx/nginx_log.sh

1
2
3
4
5
6
7
8
9
10

#!/bin/bash
#设置日志文件存放目录
#LOG_HOME="/home/wwwlogs/"
 LOG_HOME="/usr/local/nginx/logs"
#备分文件名称
LOG_PATH_BAK="$(date -d yesterday +%Y%m%d%H%M)".access.log
#重命名日志文件
mv ${LOG_HOME}/access.log ${LOG_HOME}/${LOG_PATH_BAK}
#向nginx主进程发信号重新打开日志
kill -USR1 `cat /usr/local/nginx/logs/nginx.pid`

创建定时任务

创建crontab设置作业

设置日志文件存放目录crontab -e

1

*/1 * * * *  sh /opt/nginx/nginx_log.sh

自动删除日志

7天前的指定日志文件

1
2
3
4
5
6
7
8
9

# touch auto-del-7-day-ago-log.sh
# chmod +x auto-del-7-day-ago-log.sh
# vim auto-del-7-day-ago-log.sh
  find /www/cookie.com/log.cookie.com/ -mtime +7 -name "push*.log" -exec rm -rf {} \;
 
#每天凌晨0点10分执行
# crontab -e 
 10 0 * * * /opt/sh/auto-del-7-day-ago-log.sh > /dev/null 2>&1

超过90天的日志文件 删除

1

00 03 * * * find /home/connect/nginx/logs/ -type f -mtime +90 -delete

定时任务表达式

corn从左到右（用空格隔开）：秒 分 小时 月份中的日期 月份 星期中的日期 年份

常用字符含义

常用表达式例子