Zipkin設定 - Plugin - v3.7.x

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

Zipkinプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

name or plugin

string required
プラグイン名。この場合はzipkin 。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
- Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。
instance_name

string
プラグインのインスタンスを識別するための任意のカスタム名 (例: zipkin_my-service 。

インスタンス名はKong ManagerとKonnectに表示されるので、例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスにアクセスするためにも使用できます。

インスタンス名は、次のコンテキスト内で一意である必要があります。
- Kong Gateway Enterpriseのワークスペース内
- Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
- Kong Gateway (OSS)の全世界
service.name or service.id

string

プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。
route.name or route.id

string

プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。
consumer.name or consumer.id

string

プラグインがターゲットとするコンシューマーの名前または ID。最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。
enabled

boolean default: true

このプラグインが適用されるかどうか。
config

record required
- local_service_name
  
  string required default: kong
  
  The name of the service as displayed in Zipkin.
- http_endpoint
  
  string
  
  A string representing a URL, such as https://example.com/path/to/resource?q=search.
- sample_ratio
  
  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 to 1 to sample all requests.
- default_service_name
  
  string
  
  Set a default service name to override unknown-service-name in the Zipkin spans.
- include_credential
  
  boolean required default: true
  
  Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
- traceid_byte_count
  
  integer required default: 16 Must be one of: 8, 16
  
  The length in bytes of each request’s Trace ID.
- header_type
  
  string required default: preserve default: preserve Must be one of: preserve, ignore, b3, b3-single, w3c, jaeger, ot, aws, datadog, gcp
  
  All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
  
  Deprecation notice: zipkin: config.header_type is deprecated, please use config.propagation options instead. This field is planned to be removed in version 4.0.
- default_header_type
  
  string required default: b3 default: b3 Must be one of: b3, b3-single, w3c, jaeger, ot, aws, datadog, gcp
  
  Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
  
  Deprecation notice: zipkin: config.default_header_type is deprecated, please use config.propagation.default_format instead. This field is planned to be removed in version 4.0.
- tags_header
  
  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.
- static_tags
  
  array of type record
  The tags specified on this property will be added to the generated request traces.
  
  name
  
  string required
  
  value
  
  string required
- http_span_name
  
  string required default: method Must be one of: method, method_path
  
  Specify whether to include the HTTP path in the span name.
- connect_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send_timeout
  
  integer default: 5000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- read_timeout
  
  integer default: 5000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- http_response_header_for_traceid
  
  string
- phase_duration_flavor
  
  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.
- queue
  
  record required
  max_batch_size
  
  integer default: 1 between: 1 1000000
  
  Maximum number of entries that can be processed at a time.
  
  max_coalescing_delay
  
  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.
  
  max_entries
  
  integer default: 10000 between: 1 1000000
  
  Maximum number of entries that can be waiting on the queue.
  
  max_bytes
  
  integer
  
  Maximum number of bytes that can be waiting on a queue, requires string content.
  
  max_retry_time
  
  number default: 60
  
  Time in seconds before the queue gives up calling a failed handler for a batch.
  
  initial_retry_delay
  
  number default: 0.01 between: 0.001 1000000
  
  Time in seconds before the initial retry is made for a failing batch.
  
  max_retry_delay
  
  number default: 60 between: 0.001 1000000
  
  Maximum time in seconds between retries, caps exponential backoff.
- propagation
  
  record required default: {"default_format"=>"b3"}
  extract
  
  array of type string Must be one of: b3, gcp, jaeger, aws, ot, w3c, datadog
  
  Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
  
  clear
  
  array of type string
  
  Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
  
  inject
  
  array of type string Must be one of: preserve, b3, gcp, b3-single, jaeger, aws, ot, w3c, datadog
  
  Header formats used to inject tracing context. The value preserve will use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
  
  default_format
  
  string required Must be one of: b3, gcp, b3-single, jaeger, aws, ot, w3c, datadog
  
  The default header format to use when extractors did not match any format in the incoming headers and inject is configured with the value: preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included in extract.

前へ Zipkin

次へ Zipkinの基本構成例

構成

互換性のあるプロトコル

パラメータ

name or plugin

instance_name

service.name or service.id

route.name or route.id

consumer.name or consumer.id

enabled

config

local_service_name

http_endpoint

sample_ratio

default_service_name

include_credential

traceid_byte_count

header_type

default_header_type

tags_header

static_tags

name

value

http_span_name

connect_timeout

send_timeout

read_timeout

http_response_header_for_traceid

phase_duration_flavor

queue

max_batch_size

max_coalescing_delay

max_entries

max_bytes

max_retry_time

initial_retry_delay

max_retry_delay

propagation

extract

clear

inject

default_format