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

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

语法

access_log指令用来指定日志文件的存放路径（包含日志文件名）、格式和缓存大小，具体如下：

  1. access_log path [format [buffer=size] [gzip[=level]] [flush=time] [if=condition]]; # 设置访问日志  
  2. access_log off; # 关闭访问日志
  1. access_log path(存放路径) [format(自定义日志格式名称) [buffer=size] [gzip[=level]] [flush=time] [if=condition] ]
  • path 指定日志的存放位置。
  • format 指定日志的格式。默认使用预定义的combined。
  • buffer 用来指定日志写入时的缓存大小。默认是64k。
  • gzip 日志写入前先进行压缩。压缩率可以指定，从1到9数值越大压缩比越高，同时压缩的速度也越慢。默认是1。
  • flush 设置缓存的有效时间。如果超过flush指定的时间，缓存中的内容将被清空。
  • if 条件判断。如果指定的条件计算为0或空字符串，那么该请求不会写入日志。

另外，还有一个特殊的值off。如果指定了该值，当前作用域下的所有的请求日志都被关闭。

作用域

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

以上是access_log指令的基本语法和参数的含义。下面看几个例子加深一下理解。

基本用法

  1. #设置访问日志
  2. #指定日志的写入路径为/var/logs/nginx-access.log，日志格式使用默认的combined。
  3. access_log /var/logs/nginx-access.log
  4. access_log logs/access.log main;
  5. #指定日志的写入路径为/var/logs/nginx-access.log，日志格式使用默认的combined，指定日志的缓存大小为32k，日志写入前启用gzip进行压缩，压缩比使用默认值1，缓存数据有效时间为1分钟。
  6. access_log /var/logs/nginx-access.log buffer=32k gzip flush=1m
  7. #关闭日志
  8. access_log off;
  9. #能够使用access_log指令的字段包括：http、server、location、limit_except。

使用log_format自定义日志格式

log_format用来设置日志格式，也就是日志文件中每条日志的格式，具体如下：

  1. log_format name(格式名称) type(格式样式)

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

  1. log_format combined '$remote_addr - $remote_user [$time_local] '  
  2.                     '"$request" $status $body_bytes_sent '  
  3.                     '"$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指令中常用的一些变量：

变量 含义
$server_name 虚拟主机名称
$remote_addr 客户端IP，远程客户端的IP地址
$remote_user 客户端用户名称，针对启用了用户认证的请求，远程客户端用户名称，用于记录浏览者进行身份验证时提供的名字，如登录百度的用户名scq2099yt，如果没有登录就是空白
$time_local 访问的时间与时区，通用日志格式下的本地时间，如”24/May/2017:18:31:27 +0800”，时间信息最后的”+0800”表示服务器所处时区位于UTC之后的8小时
$time_iso8601 标准格式的本地时间，形如“2017-05-24T18:31:27+08:00”
$request 请求的URI和HTTP协议，这是整个PV日志记录中最有用的信息，记录服务器收到一个什么样的请求，完整的原始请求行，如 “GET / HTTP/1.1”
$request_uri 完整的请求地址，如 “https://daojia.com/“
$status 记录请求返回的http状态码，比如成功是200
$uptream_status upstream状态，比如成功是200
$upstream_response_time 请求过程中，upstream的响应时间
$upstream_addr upstream的地址，即真正提供服务的主机地址
$body_bytes_sent 发送给客户端的主体内容的大小，不包括响应头的大小，比如899，可以将日志每条记录中的这个值累加起来以粗略估计服务器吞吐量
$bytes_sent 发送给客户端的总字节数
$http_referer 请求的referer地址，记录从哪个页面链接访问过来的
$http_user_agent 客户端浏览器信息
$http_x_forwarded_for 当前端有代理服务器时，设置web节点记录客户端地址的配置，此参数生效的前提是代理服务器也要进行相关的x_forwarded_for设置。客户端的真实ip，通常web服务器放在反向代理的后面，这样就不能获取到客户的IP地址了，通过$remote_add拿到的IP地址是反向代理服务器的iP地址。反向代理服务器在转发请求的http头信息中，可以增加x_forwarded_for信息，用以记录原有客户端的IP地址和原来客户端的请求的服务器地址。
$ssl_protocol SSL协议版本，比如TLSv1
$ssl_cipher 交换数据中的算法，比如RC4-SHA
$connection 连接序列号
$connection_requests 当前通过连接发出的请求数量
$msec 日志写入时间，单位为秒，精度是毫秒
$pipe 如果请求是通过http流水线发送，则其值为”p”，否则为“.”
$request_length 请求长度（包括请求行，请求头和请求体）
$request_time 整个请求的总时间，请求处理时长，单位为秒，精度为毫秒，从读入客户端的第一个字节开始，直到把最后一个字符发送张客户端进行日志写入为止
- 空白，用一个“-”占位符替代，历史原因导致还存在

需要注意的是：log_format配置必须放在http内，否则会出现如下警告信息：

nginx: [warn] the “log_format” directive may be used only on “http” level in /etc/nginx/nginx.conf:9

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

  1. access_log /var/logs/nginx-access.log main
  2. log_format main '$remote_addr - $remote_user [$time_local] "$request" '
  3.                 '$status $body_bytes_sent "$http_referer" '
  4.                 '"$http_user_agent" "$http_x_forwarded_for"';
  6. log_format main '$server_name $remote_addr - $remote_user [$time_local] "$request" '
  7.                 '$status $uptream_status $body_bytes_sent "$http_referer" '
  8.                 '"$http_user_agent" "$http_x_forwarded_for" '
  9.                 '$ssl_protocol $ssl_cipher $upstream_addr $request_time $upstream_response_time';

使用log_format指令定义了一个main的格式，并在access_log指令中引用了它。假如客户端有发起请求：https://***.com/，看一下截取的一个请求的日志记录:

  1. 112.195.209.90 - - [20/Feb/2018:12:12:14 +0800]   
  2. "GET / HTTP/1.1" 200 190 "-" "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N)   
  3. 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出错时的日志，格式不支持自定义。通过错误日志，你可以得到系统某个服务或server的性能瓶颈等。因此，将日志好好利用，可以得到很多有价值的信息。

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

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

语法

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

  1. error_log file [level];
  2. error_log path(存放路径) level(日志等级)
  3. # Default:      
  4. error_log logs/error.log error;

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

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

基本用法

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

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

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

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

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

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。

基本用法

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

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

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

日志分割

  1. 编写nginx日志分割脚本 
  1. #!/bin/bash 
  2. LOGS_PATH=/usr/local/nginx/logs 
  3. YESTERDAY=$(date -d "yesterday" +%Y-%m-%d) 
  4. cp ${LOGS_PATH}/access.log ${LOGS_PATH}/access_${YESTERDAY}.log && >${LOGS_PATH}/access.log
  5. cp ${LOGS_PATH}/error.log ${LOGS_PATH}/error_${YESTERDAY}.log && >${LOGS_PATH}/error.log
  1. 设置定时任务运行脚本 
  1. $ crontab -e
  2. 0 0 * * *  /usr/local/nginx/logs/NginxLogRotate.sh

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

总结

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

另外，在access_log和log_format中使用了很多变量，这些变量没有一一列举出来，详细的变量信息可以参考Nginx官方文档：http://nginx.org/en/docs/varindex.html