如何自定义Nginx JSON日志格式配置

 更新时间:2025年03月27日 09:14:56   作者:Leo-Yide  
Nginx作为最流行的Web服务器之一,其灵活的日志配置能力允许我们根据需求定制日志格式,本文将详细介绍如何配置Nginx以JSON格式记录访问日志,这种结构化日志格式特别适合ELK等日志分析系统处理,感兴趣的朋友一起看看吧

前言

在现代Web服务架构中,日志记录是监控、调试和安全审计的重要环节。Nginx作为最流行的Web服务器之一,其灵活的日志配置能力允许我们根据需求定制日志格式。本文将详细介绍如何配置Nginx以JSON格式记录访问日志,这种结构化日志格式特别适合ELK等日志分析系统处理。

为什么选择JSON格式日志?

相比传统的NCSA通用日志格式,JSON格式日志具有以下优势:

  • 结构化数据:便于日志分析系统(如ELK Stack)解析和处理
  • 字段扩展性:可以轻松添加或删除字段而不影响现有日志解析
  • 数据类型明确:数值、字符串等数据类型可以明确区分
  • 兼容性好:与大多数现代日志处理工具和数据库系统兼容

配置步骤详解

1. 安装Nginx服务

在基于Debian/Ubuntu的系统上安装Nginx:

apt -y install nginx

对于RHEL/CentOS系统,请使用:

yum -y install nginx

2. 自定义JSON日志格式

编辑Nginx主配置文件(通常位于/etc/nginx/nginx.conf):

http {
    ...
    log_format oldboyedu_nginx_json '{"@timestamp":"$time_iso8601",'
                                  '"host":"$server_addr",'
                                  '"clientip":"$remote_addr",'
                                  '"SendBytes":$body_bytes_sent,'
                                  '"responsetime":$request_time,'
                                  '"upstreamtime":"$upstream_response_time",'
                                  '"upstreamhost":"$upstream_addr",'
                                  '"http_host":"$host",'
                                  '"uri":"$uri",'
                                  '"domain":"$host",'
                                  '"xff":"$http_x_forwarded_for",'
                                  '"referer":"$http_referer",'
                                  '"tcp_xff":"$proxy_protocol_addr",'
                                  '"http_user_agent":"$http_user_agent",'
                                  '"status":"$status"}';
    access_log  /var/log/nginx/access.log  oldboyedu_nginx_json;
    # 重要:注释或移除默认的日志格式
    # access_log /var/log/nginx/access.log;
    ...
}

各字段说明

字段名变量描述
@timestamp$time_iso8601ISO8601格式的时间戳
host$server_addr服务器IP地址
clientip$remote_addr客户端IP地址
SendBytes$body_bytes_sent发送给客户端的字节数
responsetime$request_time请求处理总时间
upstreamtime$upstream_response_time后端服务器响应时间
upstreamhost$upstream_addr后端服务器地址
http_host$host请求的主机头
uri$uri请求的URI
domain$host请求的域名
xff$http_x_forwarded_forX-Forwarded-For头信息
referer$http_referer请求来源
tcp_xff$proxy_protocol_addr代理协议地址
http_user_agent$http_user_agent用户代理字符串
status$statusHTTP响应状态码

3. 配置文件语法检查

执行以下命令检查Nginx配置是否正确:

nginx -t

如果配置正确,您应该看到类似输出:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

4. 重启Nginx服务

应用新的配置:

systemctl restart nginx

5. 测试验证

可以使用简单的循环命令测试日志记录:

while true; do curl 10.0.0.91; sleep 0.5; done

检查日志文件内容:

tail -f /var/log/nginx/access.log

您应该看到类似以下的JSON格式日志条目:

{"@timestamp":"2023-05-15T14:30:45+08:00","host":"10.0.0.91","clientip":"10.0.0.1","SendBytes":612,"responsetime":0.002,"upstreamtime":"-","upstreamhost":"-","http_host":"10.0.0.91","uri":"/","domain":"10.0.0.91","xff":"-","referer":"-","tcp_xff":"","http_user_agent":"curl/7.68.0","status":"200"}

生产环境建议

日志轮转:配置logrotate以防止日志文件过大

vim /etc/logrotate.d/nginx
  • 敏感信息过滤:避免记录敏感信息如密码、信用卡号等

  • 性能考虑:在高流量环境中,JSON日志可能会增加磁盘I/O负载

  • 字段优化:根据实际需求调整字段,只记录必要信息

  • 日志分割:考虑按虚拟主机或日期分割日志文件

