StatsD Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The StatsD 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 statsd.

  • 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 statsd_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 default: localhost

    The IP address or hostname of StatsD server to send data to.

  • port

    integer default: 8125 between: 0 65535

    The port of StatsD server to send data to.

  • prefix

    string default: kong

    String to prefix to each metric’s name.

  • metrics

    array of type record default: {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"request_count"}, {"stat_type"=>"timer", "name"=>"latency"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"request_size"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"response_size"}, {"stat_type"=>"set", "name"=>"unique_users"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"request_per_user"}, {"stat_type"=>"timer", "name"=>"upstream_latency"}, {"stat_type"=>"timer", "name"=>"kong_latency"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_user"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_workspace"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_user_per_route"}, {"stat_type"=>"gauge", "sample_rate"=>1, "name"=>"shdict_usage"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"cache_datastore_hits_total"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"cache_datastore_misses_total"}

    List of metrics to be logged.

    • name

      string required Must be one of: kong_latency, latency, request_count, request_per_user, request_size, response_size, status_count, status_count_per_user, unique_users, upstream_latency, status_count_per_workspace, status_count_per_user_per_route, shdict_usage, cache_datastore_hits_total, cache_datastore_misses_total

      StatsD metric’s name.

    • stat_type

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

      Determines what sort of event a metric represents.

    • sample_rate

      number

      Sampling rate

    • consumer_identifier

      string Must be one of: consumer_id, custom_id, username

      Authenticated user detail.

    • service_identifier

      string Must be one of: service_id, service_name, service_host, service_name_or_host

      Service detail.

    • workspace_identifier

      string Must be one of: workspace_id, workspace_name

      Workspace detail.

  • allow_status_codes

    array of type string

    List of status code ranges that are allowed to be logged in metrics.

  • udp_packet_size

    number default: 0 between: 0 65507

  • use_tcp

    boolean default: false

  • hostname_in_prefix

    boolean default: false

  • consumer_identifier_default

    string required default: custom_id Must be one of: consumer_id, custom_id, username

  • service_identifier_default

    string required default: service_name_or_host Must be one of: service_id, service_name, service_host, service_name_or_host

  • workspace_identifier_default

    string required default: workspace_id Must be one of: workspace_id, workspace_name

  • retry_count

    integer default: 10
    Deprecation notice: statsd: 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
    Deprecation notice: statsd: 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
    Deprecation notice: statsd: config.flush_timeout is deprecated, please use config.queue.max_coalescing_delay instead. This field is planned to be removed in version 4.0.

  • tag_style

    string Must be one of: dogstatsd, influxdb, librato, signalfx

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