10.3.3 Spanへ付加する情報
Spanに付加する情報の形式について説明します。付加する情報の形式は3パターンあります。
- 〈この項の構成〉
(1) Tags
次のkey(情報名)、value(情報値)の形式で情報を取得します。JaegerのWeb UIでTagsの情報名、情報値を指定することで表示するトレースIDをフィルタできます。時間情報を必要としない情報の場合に、Tagsに設定します。
例:受信した要求電文に含まれていたブランチXIDなど
(2) Logs
次のLogs形式1、2どちらかの形式で情報を取得します。Span内での処理の実施時刻を取得でき、Span内で遅延した処理の確認などに使用できます。時間情報を必要とする場合にLogsに設定します(例:I/O開始、終了時刻など)。messageに対し、処理ごとの情報説明を設定します。情報説明には、対象情報がどのようなイベントかを設定します(ファイルI/O開始など)。
情報説明に加えてkey(情報名)、value(情報値)の形式で情報追加したい場合は、Logs形式2で情報を取得します。追加情報が不要であれば、Logs形式1で取得します。
情報名と情報値を設定する場合に、TagsとLogs形式2の使い分けについて説明します。
対象イベントだけに関わる情報の場合はLogs形式2へ、対象Span全体に関わる情報の場合はTagsに設定します。例えば、あるSpan内でファイルI/Oする場合に、スレッド名やブランチXIDなどSpan全体に関わる情報はTagsに、ファイルI/Oの結果はLogs形式2に設定します。
(3) Process
次のkey(情報名)、value(情報値)の形式でプロセスに関する情報を取得します。JaegerのWeb UIでProcessの情報名、情報値を指定することで表示するトレースIDをフィルタできます。