Nginx网关指南:利用Log_format自定义JSON格式对接ELK

陌丽小哥_4769

陌丽小哥_4769

2026-03-23

946人浏览

原创

Nginx 原生支持 JSON 日志输出,关键在于正确配置 log_format:需满足单行合法 JSON、字段名统一语义清晰、空值及特殊字符安全转义;推荐模板含时间戳、分层 IP、数值不加引号等容错设计,并配合 escape=json、缓冲日志及 Filebeat/Logstash 轻量解析。

nginx网关指南:利用log_format自定义json格式对接elk

想让 Nginx 的访问日志以标准 JSON 格式输出,直接被 Logstash 或 Filebeat 采集进 Elasticsearch?关键不在加插件,而在正确配置 log_format —— 它原生支持转义、变量拼接和结构化输出,配合合理的字段命名和空值处理,就能无缝对接 ELK。

JSON 日志格式必须满足的三个前提

ELK 链路对日志格式有隐性要求,仅“看着像 JSON”不够:

  • 单行完整 JSON:每条日志必须是独立、合法、无换行的 JSON 对象(不能是 JSON Array,也不能跨行)
  • 字段名统一且语义清晰:比如用 client_ip 而非 remote_addr,避免 Logstash 中反复重命名
  • 空值/特殊字符安全转义:URL、User-Agent 中的引号、换行、控制字符必须被正确转义,否则 JSON 解析失败

推荐的 log_format JSON 模板(含容错处理)

以下配置已通过 Logstash json codec 和 Filebeat json.parse 验证,兼容主流 ELK 版本:

log_format json '{"@timestamp":"$time_iso8601",'
                  '"client_ip":"$http_x_forwarded_for",' 
                  '"real_client_ip":"$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",'
                  '"upstream_addr":"$upstream_addr"}';

说明与建议:

  • 时间戳用 $time_iso8601:ELK 默认识别该格式,无需 Logstash date filter 额外解析
  • IP 字段分层设计:区分代理透传的 $http_x_forwarded_for 和真实连接的 $remote_addr,便于溯源
  • 数值字段不加引号:如 status、body_bytes_sent 直接输出数字,ES 自动映射为 long 类型
  • 字符串字段统一双引号包裹:Nginx 会自动转义内部引号,但需确保变量本身不含未转义换行($request_uri 和 $http_user_agent 通常安全)

关键配置项补充(避免日志丢失或解析中断)

仅定义 log_format 不够,还需在 server 或 http 块中启用:

  • 使用 access_log /var/log/nginx/access-json.log json buffer=64k flush=5s;:开启缓冲提升性能,5 秒强制刷盘防丢日志
  • 添加 escape=json;(Nginx ≥ 1.11.8):显式声明 JSON 转义,更安全处理特殊字符
  • 若后端服务可能返回空 upstream_response_time,改用 "$upstream_response_time"(带引号)并设默认值:map $upstream_response_time $upstream_resp_time { "" "-"; },再在 log_format 中引用 $upstream_resp_time

Logstash 或 Filebeat 端最小化配置示例

无需复杂 filter,轻量接入即可:

  • Filebeat(推荐):在 filebeat.inputs 中设置 json.keys_under_root: true 和 json.overwrite_keys: true,自动展开字段
  • Logstash:input 使用 file 插件 + codec json,无需额外 filter { json { } },避免重复解析
  • ES 索引模板中提前定义 @timestamp 为 date 类型,其他数值字段设为 long 或 float,防止动态映射出错
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

4147

6

nginx配置详解
nginx配置详解

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

2023.08.04

7025

6

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

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

2024.02.23

601

5

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

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

2024.07.09

1516

5

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

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

2024.08.07

3998

3

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

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

2026.01.13

122

12

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

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

2026.01.13

577

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

179

12

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习