OpenTelemetry Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は opentelemetry 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• 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

    The full HTTP(S) endpoint that Kong Gateway should send OpenTelemetry spans to. The endpoint must be a OTLP/HTTP endpoint.

  • headers

    map

    The 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

    The 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 is kong 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 to my-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.