配置Nginx访问与错误日志

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

6 min read
By myfreax
配置Nginx访问与错误日志

Nginx是开源的高性能HTTP和反向代理服务器,负责处理Internet上某些最大站点的负载。在管理NGINX网络服务器时,您要执行的最常见任务之一就是检查日志文件。

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

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

配置Nginx访问日志

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

log_format指令允许您定义日志的格式。access_log指令启用并设置日志文件的保存位置和使用的格式。

这是access_log指令的最基本语法access_log log_file log_format;

其中log_file是日志文件的完整路径,log_format是日志文件使用的格式。可以在httpserverlocation指令的上下文中启用访问日志。

为获得更好的可维护性,建议为每个Nginx的虚拟主机设置一个单独的访问日志文件。

server指令中设置的access_log指令将覆盖在http指令中设置的access_log。默认情况下,Nginx主配置文件中的http指令配置了全局访问日志格式。

如果未指定日志格式,Nginx将使用预定义的combined组合格式。

http {
  ...
  log_format combined '$remote_addr - $remote_user [$time_local] '
                    '"$request" $status $body_bytes_sent '
                    '"$http_referer" "$http_user_agent"'; #这是Nginx内置的默认格式
  access_log  /var/log/nginx/access.log;
  ...

  server {
    server_name domain.com
    access_log  /var/log/nginx/domain.access.log; #覆盖HTTP上下文的access_log
    ...
  }
}
/etc/nginx/conf.d/domain.com.conf

要更改日志记录格式,请覆盖默认设置或定义一个新设置。例如,定义一个名为 main的新日志记录格式。

它将添加X-Forwarded-For的值来扩展combined格式,在httpserver的上下文中添加以下log_format指令定义创建一个自定义日志格式。

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指令的日志文件位置之后指定自定义的日志格式名称,例如使用custom日志格式,access_log指令将会设置为access_log  /var/log/nginx/access.log custom;

虽然访问日志提供了非常有用的信息。但它会占用磁盘空间,并可能影响服务器性能。如果服务器资源不足,并且网站繁忙,则可能需要禁用访问日志。

如果你需要禁用访问日志,请将access_log指令的值设置为offaccess_log  off;。理论上你不会出现这种情况,Nginx默认会自动删除前期的日志文件。

配置错误日志

Nginx将应用程序和服务器错误的消息写入错误日志文件。如果您在Web应用程序中遇到错误,则错误日志是您开始进行排查问题的第一个位置。

error_log指令启用并设置错误日志的保存位置和严重性级别。这是设置error_log的格式error_log log_file log_level,可以在httpserverlocation上下文中进行设置。

log_level参数设置日志级别。以下是按严重性从低到高列出的级别。debug调试消息。info信息性消息。notice公告。

warn警告。error处理请求时出错。crit关键问题。需要立即采取行动。alert -警报。必须立即采取行动。emerg紧急情况。系统处于无法使用的状态。

每个日志级别会包含更高级别日志。例如,如果您将日志级别设置为warn,则Nginx还将记录errorcritalertemerg消息。未指定log_level参数时,默认为error

默认情况下,error_log指令在主nginx.conf文件内的http上下文中定义。

与访问日志相同,建议为每个服务器设置一个单独的错误日志文件,该文件将覆盖更高级别的设置如http上下文中error_log设置。

例如,要将myfreax.com的错误日志设置为warn,您可以在server上下文使用设置error_log  /var/log/nginx/domain.error.log warn;

无论何时修改配置文件,都必须重新加载Nginx服务,以使更改生效。

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

理解Nginx日志文件

您可以使用catlessgrepcutawk等命令打开和解析nginx日志文件。以下是使用默认的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"

让我们细分Nginx日志文件记录的每个字段意味着什么。

$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" -"-"-引荐网址。"$http_user_agent" -Mozilla/5.0 ...-客户端的用户代理(网络浏览器)。

使用tail命令实时观看日志文件记录:

tail -f  access.log 

结论

日志文件为您提供有关服务器问题以及访问者如何与您的网站进行交互的信息。Nginx允许您根据需要配置访问和错误日​​志。如果您有任何问题或反馈,请随时发表评论。