このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
OpenTelemetryプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
opentelemetry
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
instance_name
stringプラグインのインスタンスを識別するための任意のカスタム名 (例:
opentelemetry_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-
endpoint
string requiredThe full HTTP(S) endpoint that Kong Gateway should send OpenTelemetry spans to. The endpoint must be a OTLP/HTTP endpoint.
-
headers
mapThe custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
-
resource_attributes
mapThe attributes specified on this property are added to the OpenTelemetry resource object. Kong follows the OpenTelemetry specification for Semantic Attributes.
The following attributes are automatically added to the resource object:
-
service.name
: The name of the service. This iskong
by default. -
service.version
: The version of Kong Gateway. -
service.instance.id
: The node id of Kong Gateway.
The default values for the above attributes can be overridden by specifying them in this property. For example, to override the default value of
service.name
tomy-service
, you can specify{ "service.name": "my-service" }
. -
-
batch_span_count
integerThe number of spans to be sent in a single batch.
-
batch_flush_delay
integerThe delay, in seconds, between two consecutive batches.
-
queue
record requiredConfiguration parameters for queue
-
max_batch_size
number default:1
between:1
1000000
Maximum number of entries to be processed together as a batch.
-
max_coalescing_delay
number default:1
between:0
3600
Maximum number of seconds (as a fraction) that can elapse after the first entry was queued before the queue starts processing entries. This parameter has no effect when
batch_max_size
is one because queued entries will be sent immediately in that case.
-
max_entries
number default:10000
between:1
1000000
Maximum number of entries that can be waiting on the queue. Once this number of requests is reached, the oldest entry is deleted from the queue before a new one is added.
-
max_bytes
numberMaximum number of bytes that can be waiting on a queue. Once this many bytes are present on a queue, old entries up to the size of a new entry to be enqueued are deleted from the queue.
-
max_retry_time
number default:60
Time (in seconds) before the queue gives up trying to send a batch of entries. Once this time is exceeded for a batch, it is deleted from the queue without being sent. If this parameter is set to -1, no retries will be made for a failed batch.
-
initial_retry_delay
number default:0.01
-
max_retry_delay
number default:60
Maximum time (in seconds) between retries sending a batch of entries. The interval between retries follows an exponential back-off algorithm capped at this number of seconds.
-
-
connect_timeout
integer default:1000
between:0
2147483646
The timeout, in milliseconds, for the OTLP server connection.
-
send_timeout
integer default:5000
between:0
2147483646
The timeout, in milliseconds, for sending spans to the OTLP server.
-
read_timeout
integer default:5000
between:0
2147483646
The timeout, in milliseconds, for reading the response from the OTLP server.
-
http_response_header_for_traceid
string
-
header_type
string default:preserve
Must be one of:preserve
,ignore
,b3
,b3-single
,w3c
,jaeger
,ot
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.
Possible values:
b3
,b3-single
,w3c
,preserve
,jaeger
,ot
, orignore
.
-