Nginx之日志模块解读

港控/mmm° 2023-10-16 13:38 60阅读 0赞

**目录**

基本介绍

配置指令

access\_log（访问日志）

error\_log（ 错误日志）

--------------------

### 基本介绍 ###

Nginx日志主要分为两种：access\_log(访问日志)和error\_log(错误日志)。Nginx日志主要记录以下信息：

*  记录Nginx服务启动和停止的信息。
 *  记录客户端访问Nginx服务的信息，包括客户端IP、客户端浏览器、访问时间、访问状态等等。
 *  记录Nginx运行的异常情情况及错误信息。

> 如果你不进行任何配置的话，这 2 个日志将会使用默认的日志配置，这个日志将会位于
> 
> `/var/log/nginx` 目录中。

### 配置指令 ###

#### **access\_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 off; #关闭当前作用域下的所有日志
     
    access_log log_file log_format;#设置日志文件的位置和使用的格式

第二条指令中**log\_file是日志文件的绝对路径**，log\_format是日志文件记录的格式。可以在http、server、location等指令的上下文中启用访问日志。Nginx默认开启了访问日志的功能，**且log\_format指令的配置仅可用在http模块内，否则会出现警告信息**。

http {
      access_log  /nginx/access.log;
    ......
      server {
        server_name test.com
        access_log /nginx/domain.access.log;
        ......
      }
    }

> 如果没有指定log\_format，会自动使用系统默认名为**combined**的：

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分钟。

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

<table> 
 <thead> 
 <tr> 
 <td> 变量 </td> 
 <td> 含义 </td> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td> $bytes_sent </td> 
 <td> 发送给客户端的总字节数 </td> 
 </tr> 
 <tr> 
 <td> $body_bytes_sent </td> 
 <td> 发送给客户端的字节数，不包括响应头的大小 </td> 
 </tr> 
 <tr> 
 <td> $connection </td> 
 <td> 连接序列号 </td> 
 </tr> 
 <tr> 
 <td> $connection_requests </td> 
 <td> 当前通过连接发出的请求数量 </td> 
 </tr> 
 <tr> 
 <td> $msec </td> 
 <td> 日志写入时间，单位为秒，精度是毫秒 </td> 
 </tr> 
 <tr> 
 <td> $pipe </td> 
 <td> 如果请求是通过http流水线发送，则其值为"p"，否则为“." </td> 
 </tr> 
 <tr> 
 <td> $request_length </td> 
 <td> 请求长度（包括请求行，请求头和请求体） </td> 
 </tr> 
 <tr> 
 <td> $request_time </td> 
 <td> 请求处理时长，单位为秒，精度为毫秒，从读入客户端的第一个字节开始，直到把最后一个字符发送张客户端进行日志写入为止 </td> 
 </tr> 
 <tr> 
 <td> $status </td> 
 <td> 响应状态码 </td> 
 </tr> 
 <tr> 
 <td> $time_iso8601 </td> 
 <td> 标准格式的本地时间,形如“2017-05-24T18:31:27+08:00” </td> 
 </tr> 
 <tr> 
 <td> $time_local </td> 
 <td> 通用日志格式下的本地时间，如"24/May/2017:18:31:27 +0800" </td> 
 </tr> 
 <tr> 
 <td> $http_referer </td> 
 <td> 请求的referer地址。 </td> 
 </tr> 
 <tr> 
 <td> $http_user_agent </td> 
 <td> 客户端浏览器信息。 </td> 
 </tr> 
 <tr> 
 <td> $remote_addr </td> 
 <td> 客户端IP </td> 
 </tr> 
 <tr> 
 <td> $http_x_forwarded_for </td> 
 <td> 当前端有代理服务器时，设置web节点记录客户端地址的配置，此参数生效的前提是代理服务器也要进行相关的x_forwarded_for设置。 </td> 
 </tr> 
 <tr> 
 <td> $request </td> 
 <td> 完整的原始请求行，如&nbsp;"GET / HTTP/1.1" </td> 
 </tr> 
 <tr> 
 <td> $remote_user </td> 
 <td> 客户端用户名称，针对启用了用户认证的请求 </td> 
 </tr> 
 <tr> 
 <td> $request_uri </td> 
 <td> 完整的请求地址，如&nbsp;"https://daojia.com/" </td> 
 </tr> 
 </tbody> 
</table>

#### error\_log（ 错误日志） ####

它也是在http，server或location指令的上下文中设置，一般写法如下：

error_log path(存放路径) level(日志等级)

其中log\_file为错误日志存放的绝对路径。

一般情况下每个server都会有自己单独的，在server中配置后，其优先级比http下的高。

http {
      error_log  /home/sdc/public/app/nginx/error.log;
    ......
      server {
        server_name test.com
        error_log /home/sdc/public/app/nginx/test_error.log debug;
        ......
      }
    }

error_log  logs/error.log  info;

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

error\_log /dev/null; **表示将存储日志的路径设置为“垃圾桶”。**