如何在Nginx中利用Log-Format自定义输出符合JSON规范的审计日志

陌明同学_5352

陌明同学_5352

2026-05-05

205人浏览

原创

nginx中实现合规json审计日志需用log_format定义格式并启用access_log,关键在于使用escape=json自动转义、统一字符串加引号、确保每行一个合法json对象,配合syslog或文件输出,谨慎扩展请求体与响应头记录。

如何在nginx中利用log-format自定义输出符合json规范的审计日志

在 Nginx 中实现符合 JSON 规范的审计日志,核心是通过 log_format 指令定义结构化日志格式,并配合 access_log 启用输出。关键在于正确转义双引号、处理空格与特殊字符、确保字段值合法(如字符串加引号、数字不加引号),同时避免因变量为空导致 JSON 格式损坏。

定义合规的 JSON 日志格式

Nginx 原生不支持 JSON 编码,需手动拼接字符串。所有字符串字段必须用双引号包裹,键名和字符串值中的双引号需用反斜杠转义;数值型变量(如 $status、$body_bytes_sent)可不加引号,但为统一性和解析安全,建议统一按字符串处理(即加引号并转义)。

示例(含常见审计字段):

log_format json_audit escape=json '{'
  '"time_local":"$time_local",'
  '"remote_addr":"$remote_addr",'
  '"x_forwarded_for":"$http_x_forwarded_for",'
  '"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",'
  '"upstream_addr":"$upstream_addr"'
  '}';

注意:escape=json 是 Nginx 1.11.8+ 的关键参数,它会自动对变量值中的双引号、反斜杠、控制字符等做 JSON 转义,大幅降低手写转义出错风险。没有该参数时,需自行用 $escap… 变量或 Lua 模块补救。

启用 JSON 日志并写入文件或 syslog

在 http、server 或 location 块中引用该格式:

dmap-jsapi-skill
dmap-jsapi-skill

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

下载
  • 写入本地文件(推荐用于调试和中小流量):
access_log /var/log/nginx/audit.json json_audit;
  • 转发至远程 syslog(适合集中审计):
access_log syslog:server=192.168.1.100:514,facility=local7,tag=nginx-audit json_audit;

若使用 systemd-journald,也可通过 syslog 协议接入,便于与 SIEM 工具(如 ELK、Splunk)对接。

增强审计完整性:捕获请求体与响应头(谨慎使用)

标准变量无法直接记录请求体($request_body)或响应头($sent_http_*),需额外配置:

  • 记录请求体需开启 client_body_in_file_only on 或使用 lua-resty-logger-socket 等模块,但注意性能与隐私风险(如密码、token);
  • 记录自定义响应头(如 X-Request-ID)可用 $sent_http_x_request_id;
  • 记录上游服务返回的状态码(非 Nginx 自身状态)可用 $upstream_http_x_backend_status(需后端配合输出)。

不建议在高并发场景下无条件记录请求体,应结合条件日志(if=$condition)仅对特定路径或错误状态启用。

验证与排错要点

生成的日志必须每行一个合法 JSON 对象(JSON Lines 格式),否则下游解析器会失败。检查方法:

  • 用 jq -R 'fromjson' /var/log/nginx/audit.json | head -5 验证前几行是否解析成功;
  • 观察是否有 null 字段未被引号包裹(如 "http_x_forwarded_for":null 不合法,应为 "http_x_forwarded_for":"");
  • 若字段为空,Nginx 默认输出空字符串,escape=json 会将其转为 "",符合 JSON 规范;
  • 避免在 log_format 中使用未定义变量(如错写 $http_x_real_ip 而实际传的是 X-Forwarded-For),会导致字段缺失或空值。

不复杂但容易忽略。

相关文章

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

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

下载

相关标签:

js json nginx

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习