HTTP 的语义约定

状态: 混合

本文档定义了 HTTP 跨度、指标和日志的语义约定。它们可用于 http 和 https 方案以及各种 HTTP 版本,如 1.1、2 和 SPDY。

警告 现有使用 本文档 v1.20.0(或更早版本)的 HTTP 仪表化

  • 在 HTTP 语义约定被标记为稳定之前,**不应**更改其默认发出的 HTTP 或网络约定版本(HTTP 稳定化将包括一组核心网络约定(也用于 HTTP 仪表化)的稳定化)。约定包括但不限于属性、指标和跨度名称以及度量单位。
  • 在现有主版本中,应引入一个名为 OTEL_SEMCONV_STABILITY_OPT_IN 的环境变量,该变量是一个逗号分隔的类别特定值列表(例如,http、databases、messaging)。值列表包括:
    • http - 发出新的、稳定的 HTTP 和网络约定,并停止发出仪表化先前发出的旧的实验性 HTTP 和网络约定。
    • http/dup - 同时发出旧的和稳定的 HTTP 和网络约定,实现无缝过渡。
    • 默认行为(如果没有指定这些值之一)是继续发出仪表化先前发出的旧的实验性 HTTP 和网络约定版本。
    • 注意:如果同时存在这两个值,http/dup 的优先级高于 http
  • 在开始发出两组约定后,应至少维护现有主版本(至少进行安全修补)六个月。
  • 应在下一个主版本中删除该环境变量。

HTTP 的语义约定针对以下信号定义

  • HTTP 跨度:HTTP 客户端和服务器跨度的语义约定。
  • HTTP 指标:HTTP 客户端和服务器指标的语义约定。

有关从非稳定约定迁移到稳定约定的帮助,请参阅 迁移指南