0

0

logging.handlers.SysLogHandler 如何配置 RFC5424 格式

冷漠man

冷漠man

发布时间:2026-01-26 19:50:01

|

981人浏览过

|

来源于php中文网

原创

Python标准库SysLogHandler默认仅支持RFC3164,需手动构造含PRI、VERSION、ISO时间戳、HOSTNAME、BOM等的完整RFC5424消息体;rsyslog接收端须禁用传统解析模式并使用%rawmsg%模板;生产环境推荐python-syslog-ng等专用库。

logging.handlers.sysloghandler 如何配置 rfc5424 格式

默认不支持 RFC5424,必须手动构造消息头

logging.handlers.SysLogHandler 是 Python 标准库中轻量级的 Syslog 发送器,但它**原生只按 RFC3164 格式拼接日志**(例如 Jul 10 12:00:00 hostname app[123]: msg),完全不生成 RFC5424 要求的版本号、ISO 时间戳、结构化数据字段或 BOM。即使你设了 socktype=socket.SOCK_STREAM 或指定 port=6514,它发出去的仍是 RFC3164 风格文本——接收端(如 rsyslog、Logstash)若严格校验 RFC5424,会直接丢弃或解析失败。

绕过限制:用 Formatter 拼出完整 RFC5424 字符串

核心思路是:把整个 RFC5424 消息体(含 PRI、VERSION、TIMESTAMP、HOSTNAME 等)提前组装好,再交给 SysLogHandler 当作纯字符串发送。关键点在于自己补全所有 mandatory 字段:

  • PRI:计算为 facility * 8 + severity,例如 Facility.LOCAL4 = 20INFO = 620*8+6 = 166 → 写成 <166>
  • VERSION:固定写 1
  • TIMESTAMP:必须用 %Y-%m-%dT%H:%M:%S%z(注意不是 %Z),且需处理时区偏移(如 +0800);datetime.now().astimezone().isoformat() 可直接产出带 Z+xx:xx 的格式
  • HOSTNAME:不能为 None,建议用 socket.gethostname() 或硬编码
  • APP-NAMEPROCIDMSGID:RFC5424 允许填 - 表示缺失,但部分接收端(如 Azure Monitor)要求非空,可填占位符如 "python""1""-"
  • STRUCTURED-DATA:可填 -,或按 [example@12345 key="value"] 格式构造
  • MSG:必须以 UTF-8 BOM(\xEF\xBB\xBF)开头,否则接收端可能解码失败

示例 Formatter 实现片段:

class RFC5424Formatter(logging.Formatter):
    def format(self, record):
        pri = f"<{record.facility * 8 + record.levelno}>"
        timestamp = datetime.now().astimezone().isoformat(timespec='seconds')
        hostname = socket.gethostname()
        appname = getattr(record, 'appname', 'python')
        procid = str(getattr(record, 'procid', os.getpid()))
        msgid = getattr(record, 'msgid', '-')
        sd = getattr(record, 'structured_data', '-')
        # 注意:BOM 必须在 MSG 前,且整个 MSG 部分要 UTF-8 编码
        msg_body = f"{getattr(record, 'msg', '')}"
        if not isinstance(msg_body, bytes):
            msg_body = msg_body.encode('utf-8')
        full_msg = f"{pri}1 {timestamp} {hostname} {appname} {procid} {msgid} {sd} \xEF\xBB\xBF{msg_body.decode('utf-8')}"
        return full_msg

rsyslog 接收端必须禁用自动解析,否则会二次转义

如果你用 rsyslog 接收 Python 发来的 RFC5424 消息,切记:不要启用 imtcp$InputTCPServerRunTraditionalForwarderMode on(即传统模式)。该模式会强制将收到的原始字节流当作 RFC3164 解析,再重新封装成 RFC5424 —— 导致时间戳重复、BOM 被当普通字符、结构化数据丢失。正确做法是:

Amazon Nova
Amazon Nova

亚马逊云科技(AWS)推出的一系列生成式AI基础模型

下载
  • /etc/rsyslog.d/50-python.conf 中启用纯转发模式:$InputTCPServerStreamDriverMode 1(启用 TLS 时)或显式关闭传统模式
  • 使用 template 直接取 %rawmsg% 字段,避免任何中间解析:template(name="RawRFC5424" type="string" string="%rawmsg%\n")
  • 确认 rsyslog 版本 ≥ v8.2001(旧版对 RFC5424 支持不全)

更稳妥的选择:换用第三方库而非硬刚标准库

硬改 SysLogHandler 容易漏掉边界情况(比如多行日志截断、特殊字符转义、BOM 位置错乱)。生产环境建议直接用专为 RFC5424 设计的库:

  • python-syslog-ng:底层调用 syslog-ng C 库,原生支持 RFC5424 和 TLS
  • rsyslog-python:官方维护,与 rsyslog 配置深度集成
  • 自己封装 socket.sendall() + 手动构造(比改 Formatter 更可控,尤其适合高吞吐场景)

RFC5424 的坑不在“怎么发”,而在“发完对方认不认”——务必用 tcpdump -A port 6514 抓包,逐字核对是否真有 <166>1 2026-01-26T15:49:00+08:00 ... \xEF\xBB\xBF... 这种结构。少一个空格、错一位时区、缺一个 BOM,都可能导致整条链路静默丢日志。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1051

2023.08.02

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1229

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1205

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

193

2025.07.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号