自己オブザーバビリティ 補足ガイドライン

この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/otel/self-observability-supplementary-guidelines/

翻訳元: open-telemetry/opentelemetry-specification v1.60.0（コミット 29ae8c7）

注記: この文書は仕様ではありません。自己オブザーバビリティ仕様を補うために提供されるものであり、既存の仕様に何ら追加の要求事項を加えるものではありません。

シグナルの範囲とライフサイクルの順序

SDKの自己オブザーバビリティは現在、SDK自己オブザーバビリティメトリクスセマンティック規約で定義されている通り、主にメトリクスとして表現されています。この設計は本質的にメトリクスだけに限定されるものではありません。SDK内部を記述するイベントやスパンが、将来のセマンティック規約によって追加される可能性があるため、SDKの実装者は、この表面が今後もメトリクスの形のままであると仮定すべきではありません。

複数のシグナルが関わるようになると、ライフサイクルの順序が問題になります。記録を担うプロバイダー（MeterProvider、LoggerProvider、場合によってはTracerProvider）は個別に構築・シャットダウンされるため、2番目に構築されるプロバイダーは、1番目のプロバイダーのセットアップ中に生成されたテレメトリーを受け取れません。同様に、あるプロバイダーがシャットダウンされると、他のプロバイダーがまだ終了処理中であっても、そのプロバイダーはテレメトリーをそれ以上受け取れなくなります。

例えば、起動時には以下のようになります。

• MeterProviderが最初に構築される場合、そのセットアップ中に生成される自己オブザーバビリティのイベントは、LoggerProviderがまだ存在しないため、LoggerProviderを通じてはまだ流せません。
• LoggerProviderが最初に構築される場合、そのセットアップ中に生成される自己オブザーバビリティのメトリクスは、MeterProviderを通じてはまだ流せません。

どのような順序にしても、この問題を完全には回避できません。「2番目」に立ち上がるプロバイダーは、自身が存在する前の期間を失い、「最初」にシャットダウンされるプロバイダーは、自身が消えた後の期間を失います。したがって、SDKのライフサイクルの端に位置する自己オブザーバビリティのテレメトリーは、本質的にベストエフォートであり、その扱い方の方針はSDKに委ねられます。

自己オブザーバビリティのイベントに特化した話として、SDKが既に非OpenTelemetry経路（その言語のネイティブなロギング機構、よく使われるエコシステムのロギングライブラリ（RustのTokioのtracingクレートなど）、あるいは最も単純な場合にはstdout/stderrへの直接書き込み）で診断情報を出力しているなら、その経路は、LoggerProviderがインストールされる前や、シャットダウンされた後に発生するイベントにとって自然な選択肢になります。この経路は通常、プロセスの生存期間全体で利用可能であり、失敗しうる外部依存もほとんどありません。

そのようなイベントであっても、そのイベント名は必要です。その仕組みにネイティブなイベント名フィールドがあれば（.NETのILoggerやRustのtracingにはあります）それを使い、なければ、安定版のotel.event.name属性として運びます。この属性は、CollectorやバックエンドによってLogRecordのEventNameに対応付けることができます。

自己オブザーバビリティ用のMeter・Loggerの取得

SDKが自己オブザーバビリティのテレメトリーを発行するために使うMeter・Loggerを取得する方法には、大きく異なる2つの方式があります。

• グローバルプロバイダーから取得する方法（例: GlobalMeterProvider.Get(...)）。この場合、自己オブザーバビリティのデータは、ユーザーの他のテレメトリーと同じパイプラインを流れます。これは実装が最も簡単で、追加の設定を必要としません。トレードオフは、ユーザーがSDKの自己オブザーバビリティだけを別に振り分けにくくなることと、SDKが自身のパイプラインへテレメトリーを発行することになるため、テレメトリーがテレメトリーを誘発する懸念がより重要になることです。
• ユーザーから明示的に（通常は専用の設定オプションを通じて）渡されたMeterProvider・LoggerProviderから取得する方法。これにより別パイプラインを使う方式が可能になり、オペレーターはSDKの自己オブザーバビリティを別のバックエンドへ送ったり、異なる保持期間・サンプリングを適用したりできます。トレードオフは、設定面が増えることと、プロバイダーが渡されない場合のフォールバックの判断（グローバルへフォールバックするか、何も発行しないかなど）が必要になることです。

どちらの選択も有効であり、SDKの対象読者と、別経路への振り分けをどれだけ強く実現したいかに依存します。

これら2つの方式は組み合わせることもできます。SDKは、明示的なMeterProvider・LoggerProviderを受け付け、渡されなかった場合はグローバルへフォールバックできます。これは計装ライブラリでよく見られるパターンであり、追加の設定を必要としないユーザーに強制することなく、オペレーターにSDKの自己オブザーバビリティを別経路へ振り分ける選択肢を与えます。

テレメトリー誘発によるテレメトリーループの回避

SDKが自身のテレメトリーパイプラインを通じて自己オブザーバビリティのデータを発行すると、その発行したデータが同じパイプラインによってさらに処理され、フィードバックループを生む可能性があります。これは主にイベントとトレースにおいて問題になります。SDKがイベントやスパンを処理する際に生成する各イベント・スパンが、それ自体さらなるイベント・スパンを生み出し、無制限の再帰につながる可能性があるためです。メトリクスは実際上、この影響を受けにくいです。

このようなループを防ぐためにSDKが使えるパターンには、以下のものがあります。

• 自己オブザーバビリティ用に、ユーザーのパイプラインから分離された専用のLoggerProvider（またはTracerProvider）を使い、自己オブザーバビリティのテレメトリーがそのパイプラインへフィードバックしないようにする。
• OpenTelemetryのContextを使って、コードがSDK自身のパイプライン内で実行されていることを示すフラグを運び、そのフラグが立っているときは自己オブザーバビリティの記録をスキップする。これに関する標準化された仕様は現時点では存在しません（open-telemetry/opentelemetry-specification#530で追跡されています）。その間、複数のSDKが独自にこれを実装しています。
  • .NET: SuppressInstrumentationScope
  • Rust: Context::enter_telemetry_suppressed_scope
  • Python: _SUPPRESS_INSTRUMENTATION_KEY
  • Java: InstrumentationUtil.suppressInstrumentation

自己オブザーバビリティを他のSDK機能と同様の安定性で扱う

SDKの自己オブザーバビリティはSDKの機能の1つであり、他のSDK機能と同じ安定性の保証の対象になります。弱められることも、扱いが異なることもありません。

これには3つの結果が伴います。

1. 開発中または実験的なメトリクス・属性・セマンティクスは、オプトインでなければなりません。
2. 表面の一部が安定版で一部が実験的である場合、安定版の部分だけをデフォルトで有効にし、実験的な部分はオプトインのままにすべきです。
3. 自己オブザーバビリティは「単なる診断データだから」という理由でこれらのルールから免除されません。SDK機能の安定性ルールは一律に適用され、破壊的変更は破壊的変更です。

オプトインをどのように公開するかは各SDKに委ねられています。既存のSDKの例としては以下のものがあります。

• SDKの実験的機能の命名規則を使った環境変数（例えば、OpenTelemetry GoのOTEL_GO_X_OBSERVABILITY）。
• ビルド時のフィーチャーフラグ（例えば、OpenTelemetry Rustにおける実験的なCargoフィーチャー）。