Nginx 自定义日志格式怎么使用 escape=json 输出 JSON 格式日志

浅丽姑娘_8985

浅丽姑娘_8985

2026-10-09

863人浏览

原创

nginx 1.11.8+ 支持 escape=json 参数,自动对变量值中的双引号、反斜杠、换行符等做 json 转义,确保日志字段符合 json 字符串规范;需在 http 块定义 log_format,字符串变量加引号并后置 escape=json,数值字段不加引号,再通过 access_log 启用。

nginx 自定义日志格式怎么使用 escape=json 输出 json 格式日志

Nginx 从 1.11.8 版本开始支持 escape=json 参数,用于在 log_format 中自动对变量值做 JSON 转义(如双引号、反斜杠、换行符、控制字符等),从而安全地将日志输出为结构化 JSON 格式。关键不是“生成完整 JSON 对象”,而是确保每个字段值都符合 JSON 字符串规范,避免解析失败。

配置带 escape=json 的 log_format

在 http 块中定义日志格式,所有需写入 JSON 字段的变量后加上 escape=json:

log_format json_combined escape=json
  '{'
    '"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_user_agent":"$http_user_agent",'
    '"http_referer":"$http_referer",'
    '"request_time":$request_time,'
    '"upstream_response_time":"$upstream_response_time"'
  '}';

注意:

  • 整个日志行是手动拼接的 JSON 对象字符串,escape=json 只作用于每个双引号内的变量值(如 "$http_user_agent"),不处理大括号、逗号、冒号等固定字符;
  • 数字类型字段(如 $status、$body_bytes_sent)不要加引号,否则会被当成字符串;若加了引号又用了 escape=json,Nginx 会报错(语法不允许对非字符串变量用 escape);
  • $upstream_response_time 是字符串(可能为空或多个时间,如 "0.002, 0.005"),必须加引号并启用 escape=json;
  • 所有字符串变量($xxx)只要出现在 JSON 字符串值位置,都建议加 escape=json,防止特殊字符破坏 JSON 结构。

启用该日志格式并写入文件

在 server 或 location 块中使用 access_log 指令指定格式:

access_log /var/log/nginx/access.json json_combined;

确保目标目录可写,且 Nginx 进程有权限创建/追加该文件。重启或重载 Nginx 生效:

Browser Js
Browser Js

轻量级CDP浏览器控制,适用于AI代理。相较于内置浏览器工具,token消耗降低3‑10倍,仅在浏览时使用。

下载
nginx -t && nginx -s reload

验证日志是否合法 JSON

查看一行日志示例(已美化):

{
  "time_local":"21/Jan/2025:14:22:36 +0800",
  "remote_addr":"192.168.1.100",
  "request_method":"GET",
  "request_uri":"/api/v1/users?id=123&name=John%20Doe",
  "status":200,
  "body_bytes_sent":1247,
  "http_user_agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36",
  "http_referer":"https://example.com/dashboard",
  "request_time":0.023,
  "upstream_response_time":"0.021"
}

可使用命令快速校验:

head -1 /var/log/nginx/access.json | python3 -m json.tool

如果报错,常见原因包括:某变量值含未转义的换行符($request_uri 或 $http_user_agent 中混入恶意换行)、漏写 escape=json、数字字段误加引号。

进阶建议

提升 JSON 日志实用性:

  • 添加唯一请求 ID:map $request_id $req_id { default "$request_id"; },再在 log_format 中用 "request_id":"$req_id";
  • 过滤空值或敏感字段:用 map 预处理变量(如隐藏密码参数),再写入日志;
  • 配合 logrotate 按天切分,并用 gzip 压缩,避免单文件过大;
  • 若需完整结构化采集(如对接 ELK),推荐用 nginx-json-log 等模块或 Fluentd/Ngrok 做后续解析与转发,而非仅靠 Nginx 原生能力。

相关文章

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

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

下载

相关标签:

nginx js json access

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

383

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3347

6

nginx配置详解
nginx配置详解

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

2023.08.04

6045

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

457

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