statsd-advanced Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

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

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

• 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 the StatsD server.

  • port

    integer default: 8125 between: 0 65535

    The port of the StatsD server.

  • prefix

    string default: kong

    String to prefix to each metric’s name.

  • metrics

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

    List of Metrics to be logged. Available values are described under Metrics.

    • 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

    • stat_type

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

    • sample_rate

      number

    • consumer_identifier

      string Must be one of: consumer_id, custom_id, username

    • service_identifier

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

    • workspace_identifier

      string Must be one of: workspace_id, workspace_name

  • 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

    Combine UDP packet up to the size configured. If zero (0), don’t combine the UDP packet. Must be a number between 0 and 65507 (inclusive).

  • use_tcp

    boolean default: false

    Use TCP instead of UDP.

  • hostname_in_prefix

    boolean default: false

    Include the hostname in the prefix for each metric name.