11.3.3 分散トレース機能の使用
- 〈この項の構成〉
(1) 分散トレース機能の設定
分散トレース機能を使用する場合、使用する分散トレース収集サービスによって異なるライブラリを組み込む必要があります。
ライブラリの組み込み方法については、「2.2.15 分散トレース機能の設定」を参照してください。
- 重要
-
分散トレース機能で付与するヘッダ
HMP-PCTOでは、Spanの親子関係やサンプリング有無などの情報を各コンポーネントに伝搬させるために、ほかのコンポーネントへのリクエストに特定のヘッダを付与することで、分散トレーシングを実現します。
なお、ヘッダの情報が変更されると、正しい情報が伝搬できなくなります。そのため、ほかの製品で同様のヘッダが付与されないようにしてください。
付与するヘッダを次に示します。
-
ヘッダ名がtraceparentの場合
トレースID、スパンID、およびサンプリング有無が付与されます。
-
ヘッダ名がtracestateの場合
OpenTelemetry固有のデータが付与されます。
-
(2) 分散トレースの送信に失敗したとき
(a) 分散トレース送信失敗時の検知、および分散トレース機能の抑止について
HMP-PCTOで、分散トレースを定期的に分散トレース収集アプリケーションまたはサービスに送信しますが、エンドポイントが機能していない、送信先エンドポイントのパラメタ指定値が誤っている、などの要因で送信に失敗した場合、OpenTelemetryは警告メッセージを標準出力に出力します。このため、標準出力には定期的に警告メッセージが出力されることになります。
ユーザの運用での対処として、分散トレース収集アプリケーションまたはサービスへの送信失敗時の警告メッセージが、標準出力に出力されているかどうかを確認します。警告メッセージが出力されていた場合は、送信先定義を見直し、分散トレース収集アプリケーションまたはサービスが正常起動していることを確認してください。詳細については、「11.6 HMP-PCTOの障害調査」を参照してください。
(b) 分散トレース送信失敗時、トレース情報を一時的に別の出力先に変更することについて
「(a) 分散トレース送信失敗時の検知、および分散トレース機能の抑止について」にあるとおり、ユーザが運用で対処して分散トレース送信失敗を回復する必要があるため、HMP-PCTOではトレース情報の出力先を別の出力先に切り替えません。
そのため、ユーザが運用で対処するまでは、分散トレースを永続化するための収集アプリケーションまたはサービスにトレース情報が送信されず、トレース情報がロストするため注意してください。