Nginx 中怎么配置自定义日志格式支持 JSON 结构化输出

老婷吖_8099

老婷吖_8099

2026-10-22

973人浏览

原创

Nginx通过log_format自定义JSON日志格式,字符串字段加双引号并转义特殊字符,数值字段不加引号,推荐使用Nginx 1.19.10+的$json安全变量(如$http_user_agent_json),并在access_log中指定该格式以输出合法单行JSON。

nginx 中怎么配置自定义日志格式支持 json 结构化输出

在 Nginx 中实现 JSON 格式日志输出,核心是通过 log_format 指令自定义日志格式,并用引号、转义和变量拼接构造合法 JSON 字符串。Nginx 本身不解析 JSON,但能原样输出符合 JSON 语法的字符串,供下游(如 Filebeat、Fluentd 或 Loki)采集解析。

定义 JSON 日志格式

在 http 块中添加如下配置(注意:所有字段值需用双引号包裹,特殊字符如空格、引号需转义;变量如 $time_local 会自动展开):

log_format json '{"@timestamp":"$time_iso8601",'
                 '"remote_addr":"$remote_addr",'
                 '"remote_user":"$remote_user",'
                 '"request":"$request",'
                 '"status":$status,'
                 '"body_bytes_sent":$body_bytes_sent,'
                 '"http_referer":"$http_referer",'
                 '"http_user_agent":"$http_user_agent",'
                 '"request_time":$request_time,'
                 '"upstream_response_time":"$upstream_response_time",'
                 '"host":"$host"}';

说明:

  • 每行末尾的逗号需紧跟前一个字段的右引号,换行仅为了可读性,Nginx 会自动拼接;
  • 数值型字段(如 $status、$request_time)不加引号,保持 JSON 数字类型;
  • 字符串字段(如 $http_user_agent)必须加双引号,且内部双引号需用 \" 转义(若 UA 含引号,建议用 $http_user_agent_json 变量替代,见下文);
  • $time_iso8601 比 $time_local 更适合作为时间戳,因它符合 ISO 8601 标准且含时区。

处理特殊字符(如引号、换行)

默认变量可能含非法 JSON 字符(如 User-Agent 中的双引号)。推荐启用 nginx-module-json(第三方模块)或使用内置的 JSON 安全变量(Nginx 1.19.10+):

  • 升级到 Nginx ≥ 1.19.10 后,可用 $http_user_agent_json、$arg_x_json 等自动转义变量;
  • 若无法升级,可配合 map 指令做简单替换(如将双引号替换为空字符串),但无法覆盖所有情况;
  • 避免在 JSON 字段中直接使用未处理的 $request 或 $args,建议拆分为 $request_method、$uri、$args 单独输出。

在 server 或 location 中启用 JSON 日志

指定 access_log 使用刚定义的 json 格式,并确保路径有写入权限:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
server {
    listen 80;
    server_name example.com;
<pre class="brush:php;toolbar:false;">access_log /var/log/nginx/access.json json;
error_log  /var/log/nginx/error.log;

location / {
    proxy_pass http://backend;
    # 其他配置...
}

}

注意:

  • 日志文件后缀(如 .json)仅为标识,不影响内容;
  • 多个 access_log 指令可共存(如同时输出文本日志和 JSON 日志);
  • 重启 Nginx 后生效:nginx -t && nginx -s reload。

验证与调试技巧

生成一条请求后,检查日志是否为单行合法 JSON(每条日志一行,无换行符):

  • 用 tail -n1 /var/log/nginx/access.json | jq . 验证解析是否成功(需安装 jq);
  • 若报错 “invalid character”,常见原因是某个变量值含未转义双引号或换行,可临时改用 $http_user_agent_json 替代;
  • 测试时用 curl -H "User-Agent: test\"abc" http://localhost 模拟含引号 UA,观察日志是否崩坏。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx js json access agent

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3727

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

6485

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

581

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1496

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

3978

3

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

122

12

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

517

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

159

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习