旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

トレースリファレンス

このリファレンスでは、Kong Gateway の OpenTelemetry トレース機能について説明します。

重要 : OpenTelemetryトレースは、非推奨の Granular トレース機能に代わるものです。Granular トレースは 3.7.0.0 以降の Kong Gateway から削除され、tracing = on などの構成は使用できなくなりました。その代替として、このページで説明する OpenTelemetryトレースを使用します。

コア計測

次の計測は、KongのトレーシングAPI上に構築された任意のプラグインで使用できます。OpenTelemetryプラグインはその一例です。

Kongはトレース用のコア計測のセットを提供しており、これらはtracing_instrumentations構成で構成できます。

off: 計測を有効にしません。
request: リクエストレベルの計測のみを有効にします。
all：すべてのインストルメンテーションを有効にします。
db_query：データベースクエリをトレースします。
dns_query: DNSクエリをトレースします。
router：ルーターの再構築を含む、ルーターの実行をトレースします。
http_client: OpenResty HTTPクライアントリクエストをトレースします。
balancer: トレースバランサーの再試行。
plugin_rewrite: リライトフェーズでプラグインのイテレータ実行をトレースします。
plugin_access: アクセスフェーズでプラグインのイテレータ実行をトレースします。
plugin_header_filter: header_filter でプラグインのイテレータ実行をトレースします。

伝搬

トレースAPI は、次のヘッダーの伝播をサポートしています。

トレーシングAPIはヘッダーから伝播形式を検出し、適切な形式を使用してスパンコンテキストを伝播します。適切な形式が見つからない場合は、ユーザーが指定できるデフォルトの形式に戻ります。

伝達 APIは、OpenTelemetry プラグインと Zipkin プラグインの両方で動作します。

ヘッダー

サポートされているすべてのトレースヘッダーについては、kong.confをご覧ください。

X-Kong-Request-Id header

TX-Kong-Request-Idヘッダーには、クライアントのリクエストごとに一意の識別子が含まれています。これはデフォルトで上流と下流の両方で有効になります。この一意な ID は、特定のリクエストを対応するエラーログにマッチさせるのに役立ちます。 Kong Gateway が PDK kong.response.error を呼び出してエラーを返した場合、 Kong Gateway が生成したレスポンスボディにもリクエスト ID が含まれます。さらに、生成された Kong Gateway エラーログには、request_id: xxx という形式のリクエストIDが含まれます。

デバッグヘッダとデバッグレスポンスヘッダによって生成されたログ行には、リクエスト ID が含まれます。これを使用して、ログビューアの UI を使用してデバッグヘッダー出力を検索できます。これは、デバッグ出力がレスポンスヘッダーに収まるには長すぎる場合に特に便利です。

デバッグヘッダーとデバッグレスポンスヘッダーによって生成されるログ行には、リクエストIDが含まれています。これを使用すると、ログビューアーUIでデバッグヘッダー出力を検索できます。これは、デバッグ出力が長すぎてレスポンスヘッダーに収まらない場合に特に便利です。