配置 Nginx 的访问日志和错误日志

Nginx 是一个开源的高性能 HTTP 和反向代理服务器,Internet 上一些流量很大的站点都在使用它。在管理 NGINX Web 服务器时,您最常执行的任务之一就是检查日志文件。

在对服务器或应用程序问题进行故障排除时,知道如何配置和读取日志非常有用,因为它们提供了详细的调试信息。

Nginx 用两种类型的日志记录其事件记录:访问日志和错误日志。访问日志记录有关客户端请求的信息,错误日志记录有关服务器和应用程序问题的信息。

本文概述了如何配置和读取 Nginx 访问和错误日​​志。

配置访问日志

每当处理客户请求时, Nginx 都会在访问日志中生成一个新事件。每个事件记录都包含一个时间戳,并包含有关客户端和所请求资源的各种信息。访问日志可以向您显示访问者的位置,访问者访问的页面,他们在页面上花费的时间等等。

log_format 指令中您可以定义记录消息的格式。access_log 指令启用并设置日志文件的位置和使用的格式。

access_log 指令的最基本语法如下:

access_log log_file log_format;

其中 log_file 是日志文件的完整路径, log_format 是日志文件使用的格式的名称。

无论是在 httpserverlocation 指令段中,都可以启用访问日志。

默认情况下,在 Nginx 主配置文件 /etc/nginx/nginx.conf 中的 http 指令段中全局启用访问日志。

http {
  ...
  access_log  /var/log/nginx/access.log;
  ...
}

为了获得更好的可维护性,建议为每个服务器块设置一个单独的访问日志文件。 server 段中设置的 access_log 指令会覆盖掉更高层的 http 段中设置的指令。如下面 /etc/nginx/conf.d/domain.com.conf 中的配置:

http {
  ...
  access_log  /var/log/nginx/access.log;
  ...

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

如果未指定日志格式, Nginx 将使用如下所示的预定义 combined 格式:

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

要更改日志记录格式,请覆盖默认设置或定义一个新设置。例如,在 http 或者 server 指令中定义一个名为 custom 的新日志记录格式,它扩展了 combined 格式,用来显示 X-Forwarded-For 请求头, 如下所示:

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

要使用新格式,请在日志文件后指定其名称,如下所示:

access_log  /var/log/nginx/access.log custom;

而访问日志提供了非常有用的信息。它会占用磁盘空间,并可能影响服务器性能。如果服务器资源不足,并且网站繁忙,则可能要禁用访问日志。为此,请将 access_log 伪指令的值设置为 off

access_log  off;

配置错误日志

Nginx 在错误日志文件中记录有关应用程序和常规服务器错误的消息。如果您在 Web 应用程序中遇到错误,则错误日志往往是开始进行故障排除问题的第一选择。

error_log 指令用来启用错误日志并设置错误日志的位置和严重性级别。它采用下列形式,并且可以配置在 httpserverlocation 块中:

error_log log_file log_level

log_level 参数设置日志记录级别。以下是按严重性(从低到高)列出的级别:

  • debug - 调试消息。
  • info - 信息性消息。
  • notice - 公告。
  • warn - 警告。
  • error - 处理请求时出错。
  • crit - 关键问题。需要迅速采取行动。
  • alert - 警报。必须立即采取行动。
  • emerg - 紧急情况。系统处于无法使用状态。

每个日志级别包括更高级别。例如,如果您设置日志级别 warn , Nginx 的也会记录 errorcritalert ,和 emerg 消息。

log_level 不指定参数,则默认为 error

默认情况下,该 error_log 指令在主 nginx.conf 文件 /etc/nginx/nginx.conf 内的 http 指令中定义:

http {
  ...
  error_log  /var/log/nginx/error.log;
  ...
}

与访问日志相同,建议为每个服务器块设置一个单独的错误日志文件,该文件将覆盖从更高级别继承的设置。

例如,要将 domain.com 的错误日志设置为 warn ,请使用:

http {
  ...
  error_log  /var/log/nginx/error.log;
  ...

  server {
    server_name domain.com
    error_log  /var/log/nginx/domain.error.log warn;
    ...
  }
}

每当您修改配置文件时,都必须重新启动 Nginx 服务以使更改生效。

日志文件的位置

默认情况下,在大多数 Linux 发行版(如 UbuntuCentOSDebian) 上,访问和错误日​​志位于 /var/log/nginx 目录中。

查看和分析 Nginx 日志文件

您可以打开并使用 catlessgrepcutawk 等类似的标准命令解析日志文件。

这是来自访问日志文件的示例记录,该记录使用默认的 Nginx 日志格式:

192.168.33.1 - - [15/Oct/2019:19:41:46 +0000] "GET/HTTP/1.1" 200 396 "-" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.120 Safari/537.36"

让我们分解一下记录的每个字段的含义:

  • $remote_addr –  192.168.33.1 发出请求的客户端的 IP 地址。
  • $remote_user – - HTTP 验证用户。未设置用户名时,显示 -
  • [$ time_local] – [15/Oct/2019:19:41:46 +0000] 本地服务器时间。
  • " $request " –  " GET/HTTP/1.1 " 请求类型,路径和协议。
  • $status –  200 服务器响应代码。
  • $body_bytes_sent –  396 服务器响应的大小(以字节为单位)。
  • " $http_referer " –  "-" referer 网址。
  • " $http_user_agent " –   Mozilla/5.0 ... 客户端的用户代理 (Web 浏览器)。

使用以下 tail 命令实时查看日志文件:

tail -f  access.log

结论

日志文件记录了有关服务器问题以及访问者如何与您的网站进行交互的有用信息。您可以根据自己的和实际情况和需要配置访问和错误日​​志。