メッセージングシステムに関するセマンティック規約

この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/messaging/

翻訳元: open-telemetry/semantic-conventions v1.44.0(コミット e10a930

ステータス: Development

この文書では、メッセージングシステムのスパン・メトリクス・ログに関するセマンティック規約を定義します。

[!IMPORTANT]

この文書のv1.24.0 以前のバージョンを使っている既存のメッセージング計装は、次に従うべきです。

  • メッセージングセマンティック規約が安定版として宣言されるまで、デフォルトで発行するメッセージング規約のバージョンを変更してはなりません(SHOULD NOT)。 規約には、属性、メトリクス名、スパン名、スパン種別、計測単位などが含まれますが、これらに限定されません。
  • 既存のメジャーバージョンにおいて、カテゴリー別の値をカンマ区切りで列挙するリストとして環境変数 OTEL_SEMCONV_STABILITY_OPT_IN を導入すべきです(SHOULD) (例: http、databases、messaging)。値の一覧は次のとおりです。
    • messaging - 新しい安定版のメッセージング規約を発行し、それまで計装が発行していた古い実験的なメッセージング規約の発行を停止します。
    • messaging/dup - 古い規約と安定版の規約の両方を発行し、円滑な移行を可能にします。
    • これらの値がいずれも指定されていない場合のデフォルトの動作は、その計装がそれまで発行していた古い実験的なメッセージング規約のバージョンをそのまま発行し続けることです。
    • 注記: 両方の値が指定されている場合、messaging/dupmessaging よりも優先されます。
  • 両方の規約セットを発行し始めてから少なくとも6か月間は、既存のメジャーバージョンを(少なくともセキュリティパッチの適用という形で)維持すべきです(SHOULD)。
  • 次のメジャーバージョンでは、この環境変数を削除すべきです(SHOULD)。
  • messaging/dup がリストに含まれる場合、スパン名・スパン種別のような「単一の」値を持つ概念については、新しい安定版の値を発行すべきです(SHOULD)。

メッセージングシステムに関するセマンティック規約は、次のシグナルについて定義されています。

  • Messaging Spans: メッセージングスパンに関するセマンティック規約。
  • Messaging Metrics: メッセージングメトリクスに関するセマンティック規約。
  • Messaging Exceptions: メッセージング例外に関するセマンティック規約。

技術固有のセマンティック規約は、次のメッセージングシステムについて定義されています。

  • Kafka: Apache Kafkaに関するセマンティック規約。
  • RabbitMQ: RabbitMQに関するセマンティック規約。
  • RocketMQ: Apache RocketMQに関するセマンティック規約。
  • SNS: Amazon SNSに関するセマンティック規約。
  • SQS: Amazon SQSに関するセマンティック規約。
  • Google Cloud Pub/Sub: Google Cloud Pub/Subに関するセマンティック規約。
  • Azure Service Bus: Azure Service Busに関するセマンティック規約。
  • Azure Event Hubs: Azure Event Hubsに関するセマンティック規約。