nginx

关注公众号 jb51net

关闭
首页 > 网站技巧 > 服务器 > nginx > Nginx JSON日志格式

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

作者：Leo-Yide

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

前言

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

为什么选择JSON格式日志？

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

配置步骤详解

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

扩展配置

添加更多字段

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

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

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

您可能感兴趣的文章:
阅读全文