HTTPに関するセマンティック規約

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

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

ステータス: Mixed

この文書では、HTTPのスパン、メトリクス、ログに関するセマンティック規約を定義します。 これらは、HTTPとHTTPSの両方のスキーム、および1.1、2、SPDYなどさまざまなHTTPバージョンで使用できます。

[!IMPORTANT] この文書のv1.20.0 以前のバージョンを使っている既存のHTTP計装は、次に従うべきです。

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

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

• HTTP Spans: HTTPクライアントとサーバーのスパンに関するセマンティック規約。
• HTTP Metrics: HTTPクライアントとサーバーのメトリクスに関するセマンティック規約。
• HTTP Exceptions: HTTPクライアントとサーバーの例外に関するセマンティック規約。

安定版でない規約から安定版の規約への移行については、移行ガイドを参照してください。

• Exceptions
• HTTPメトリクスに関するセマンティック規約
• Spans