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:
-
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
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
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)
-
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
. -
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
. -
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
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
string default:
localhost
The IP address or hostname of StatsD server to send data to.
-
integer default:
8125
between:0
65535
The port of StatsD server to send data to.
-
string default:
kong
String to prefix to each metric’s name.
-
array of type
record
default:{"name"=>"request_count", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"latency", "stat_type"=>"timer"}, {"name"=>"request_size", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"status_count", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"response_size", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"unique_users", "stat_type"=>"set"}, {"name"=>"request_per_user", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"upstream_latency", "stat_type"=>"timer"}, {"name"=>"kong_latency", "stat_type"=>"timer"}, {"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"=>"counter", "sample_rate"=>1}, {"name"=>"shdict_usage", "stat_type"=>"gauge", "sample_rate"=>1}, {"name"=>"cache_datastore_hits_total", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"cache_datastore_misses_total", "stat_type"=>"counter", "sample_rate"=>1}
List of metrics to be logged. Available values are described under Metrics.
-
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
-
string required Must be one of:
counter
,gauge
,histogram
,meter
,set
,timer
-
number
-
string Must be one of:
consumer_id
,custom_id
,username
-
string Must be one of:
service_id
,service_name
,service_host
,service_name_or_host
-
string Must be one of:
workspace_id
,workspace_name
-
-
array of type
string
List of status code ranges that are allowed to be logged in metrics.
-
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).
-
boolean default:
false
Use TCP instead of UDP.
-
boolean default:
false
Include the
hostname
in theprefix
for each metric name.
-
string required default:
custom_id
Must be one of:consumer_id
,custom_id
,username
The default consumer identifier of metrics. This takes effect when a metric’s consumer identifier is omitted. Allowed values are
custom_id
,consumer_id
,username
.
-
string required default:
service_name_or_host
Must be one of:service_id
,service_name
,service_host
,service_name_or_host
The default service identifier of metrics. This takes effect when a metric’s service identifier is omitted. Allowed values are
service_name_or_host
,service_id
,service_name
,service_host
.
-
string required default:
workspace_id
Must be one of:workspace_id
,workspace_name
The default workspace identifier of metrics. This will take effect when a metric’s workspace identifier is omitted. Allowed values are
workspace_id
,workspace_name
.
-
integer required default:
10
Number of times to retry when sending data to the upstream server.
-
integer required default:
1
Maximum number of log entries to be sent on each message to the upstream server.
-
number required default:
2
Optional time in seconds. If
queue_size
> 1, this is the max idle time before sending a log with less thanqueue_size
records.
-
string Must be one of:
dogstatsd
,influxdb
,librato
,signalfx
The tag style configurations to send metrics with tags. Defaults to
nil
, which doesn’t add any tags to the metrics. Allowed values aredogstatsd
,influxdb
,librato
, andsignalfx
.
-