Yoshi Yamaguchi

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

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

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

ステータス: Stable

[!IMPORTANT]

例外をスパンイベントとして記録している既存の計装は、次に従うべきです。

  • 次の値をサポートする環境変数 OTEL_SEMCONV_EXCEPTION_SIGNAL_OPT_IN を導入すべきです（SHOULD）。
    • logs - 例外をログのみとして発行します。
    • logs/dup - スパンイベントとログの両方を発行し、段階的な移行を可能にします。
    • これらの値がいずれも指定されていない場合のデフォルトの動作は、例外をスパンイベントとして発行し続けることです（既存の動作）。
  • 両方の規約セットを発行し始めてから少なくとも6か月間は、既存のメジャーバージョンを（少なくともセキュリティパッチの適用という形で）維持すべきです（SHOULD）。
  • 次のメジャーバージョンでは、この環境変数を削除し、例外をログのみとして発行してもかまいません（MAY）。

計装が例外をログのみとして発行するようになった後も、ユーザーはSDK層でそれらをスパンイベントにルーティングするオプションを持ち続けます。

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

  • Exceptions on spans: スパン上に記録される例外に関するセマンティック規約（非推奨）。
  • Exceptions in logs: ログに記録される例外に関するセマンティック規約。