Datadog Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Datadog plugin is compatible with the following protocols:

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

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case datadog.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example datadog_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/{consumerName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • host

    string referenceable default: localhost

    A string representing a host name, such as example.com.

  • port

    integer default: 8125 between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • 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 default: 10

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

    Deprecation notice: datadog: config.retry_count no longer works, please use config.queue.max_retry_time instead. This field is planned to be removed in version 4.0.

  • queue_size

    integer default: 1

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

    Deprecation notice: datadog: config.queue_size is deprecated, please use config.queue.max_batch_size instead. This field is planned to be removed in version 4.0.

  • flush_timeout

    number default: 2

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

    Deprecation notice: datadog: config.flush_timeout is deprecated, please use config.queue.max_coalescing_delay instead. This field is planned to be removed in version 4.0.

  • queue

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

      integer

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

    • concurrency_limit

      integer default: 1 Must be one of: -1, 1

      The number of of queue delivery timers. -1 indicates unlimited.

  • metrics

    array of type record required default: {"name"=>"request_count", "stat_type"=>"counter", "tags"=>["app:kong"], "sample_rate"=>1, "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", "tags"=>["app:kong"], "consumer_identifier"=>"custom_id"}

    List of metrics to be logged.

    • name

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

      Datadog metric’s name

    • stat_type

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

      Determines what sort of event the metric represents

    • tags

      array of type string

      List of tags

    • sample_rate

      number between: 0 1

      Sampling rate

    • consumer_identifier

      string Must be one of: consumer_id, custom_id, username

      Authenticated user detail