Nginx 怎么在 Nginx 中使用 log_format 结合 JSON 结构化输出日志

落芳君_6527

落芳君_6527

2026-08-19

963人浏览

原创

nginx中配置json日志需在http块用单引号定义log_format,键和字符串值均用双引号,变量直接插入;应用时指定access_log路径与格式名;对含特殊字符的变量(如$http_user_agent)应配合map预处理;最后用python3 -m json.tool校验合法性。

nginx 怎么在 nginx 中使用 log_format 结合 json 结构化输出日志

在 Nginx 中使用 log_format 输出 JSON 格式日志,核心是定义一个包含变量的 JSON 字符串格式,并确保特殊字符(如双引号、空格)被正确转义或引用。Nginx 本身不解析 JSON,只是拼接字符串,所以关键在于格式合法、可被下游日志系统(如 Filebeat、Loki、ELK)直接消费。

定义 JSON 格式的 log_format

在 http 块中定义 log_format,用单引号包裹整个格式字符串,避免 shell 或配置解析干扰;JSON 内部字段名和字符串值都用双引号,变量(如 $time_local)直接插入:

  • 必须用单引号包围整个 log_format 值,否则 Nginx 会把空格或花括号误判为语法分隔符
  • 所有 JSON 键和静态字符串值都要用双引号,例如 "status": "$status"
  • 变量值若含双引号、换行或控制字符,Nginx 不自动转义 —— 生产环境建议配合 map 模块预处理(见下文)

示例:

log_format json '{"time":"$time_iso8601","remote_addr":"$remote_addr","host":"$host","request_uri":"$request_uri","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"}';

应用到 access_log 并启用

在 server 或 location 块中调用该格式:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • 指定日志路径和格式名(如 json),支持追加 buffer 和 flush 提升性能
  • 避免写入 /dev/stdout(除非容器环境且明确重定向),推荐写入文件并由日志采集器读取

示例:

access_log /var/log/nginx/access.json json buffer=32k flush=1s;

处理特殊字符:用 map 预清洗危险字段

$http_user_agent 或 $http_referer 可能含双引号、换行符,直接插入 JSON 会导致解析失败。Nginx 的 map 指令可做简单替换:

  • 在 http 块中定义 map,将双引号、换行、制表符替换为空字符串或占位符
  • 注意 map 是惰性执行,只对匹配变量生效,不影响性能

示例:

map $http_user_agent $ua_json {
  default "$http_user_agent";
  ~"[""\n\r\t]" "invalid_ua";
}
log_format json '{"user_agent":"$ua_json",...}';

验证与调试技巧

JSON 日志是否合法,不能只靠肉眼检查:

  • 用 nginx -t 确认配置语法无误(它不校验 JSON 结构)
  • 触发一次请求后,用 tail -1 /var/log/nginx/access.json | python3 -m json.tool 格式化校验
  • 若报错,常见原因是某个变量为空导致 JSON 缺少引号(如 "ref": $http_referer → "ref": ),务必给所有字符串变量加引号

相关文章

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

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

下载

相关标签:

nginx js json

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3607

6

nginx配置详解
nginx配置详解

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

2023.08.04

6345

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

497

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万人学习