如何利用 json 格式化输出 Nginx 日志以实现与 Filebeat 的无缝采集对接

秋宇同学_6323

秋宇同学_6323

2026-05-04

810人浏览

原创

关键是从 nginx 侧直接输出结构化 json 日志,通过 log_format 拼接合法 json 字符串并启用 access_log json 格式;filebeat 需配置 json.enabled: true、keys_under_root: true 及 timestamp_key 等参数以正确解析字段。

如何利用 json 格式化输出 nginx 日志以实现与 filebeat 的无缝采集对接

要让 Nginx 日志能被 Filebeat 高效、准确地采集并送入 Elasticsearch 或 Logstash,关键不是“先输出再格式化”,而是**从 Nginx 侧直接输出结构化的 JSON 日志**。Filebeat 本身不解析非结构化文本(如默认的 `combined` 日志),它依赖日志内容本身具备字段边界——而 JSON 天然满足这点。

配置 Nginx 输出原生 JSON 日志

Nginx 不支持直接写 JSON,但可通过 log_format 拼接合法 JSON 字符串。需注意转义、空格、引号和字段完整性:

  • 使用双引号包裹键名和字符串值,用 \ 转义内部双引号(如 $request 可能含引号)
  • 对可能为空的变量(如 $http_x_forwarded_for)用 "-" 或 null 占位,保持 JSON 合法性
  • 时间建议统一用 $time_iso8601,避免时区歧义

示例配置(放入 http 块):

log_format json '{"@timestamp":"$time_iso8601",'
                  '"host":"$server_addr",'
                  '"clientip":"$remote_addr",'
                  '"method":"$request_method",'
                  '"url":"$uri",'
                  '"status":$status,'
                  '"bytes":$body_bytes_sent,'
                  '"referer":"$http_referer",'
                  '"useragent":"$http_user_agent",'
                  '"request_time":$request_time,'
                  '"upstream_time":"$upstream_response_time"}';

然后在 server 或 location 中启用:
access_log /var/log/nginx/access.json json;

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载

确保 Filebeat 正确识别 JSON 行并解析字段

Filebeat 默认把每行当纯文本。要让它把整行当作 JSON 解析,需启用 json.keys_under_root: true,并关闭默认的行首检测(避免误判为普通日志):

  • 在 Filebeat 的 filebeat.inputs 中指定日志路径,并设置 json.enabled: true
  • 添加 json.keys_under_root: true 将 JSON 字段提升到根层级,便于 Kibana 过滤
  • 推荐加 json.add_error_key: true,便于排查解析失败的日志行

示例 input 配置片段:

- type: filestream
  enabled: true
  paths:
    - /var/log/nginx/access.json
  json.enabled: true
  json.keys_under_root: true
  json.add_error_key: true
  json.message_key: "@timestamp"
  fields:
    service: nginx
    log_type: access

处理常见问题:空字段、嵌套与时间解析

原始 JSON 日志虽结构清晰,但仍有细节影响下游使用:

  • 空字段或非法值:Nginx 变量如 $upstream_response_time 在无 upstream 时为空字符串,JSON 中应写成 "upstream_time":"-" 或预处理为 "null";Filebeat 无法自动将字符串 "-" 转为 null,建议在 Logstash 或 Ingest Pipeline 中清洗
  • 嵌套字段需求:若需将 clientip 和 useragent 归入 client 对象,Nginx 侧无法直接生成嵌套 JSON,应在 Filebeat 的 processors 中用 rename + dissect 或交由 Logstash 处理
  • @timestamp 识别:Filebeat 默认用读取时间作为 @timestamp。要使用日志中的 @timestamp 字段,需在 input 中设 json.timestamp_key: "@timestamp" 并指定格式:json.timestamp_format: "2006-01-02T15:04:05-07:00"

验证与调试建议

上线前务必验证 JSON 合法性与字段可用性:

  • 用 tail -n 1 /var/log/nginx/access.json | jq . 检查单行是否为有效 JSON
  • 在 Filebeat 启动时加 -e -d "publish" 查看实际发送到 ES 的文档结构
  • Kibana 中检查索引中字段类型:数字字段(如 status、bytes)应为 long 或 float,而非 text;若为 text,说明 Filebeat 未成功解析或 ES mapping 已固化,需清理测试索引重试

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3667

6

nginx配置详解
nginx配置详解

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

2023.08.04

6425

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

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

共39课时 | 4.9万人学习