Nginx可通过log_format手动构造合法JSON日志,需对字符串字段加双引号、数值字段不加引号,并转义特殊字符;推荐用map预处理$remote_addr等高危变量,配合access_log启用,每行一个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 启用该格式:
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) - 若报错,重点检查双引号是否成对、末尾逗号是否多余、数值字段是否误加引号


















