怎么配置 Nginx 以支持 JSON 格式的日志输出

冬丽同学_3762

冬丽同学_3762

2026-06-06

800人浏览

原创

nginx可通过log_format手动构造合法json日志,需对字符串字段加双引号、数值字段不加引号,并转义特殊字符;推荐用map预处理$remote_addr等高危变量,配合access_log启用,每行一个json对象。

怎么配置 nginx 以支持 json 格式的日志输出

Nginx 本身不直接支持原生 JSON 日志格式,但可以通过 log_format 指令结合变量和转义规则,构造出合法、可解析的 JSON 字符串写入日志文件。关键在于正确处理字段值中的双引号、换行、制表符等特殊字符,避免破坏 JSON 结构。

定义 JSON 格式的 log_format

在 http 或 server 块中添加自定义日志格式,用双引号包裹字段名和字符串值,对变量内容做基础转义(Nginx 不提供自动 JSON 编码,需手动规避非法字符):

log_format json_escape
  '{'
    '"time_local":"$time_local",'
    '"remote_addr":"$remote_addr",'
    '"request_method":"$request_method",'
    '"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"'
  '}';

注意:
- 字符串字段(如 $remote_addr)必须用双引号包裹;
- 数值字段(如 $request_time)不加引号,保持原始输出(Nginx 输出为数字或短横线 -);
- 若变量可能含双引号或换行(如 $http_user_agent),建议配合 map 指令预处理,或使用第三方模块(如 nginx-json-log)增强安全性;
- $upstream_response_time 可能为空或多个值(多 upstream 时用逗号分隔),实际使用时可加判断逻辑。

启用 JSON 日志并指定日志文件

在 server 或 location 块中使用 access_log 启用该格式:

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
access_log /var/log/nginx/access.json json_escape;

确保目标目录可写,且日志轮转工具(如 logrotate)配置兼容 JSON 行格式(每行一个 JSON 对象,即 JSON Lines)。不要合并多行——Nginx 每次请求只写一行。

处理特殊字符(可选但推荐)

为防止 $http_user_agent 等字段破坏 JSON,可用 map 清洗常见非法字符:

map $http_user_agent $ua_json {
  default          $http_user_agent;
  "~[[:cntrl:]"\]"  "-";
}

然后在 log_format 中改用 $ua_json 替代 $http_user_agent。类似方式可用于 $request_uri、$http_referer 等高风险字段。

验证与调试

  • 重载 Nginx 配置:nginx -t && nginx -s reload
  • 触发一次请求:curl -I http://localhost/
  • 检查日志是否为单行有效 JSON:tail -n1 /var/log/nginx/access.json | jq .(需安装 jq)
  • 若报错,重点检查双引号是否成对、末尾逗号是否多余、数值字段是否误加引号

相关文章

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

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

下载

相关标签:

nginx nginx log_format js json

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

383

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3287

6

nginx配置详解
nginx配置详解

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

2023.08.04

5965

6

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

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

2024.02.23

561

5

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

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

2024.07.09

1476

5

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

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

2024.08.07

3938

3

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

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

2026.01.13

122

12

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

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

2026.01.13

437

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