扩展配置

添加更多字段

您可以根据需要扩展日志格式,例如添加请求方法:

log_format oldboyedu_nginx_json '{"@timestamp":"$time_iso8601",'
                              ...
                              '"method":"$request_method",'
                              ...
                              '"status":"$status"}';

条件日志记录

对于静态资源等不重要的请求,可以跳过日志记录:

map $uri $is_static {
    default 0;
    ~*\.(jpg|jpeg|png|gif|ico|css|js|woff|woff2|ttf|svg) 1;
}
server {
    ...
    access_log /var/log/nginx/access.log oldboyedu_nginx_json if=$is_static;
    ...
}

常见问题排查

  • 日志文件无写入

    • 检查Nginx进程用户对日志目录的权限
    • 确认没有其他配置覆盖了access_log指令
  • JSON格式错误

    • 确保所有字符串值都有双引号包围
    • 确保没有多余的逗号
  • 性能下降

    • 考虑减少日志字段数量
    • 评估使用缓冲写入(access_log ... buffer=32k flush=5m

结论

通过配置Nginx以JSON格式记录访问日志,您可以获得更加结构化和易于分析的日志数据。这种格式特别适合与ELK Stack、Splunk等日志分析系统集成,为您的Web服务提供更好的可观测性。根据您的具体需求,可以灵活调整日志字段,平衡信息丰富度和系统性能。

到此这篇关于自定义Nginx JSON日志格式配置指南的文章就介绍到这了,更多相关Nginx JSON日志格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Nginx实现根据 IP 匹配指定 URL

    使用Nginx实现根据 IP 匹配指定 URL

    最近的一个项目,需要特定的IP访问某专题页面的时候跳转到网站首页,思考了下,直接使用NGINX实现,分享给大家。
    2014-09-09
  • 使用 Nginx 部署静态页面的方法

    使用 Nginx 部署静态页面的方法

    本篇文章主要介绍了使用 Nginx 部署静态页面的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • nginx 基本入门教程

    nginx 基本入门教程

    本篇文章主要介绍了详解nginx 基本入门,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • Nginx更换ssl证书不生效的问题解决

    Nginx更换ssl证书不生效的问题解决

    本文主要介绍了Nginx配置中更换SSL证书后,新证书不生效的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-12-12
  • nginx HTTP模块配置常用指令

    nginx HTTP模块配置常用指令

    这篇文章主要介绍了nginx HTTP模块在配置文件中常用的指令,详解了每个指令的含义、语法和注意事项等,需要的朋友可以参考下
    2014-03-03
  • nginx降权与匹配php详细讲解

    nginx降权与匹配php详细讲解

    大部分网站开发语言都要运行在服务器,比如主流的nginx、apache等等,下面这篇文章主要给大家介绍了关于nginx降权与匹配php的相关资料,需要的朋友可以参考下
    2023-01-01
  • Nginx 正向代理和反向代理的配置实现

    Nginx 正向代理和反向代理的配置实现

    Nginx通过优秀的架构设计和高效的算法实现了高性能和高可靠性,本文主要介绍了Nginx 正向代理和反向代理的配置实现,具有一定的参考价值,感兴趣的可以了解一下
    2023-06-06
  • 在Nginx中拦截特定用户代理的教程

    在Nginx中拦截特定用户代理的教程

    这篇文章主要介绍了在Nginx中拦截特定用户代理的教程,并为这些被拦截的用户设置一个黑名单以方便管理,需要的朋友可以参考下
    2015-06-06
  • Nginx服务器基础的安全配置与一些安全使用提示

    Nginx服务器基础的安全配置与一些安全使用提示

    这篇文章主要介绍了Nginx服务器基础的安全配置与一些安全使用提示,文中举了一些典型的Nginx与PHP的环境用例,需要的朋友可以参考下
    2016-01-01
  • Nginx 502 bad gateway和Nginx 504 Gateway Time-out错误解决方法 错误解决办法

    Nginx 502 bad gateway和Nginx 504 Gateway Time-out错误解决方法 错误解决办

    Nginx 502 Bad Gateway的含义是请求的PHP-CGI已经执行,但是由于某种原因(一般是读取资源的问题)没有执行完毕而导致PHP-CGI进程终止
    2012-09-09

最新评论