1.4. OpenTracing を使用する APIcast の設定

OpenTracing は API の仕様で、マイクロサービスのプロファイリングおよびモニターリングに使用されるメソッドです。バージョン 3.3 以降の APIcast には、OpenTracing ライブラリーおよび Jaeger Tracer ライブラリー が含まれています。

前提条件

  • それぞれの外部リクエストに、固有のリクエスト ID がアタッチされている。通常、これには HTTP ヘッダーが使用されます。
  • それぞれのサービスがリクエスト ID を他のサービスに転送する。
  • それぞれのサービスがリクエスト ID をログに出力する。
  • それぞれのサービスがリクエストの開始/終了時刻等の補足情報を記録する。
  • ログが集約され、HTTP リクエスト ID を使用して解析する手段を提供する。

手順

  1. OPENTRACING_TRACER 環境変数が jaeger に設定されるようにします。この変数が空欄の場合には、OpenTracing は無効になります。
  2. OPENTRACING_CONFIG 環境変数を設定して、使用するトレーサーのデフォルト設定ファイルを指定します。例として、以下の jaeger.example.json ファイルを参照してください。
  3. (オプション) 実際の OpenTracing 設定に応じて、OPENTRACING_HEADER_FORWARD 環境変数を設定します。

検証

インテグレーションが適切に機能しているかどうかをテストするには、トレースが Jaeger トレースインターフェイスで報告されるかどうかを確認します。