このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインは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 required referenceableA string representing a URL, such as https://example.com/path/to/resource?q=search.
-
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
map
-
queue
record required default:{"max_batch_size"=>200}
-
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
integerMaximum 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.
-
-
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.
-
connect_timeout
integer default:1000
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
-
header_type
string default:preserve
Must be one of:preserve
,ignore
,b3
,b3-single
,w3c
,jaeger
,ot
,aws
,datadog
-