このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインは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 ファイルを使用する場合、フィールドは
-
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
integer required default:200
The number of spans to be sent in a single batch.
-
batch_flush_delay
integer required default:3
The delay, in seconds, between two consecutive batches.
-
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.
-