如何在Linux利用Rsyslog的Template模块自定义输出符合ELK采集格式的JSON日志

雨雪酱_2709

雨雪酱_2709

2026-05-10

804人浏览

原创

在linux中用rsyslog输出标准json日志,需启用json-c支持、定义符合elk规范的json类型模板(如使用timereported+rfc3339、format="json"转义message),并正确应用至文件或tcp输出。

如何在linux利用rsyslog的template模块自定义输出符合elk采集格式的json日志

在 Linux 中用 Rsyslog 的 template 模块输出标准 JSON 日志,核心是定义结构化模板并确保字段名、类型和嵌套符合 Logstash 或 Filebeat 的预期(如 @timestamp、host、message 等),同时避免非法字符和格式错误。

确认 Rsyslog 版本并启用 json-c 支持

Rsyslog v8.16+ 原生支持 json 模板类型,但需编译时启用了 libjson-c。运行以下命令验证:

$ rsyslogd -v | grep -i json

若无输出或提示 no json support,需重装带 json 支持的版本(如 Ubuntu/Debian 安装 rsyslog-gnutls 和 libjson-c-dev 后源码编译,或使用官方 PPA)。

编写符合 ELK 规范的 JSON Template

ELK(尤其是 Logstash 的 json codec 或 Filebeat 的 json.keys_under_root: true)期望日志为单行合法 JSON 对象。推荐使用 json 类型模板(非 legacy string 拼接),自动转义、类型推断更可靠:

$template elk_json,"{\"@timestamp\":\"%TIMESTAMP:::date-rfc3339%\",\"host\":\"%HOSTNAME%\",\"program\":\"%PROGRAMNAME%\",\"pid\":\"%PROCID%\",\"severity\":\"%syslogseverity-text%\",\"facility\":\"%syslogfacility-text%\",\"message\":\"%msg%\"}"

更健壮的做法是用 json 模板类型(Rsyslog v8.19+):

$template elk_json, "elk_json", json
$ActionFileDefaultTemplate elk_json

并在 /etc/rsyslog.d/20-elk.conf 中显式声明字段(推荐):

Linux installer
Linux installer

先解析安全源,运行本地CLI安装、启动、卸载Linux桌面应用。用户请求时使用。

下载

template(name="elk_json" type="list") {
  constant(value="{")
  constant(value="\"@timestamp\":\"")
  property(name="timereported" dateFormat="rfc3339")
  constant(value="\",\"host\":\"")
  property(name="hostname")
  constant(value="\",\"program\":\"")
  property(name="programname")
  constant(value="\",\"message\":\"")
  property(name="msg" format="json")
  constant(value="\"}")
}

关键点:

  • property(name="msg" format="json") 自动对 message 内容做 JSON 转义,防止双引号、换行破坏结构
  • timereported 比 timestamp 更准确(含接收时间),且 dateFormat="rfc3339" 输出如 2024-05-22T14:30:45.123Z,Logstash 可直接解析为 @timestamp
  • 避免在 template 中硬编码 \n 或多余空格,保证单行 JSON

将模板应用到日志输出(文件或 TCP)

例如写入本地 JSON 文件供 Filebeat 采集:

if $programname == 'nginx' then {
  action(type="omfile" file="/var/log/nginx/json-access.log" template="elk_json")
  stop
}
# 或转发到 Logstash 的 TCP 端口(需启用 omfwd)
*.* action(type="omfwd" protocol="tcp" target="192.168.1.100" port="5044" template="elk_json")

若走 TCP,确保 Logstash input 配置为:

input {
  tcp {
    port => 5044
    codec => "json"
  }
}

验证与排错要点

生成日志后,立即检查输出是否为合法单行 JSON:

$ tail -n1 /var/log/nginx/json-access.log | python3 -m json.tool

常见问题及修复:

  • 解析失败:Unexpected token → 检查是否有未转义的双引号或控制字符;改用 format="json" 处理 msg
  • @timestamp 为空或格式错误 → 确认用的是 timereported + dateFormat="rfc3339",而非 timestamp
  • 字段缺失(如 host 为 localhost) → 在 /etc/rsyslog.conf 中设置 $LocalHostName your-real-hostname,并重启服务
  • 中文乱码或特殊字符异常 → 确保系统 locale 为 UTF-8(locale | grep UTF),Rsyslog 默认按 UTF-8 处理

重启生效:sudo systemctl restart rsyslog,再用 rsyslogd -N1 检查配置语法。

相关文章

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

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

下载

相关标签:

linux js json

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

相关专题

更多
磁盘配额是什么
磁盘配额是什么

磁盘配额是计算机中指定磁盘的储存限制,就是管理员可以为用户所能使用的磁盘空间进行配额限制,每一用户只能使用最大配额范围内的磁盘空间。php中文网为大家提供各种磁盘配额相关的内容,教程,供大家免费下载安装。

2023.06.21

3950

4

如何安装LINUX
如何安装LINUX

本站专题提供如何安装LINUX的相关教程文章,还有相关的下载、课程,大家可以免费体验。

2023.06.29

3393

10

linux find
linux find

find是linux命令,它将档案系统内符合 expression 的档案列出来。可以指要档案的名称、类别、时间、大小、权限等不同资讯的组合,只有完全相符的才会被列出来。find根据下列规则判断 path 和 expression,在命令列上第一个 - ( ) , ! 之前的部分为 path,之后的是 expression。还有指DOS 命令 find,Excel 函数 find等。本站专题提供linux find相关教程文章,还有相关

2023.06.30

2533

5

linux修改文件名
linux修改文件名

本专题为大家提供linux修改文件名相关的文章,这些文章可以帮助用户快速轻松地完成文件名的修改工作,大家可以免费体验。

2023.07.05

6150

7

linux系统安装教程
linux系统安装教程

linux系统是一种可以免费使用,自由传播,多用户、多任务、多线程、多CPU的操作系统。本专题提供linux系统安装教程相关的文章,大家可以免费体验。

2023.07.06

5782

7

linux查看文件夹大小
linux查看文件夹大小

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。linux怎么查看文件夹大小呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.20

3393

8

linux查看ip命令
linux查看ip命令

本专题为大家提供linux查看ip命令相关文章内容,感兴趣的朋友可以免费下载体验试试。

2023.07.20

2885

4

linux查看cpu使用率
linux查看cpu使用率

在linux的系统维护中,可能需要经常查看cpu使用率,分析系统整体的运行情况。本专题为大家带来了linux查看cpu使用率的相关文章,感兴趣的朋友千万不要错过了。

2023.07.25

3119

6

linux查找文件命令
linux查找文件命令

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.31

297

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习