RFC 5424 - Syslog 协议

• 状态: Proposed Standard
• 发布日期: March 2009
• Stream: IETF
• 废弃了: RFC3164
• 勘误: 无勘误

---

摘要 (Abstract)

本文档描述了 Syslog 协议 (Syslog Protocol),该协议用于传递事件通知消息.该协议采用分层架构 (Layered Architecture),允许使用任意数量的传输协议来传输 Syslog 消息.它还提供了一种消息格式 (Message Format),允许以结构化方式提供供应商特定的扩展 (Vendor-Specific Extensions).

本文档在编写时考虑了传统 Syslog 的原始设计目标.之所以需要新的分层规范,是因为可靠和安全的 Syslog 扩展的标准化工作受到缺乏标准跟踪和传输无关的 RFC 的限制.如果没有本文档,每个其他标准都需要定义自己的 Syslog 数据包格式和传输机制,随着时间的推移将引入微妙的兼容性问题.本文档试图提供一个基础,使 Syslog 扩展可以在此基础上构建.这种分层架构方法还提供了一个坚实的基础,允许为每个 Syslog 功能编写一次代码,而不是为每个传输编写一次.

本文档废弃了 RFC 3164.

---

目录 (Table of Contents)

• 1. 简介 (Introduction)
• 2. 本文档使用的约定 (Conventions Used in This Document)
• 3. 定义 (Definitions)
• 4. 基本原则 (Basic Principles)
  • 4.1. 示例部署场景 (Example Deployment Scenarios)
• 5. 传输层协议 (Transport Layer Protocol)
  • 5.1. 最小必需传输映射 (Minimum Required Transport Mapping)
• 6. Syslog 消息格式 (Syslog Message Format)
  • 6.1. 消息长度 (Message Length)
  • 6.2. HEADER (报文头)
    • 6.2.1. PRI (优先级)
    • 6.2.2. VERSION (版本)
    • 6.2.3. TIMESTAMP (时间戳)
    • 6.2.4. HOSTNAME (主机名)
    • 6.2.5. APP-NAME (应用名称)
    • 6.2.6. PROCID (进程ID)
    • 6.2.7. MSGID (消息ID)
  • 6.3. STRUCTURED-DATA (结构化数据)
    • 6.3.1. SD-ELEMENT (结构化数据元素)
    • 6.3.2. SD-ID (结构化数据标识符)
    • 6.3.3. SD-PARAM (结构化数据参数)
    • 6.3.4. 变更控制 (Change Control)
    • 6.3.5. 示例 (Examples)
  • 6.4. MSG (消息体)
  • 6.5. 示例 (Examples)
• 7. 结构化数据标识符 (Structured Data IDs)
  • 7.1. timeQuality (时间质量)
    • 7.1.1. tzKnown (时区已知)
    • 7.1.2. isSynced (是否同步)
    • 7.1.3. syncAccuracy (同步精度)
    • 7.1.4. 示例 (Examples)
  • 7.2. origin (来源)
    • 7.2.1. ip (IP地址)
    • 7.2.2. enterpriseId (企业标识符)
    • 7.2.3. software (软件)
    • 7.2.4. swVersion (软件版本)
    • 7.2.5. 示例 (Example)
  • 7.3. meta (元数据)
    • 7.3.1. sequenceId (序列ID)
    • 7.3.2. sysUpTime (系统运行时间)
    • 7.3.3. language (语言)
• 8. 安全考虑 (Security Considerations)
  • 8.1. UNICODE (统一码)
  • 8.2. 控制字符 (Control Characters)
  • 8.3. 消息截断 (Message Truncation)
  • 8.4. 重放 (Replay)
  • 8.5. 可靠传输 (Reliable Delivery)
  • 8.6. 拥塞控制 (Congestion Control)
  • 8.7. 消息完整性 (Message Integrity)
  • 8.8. 消息监测 (Message Observation)
  • 8.9. 不当配置 (Inappropriate Configuration)
  • 8.10. 转发循环 (Forwarding Loop)
  • 8.11. 负载考虑 (Load Considerations)
  • 8.12. 拒绝服务 (Denial of Service)
• 9. IANA 考虑 (IANA Considerations)
  • 9.1. VERSION (版本)
  • 9.2. SD-IDs (结构化数据标识符)
• 10. 工作组 (Working Group)
• 11. 致谢 (Acknowledgments)
• 12. 参考文献 (References)
  • 12.1. 规范性参考文献 (Normative References)
  • 12.2. Informative References (信息性参考文献)

附录 (Appendix)

• 附录 A. 实施者指南 (Implementer Guidelines)
  • A.1. 与 BSD Syslog 的关系 (Relationship with BSD Syslog)
  • A.2. 消息长度 (Message Length)
  • A.3. 严重性值 (Severity Values)
  • A.4. TIME-SECFRAC 精度 (TIME-SECFRAC Precision)
  • A.5. 名称大小写约定 (Case Convention for Names)
  • A.6. 不知道时间的 Syslog 应用程序 (Syslog Applications Without Knowledge of Time)
  • A.7. 关于 timeQuality SD-ID 的说明 (Notes on the timeQuality SD-ID)
  • A.8. UTF-8 编码和 BOM (UTF-8 Encoding and the BOM)

---

相关资源

• RFC 文本: RFC 5424
• 官方页面: RFC 5424 DataTracker
• 勘误表: RFC Editor Errata

---