このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
Zipkinプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
string required
プラグイン名。この場合は
zipkin
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
string
プラグインのインスタンスを識別するための任意のカスタム名 (例:
zipkin_my-service
。インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。
インスタンス名は、次のコンテキスト内で一意である必要があります。
- Kong Gateway Enterpriseのワークスペース内
- Konnectのコントロールプレーン(CP)またはコントロールプレーン(CP)グループ内
- Kong Gateway (OSS)の全世界
-
string
プラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするコンシューマーの名前または ID。 最上位の
/plugins
エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください/consumers/{consumerName|Id}/plugins
を使用する場合は必要ありません。 -
boolean default:
true
このプラグインが適用されるかどうか。
-
record required
-
string required default:
kong
The name of the service as displayed in Zipkin.
-
string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
-
number default:
0.001
between:0
1
How often to sample requests that do not contain trace IDs. Set to
0
to turn sampling off, or to1
to sample all requests.
-
string
Set a default service name to override
unknown-service-name
in the Zipkin spans.
-
boolean required default:
true
Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
-
integer required default:
16
Must be one of:8
,16
The length in bytes of each request’s Trace ID.
-
string default:
preserve
Must be one of:preserve
,ignore
,b3
,b3-single
,w3c
,jaeger
,ot
,aws
,datadog
-
string default:
b3
Must be one of:b3
,b3-single
,w3c
,jaeger
,ot
,aws
,datadog
-
string required default:
Zipkin-Tags
The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
-
array of type
record
-
string required default:
method
Must be one of:method
,method_path
Specify whether to include the HTTP path in the span name.
-
integer default:
2000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
integer default:
5000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
integer default:
5000
between:0
2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
-
string
-
string required default:
annotations
Must be one of:annotations
,tags
Specify whether to include the duration of each phase as an annotation or a tag.
-
record required
-
integer default:
1
between:1
1000000
Maximum number of entries that can be processed at a time.
-
number default:
1
between:0
3600
Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
-
integer default:
10000
between:1
1000000
Maximum number of entries that can be waiting on the queue.
-
integer
Maximum number of bytes that can be waiting on a queue, requires string content.
-
number default:
60
Time in seconds before the queue gives up calling a failed handler for a batch.
-
number default:
0.01
between:0.001
1000000
Time in seconds before the initial retry is made for a failing batch.
-
number default:
60
between:0.001
1000000
Maximum time in seconds between retries, caps exponential backoff.
-
-