事件的语义约定

状态: 开发中

本文档描述了通过 LogRecord 在数据模型中表示的独立事件的特征。

从语义上讲,事件是发生在某个时间点的命名事件。它表示“某事发生在此时”,并提供有关该事件的额外详细信息。事件的例子可能包括按钮点击、用户注销、网络连接中断等。

在 OpenTelemetry 中,事件作为一种特殊类型的 LogRecord 实现,该类型符合此处包含的约定。

定义事件的 OpenTelemetry 语义约定 SHOULD 文档记录事件名称以及属性和主体类型(如果存在)。

通用事件语义

  • 事件 MUST 具有一个 事件名称属性,该属性唯一标识事件。事件名称受 命名指南 的约束。事件名称 SHOULD 是低基数的。
  • 事件 MAY 具有 属性,这些属性为事件提供其他上下文。
  • 事件 MAY 包含一个类型为 any主体
  • 事件名称唯一标识事件结构:属性集和主体类型。
  • 事件 MAY 具有 严重性级别

建议使用属性集合来表示事件的详细信息。

外部事件兼容性

在将现有系统的事件记录为 OpenTelemetry 事件时,该系统可能缺少单个名称字段或需要多个字段来标识事件。在这种情况下,请使用字段组合来创建低基数的事件名称。