十四 nginx 日志配置

1 nginx 日志介绍

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

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

作用域：

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

2 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               #发送给客户端的总字节数
$http_referer            #记录从哪个页面链接访问过来的,可以根据该参数进行防盗链设置
$http_user_agent      #记录客户端浏览器相关信息
$time_local               #通用日志格式下的本地时间。

​ 自定义日志格式的使用：

access_log /var/logs/nginx-access.log mainlog_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://qf.com/，我们看一下我截取的一个请求的日志记录:

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地址一定要在第一列。

3 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。

基本用法

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

​ 配置段：main， http, mail, stream, server, location作用域。

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

4 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];默认值: 
open_log_file_cache off;

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

5 log_not_found 指令

​ 是否在error_log中记录不存在的错误（404）。默认是。

基本语法:

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

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

6 log_subrequest 指令 # 衍生关系

​ 是否在access_log中记录子请求的访问日志。默认不记录

基本语法

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

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

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我们可以自定义日志格式。如果日志文件路径中使用了变量，我们可以通过open_log_file_cache 指令来设置缓存，提升性能。其他的根据自己的使用场景定义。

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