RFC 5424 - Syslog 协议

发布日期: 2009年3月
状态: 标准跟踪协议 (Standards Track)
作者: R. Gerhards (Adiscon GmbH)
废弃: RFC 3164

---

摘要 (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 Message Format (Syslog 消息格式)
  • 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 Considerations (IANA 考虑)
  • 9.1. VERSION (版本)
  • 9.2. SD-IDs (结构化数据标识符)
• 10. Working Group (工作组)
• 11. Acknowledgments (致谢)
• 12. References (参考文献)
  • 12.1. Normative References (规范性参考文献)
  • 12.2. Informative References (信息性参考文献)

附录 (Appendix)

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

---

相关资源

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

---