14《Nginx 入门教程》Nginx的日志功能

Posted 2023-03-14

参考技术A 通常，在生产环境中使用 nginx 进行反向代理和负载均衡或者各种其他处理时，良好的日志记录是非常关键的一环。通过精心配置的 Nginx 日志，我们可以获取用户的真实 ip、浏览器信息，请求处理时间，请求URL等，这样方便我们排查和回溯错误。具体要记录哪些信息，可以通过 Nginx 中的 log_format 指令定义，由它定义日志的格式。而对于使用哪种日志格式和设置日志的保存路径则由 access_log 指令指定的。另外在 Nginx 中还有一个配置服务器和请求处理过程中的错误信息的指令，那就是 error_log指令。最后，如果在配置的日志文件路径中使用了变量，我们可以通过open_log_file_cache指令来设置缓存，提升性能。对于大型的网站而言，大量的 http 请求意味着大量的日志记录，及时按天或按大小进行 Nginx 日志备份也至关重要的。

在 Nginx 的日志模块主要有2个, ngx_stream_log_module 和 ngx_http_log_module，分别表示四层的日志模块和七层的日志模块，其指令和用法都是一致的，接下来我们只针对 http 请求的日志进行说明和使用。

在 ngx_http_log_module 模块中，只3个指令，分别是 access_log、log_format 和 open_log_file_cache。这些指令具体的格式如下：

ngx_http_log_module 模块用来按某个格式来记录请求的日志。模块中的 log_format 指令就是用来设置打印日志的格式，该指令中可以使用 Nginx 中的各种变量，比如保存远端ip地址的变量$remote_addr等。一个简单的示例如下：

接下来是 access_log 指令。参考前面的指令格式。关闭日志记录，直接是写 access_log off ，如果打开 access 日志，它的写法是:

access_log 指令示例:

每一条日志记录的写入都是先打开文件再写入记录，然后关闭日志文件。如果你的日志文件路径中使用了变量，如 access_log /var/logs/$host/access.log ，为提高性能，可以使用 open_log_file_cache 指令设置日志文件描述符的缓存。可以通过 open_log_file_cache off 关闭该缓存。该指令的几个参数选项说明如下：

最后 error_log 是 错误日志配置指令，主要记录客户端访问 Nginx 出错时的日志，它不不支持自定义日志格式。通过检查错误日志，可以快速定位线上问题，所以也是很重要的。关闭错误日志的方式和 access_log不一样，没有 error_log off 这样关错误日志的用法，反而会将错误日志打到名为 off 的文件中。常用的关闭方式是:

就像在 Linux 系统中，输出到 /dev/null 的内容实际上等价于丢弃一样。

Nginx 的日志切割实现的核心是使用 nginx 命令的 reopen 参数实现，该参数的含义是重新开始记录日志文件。人工切的做法就是凌晨将日志备份，然后执行带reopen参数的命令:

执行后会重新生成 access.log 和 error.log，这就是手工切割的方式。通常我们会用 shell 脚本和定时任务来帮我我们完成自动切割。首先准备如下的 shell 脚本，它完成日志的备份以及给 nginx 进程发生 reopen 信号。

接下来，只要将这个脚本加入到 crontab 中即可，如下操作:

我们在 nginx.conf 中添加如下的日志配置:

这里我们综合了前面涉及的知识，这里只简单测试日志配置中 if 功能。我们设置请求的相应码为 3xx 和 4xx 时，日志不会记录。接下来，启动或者热加载 Nginx， 然后分别对应三个端口发送 http 请求并观察 access.log 日志:

本小节我们介绍了 log 相关的指令，包括访问日志和错误日志的指令。此外还介绍了 Nginx 中对日志切割的常用处理方法，这也是生产环境上使用日志备份的手段。