Datadog Configuration

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

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

構成

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

互換性のあるプロトコル

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

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

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: datadog_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
  • host

    string referenceable default: localhost

    The IP address or hostname to send data to.

  • port

    integer default: 8125 between: 0 65535

    The port to send data to on the upstream server.

  • prefix

    string default: kong

    String to be attached as a prefix to a metric’s name.

  • service_name_tag

    string default: name

    String to be attached as the name of the service.

  • status_tag

    string default: status

    String to be attached as the tag of the HTTP status.

  • consumer_tag

    string default: consumer

    String to be attached as tag of the consumer.

  • retry_count

    integer

    Number of times to retry when sending data to the upstream server.

  • queue_size

    integer

    Maximum number of log entries to be sent on each message to the upstream server.

  • flush_timeout

    number

    Optional time in seconds. If queue_size > 1, this is the max idle time before sending a log with less than queue_size records.

  • queue

    record required
    • 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

      number

      Maximum 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.

  • metrics

    array of type record required default: {"consumer_identifier"=>"custom_id", "sample_rate"=>1, "stat_type"=>"counter", "tags"=>["app:kong"], "name"=>"request_count"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"latency"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"request_size"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"response_size"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"upstream_latency"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"kong_latency"}

    List of metrics to be logged. Available values are described at Metrics. By default, the plugin logs all available metrics. If you specify an array of metrics, only the listed metrics are logged.

    • name

      string required Must be one of: kong_latency, latency, request_count, request_size, response_size, upstream_latency

    • stat_type

      string required Must be one of: counter, gauge, histogram, meter, set, timer, distribution

    • tags

      array of type string

    • sample_rate

      number between: 0 1

    • consumer_identifier

      string Must be one of: consumer_id, custom_id, username