Skip to content
|
search
Plugin Hub
header icon

StatsD

Log metrics for a Service or Route to a StatsD server. It can also be used to log metrics on Collectd daemon by enabling its StatsD plugin.

Configuration Reference

This plugin is compatible with DB-less mode.

In DB-less mode, you configure Kong Gateway declaratively. Therefore, the Admin API is mostly read-only. The only tasks it can perform are all related to handling the declarative config, including:

  • Setting a target's health status in the load balancer
  • Validating configurations against schemas
  • Uploading the declarative configuration using the /config endpoint

Example plugin configuration

The following examples provide some typical configurations for enabling the statsd plugin on a service.

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=statsd"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125" \
    --data "config.allow_status_codes=200-205" \
    --data "config.allow_status_codes=400-499" \
    --data "config.flush_timeout=2" \
    --data "config.retry_count=10"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd-example
config: 
  host: 127.0.0.1
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd

Next, apply the KongPlugin resource to a service by annotating the service as follows:

apiVersion: v1
kind: Service
metadata:
  name: SERVICE_NAME|SERVICE_ID
  labels:
    app: SERVICE_NAME|SERVICE_ID
  annotations:
    konghq.com/plugins: statsd-example
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: SERVICE_NAME|SERVICE_ID
  selector:
    app: SERVICE_NAME|SERVICE_ID

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: statsd
  service: SERVICE_NAME|SERVICE_ID
  config: 
    host: 127.0.0.1
    port: 8125
    allow_status_codes:
    - 200-205
    - 400-499
    flush_timeout: 2
    retry_count: 10

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

You can configure this plugin through the Konnect UI.

From the servicehub icon Service Hub, select a service version, then set up the plugin:

  1. In the Plugins section, click Add Plugin.
  2. Find and select the StatsD plugin.

  3. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  4. Click Create.

You can configure this plugin through the Kong Manager UI.

  1. In Kong Manager, select the workspace.
  2. From the Services section, click View for the service row.
  3. From the plugin section, click Add Plugin.
  4. Find and select the StatsD plugin.
  5. If the option is available, select Scoped.
  6. Add the service name and ID to the Service field if it is not already pre-filled.

  7. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  8. Click Create.

The following examples provide some typical configurations for enabling the statsd plugin on a route.

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
  --data "name=statsd"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125" \
    --data "config.allow_status_codes=200-205" \
    --data "config.allow_status_codes=400-499" \
    --data "config.flush_timeout=2" \
    --data "config.retry_count=10"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd-example
config: 
  host: 127.0.0.1
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd

Then, apply it to an ingress (route or routes) by annotating the ingress as follows:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ROUTE_NAME|ROUTE_ID
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: statsd-example
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          service:
            name: echo
            port:
              number: 80

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: statsd
  route: ROUTE_NAME
  config: 
    host: 127.0.0.1
    port: 8125
    allow_status_codes:
    - 200-205
    - 400-499
    flush_timeout: 2
    retry_count: 10

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

You can configure this plugin through the Konnect UI.

From the servicehub icon Service Hub, select a service version, then set up the plugin:

  1. Select a route.
  2. In the Plugins section, click Add Plugin.
  3. Find and select the StatsD plugin.

  4. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  5. Click Create.

You can configure this plugin through the Kong Manager UI.

  1. In Kong Manager, select the workspace.
  2. Open Routes from the menu, then click View for the route row.
  3. From the plugin section, click Add Plugin.
  4. Find and select the StatsD plugin.
  5. If the option is available, select Scoped.
  6. Add the route ID if it is not already prefilled.

  7. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  8. Click Create.

The following examples provide some typical configurations for enabling the statsd plugin on a consumer.

Make the following request:

curl -X POST http://localhost:8001/consumers/CONSUMER_NAME|CONSUMER_ID/plugins \
  --data "name=statsd"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125" \
    --data "config.allow_status_codes=200-205" \
    --data "config.allow_status_codes=400-499" \
    --data "config.flush_timeout=2" \
    --data "config.retry_count=10"

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

You can combine consumer.id, service.id, or route.id in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd-example
config: 
  host: 127.0.0.1
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd

Then, apply it to a consumer by annotating the KongConsumer resource as follows:

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: CONSUMER_NAME|CONSUMER_ID
  annotations:
    konghq.com/plugins: statsd-example
    kubernetes.io/ingress.class: kong

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: statsd
  consumer: CONSUMER_NAME|CONSUMER_ID
  config: 
    host: 127.0.0.1
    port: 8125
    allow_status_codes:
    - 200-205
    - 400-499
    flush_timeout: 2
    retry_count: 10

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

You can configure this plugin through the Kong Manager UI.

  1. In Kong Manager, select the workspace.
  2. From the Consumers section, click View for the consumer row.
  3. Select the Plugins tab, then click Add Plugin.
  4. Find and select the StatsD plugin.
  5. If the option is available, select Scoped.
  6. Add the consumer ID if it is not already prefilled.

  7. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  8. Click Create.

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the statsd plugin globally.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
  --data "name=statsd"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125" \
    --data "config.allow_status_codes=200-205" \
    --data "config.allow_status_codes=400-499" \
    --data "config.flush_timeout=2" \
    --data "config.retry_count=10"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-statsd>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  host: 127.0.0.1
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd

Add a plugins entry in the declarative configuration file:

plugins:
- name: statsd
  config: 
    host: 127.0.0.1
    port: 8125
    allow_status_codes:
    - 200-205
    - 400-499
    flush_timeout: 2
    retry_count: 10

You can configure this plugin through the Kong Manager UI.

  1. In Kong Manager, select the workspace.
  2. Open Plugins from the menu, then click New Plugin.
  3. Find and select the StatsD plugin.
  4. If the option is available, set the plugin scope to Global.

  5. Configure the plugin’s parameters.

    You can test out the plugin with the following sample configuration:

    • Config.Host: 127.0.0.1
    • Config.Port: 8125
    • Config.Allow Status Codes: 200-205
    • Config.Allow Status Codes: 400-499
    • Config.Flush Timeout: 2
    • Config.Retry Count: 10
  6. Click Create.

Parameters

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

Form Parameter Description
name

required

Type: string

 The name of the plugin, in this case statsd.
instance_name

optional

Type: string

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

Useful when running the same plugin in multiple contexts, for example, on multiple services.
service.name or service.id

optional

Type: 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/SERVICE_NAME|SERVICE_ID/plugins.
route.name or route.id

optional

Type: 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/ROUTE_NAME|ROUTE_ID/plugins.
consumer.name or consumer.id

optional


Type: 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/CONSUMER_NAME|CONSUMER_ID/plugins.
enabled

optional

Type: boolean

Default value: true

 Whether this plugin will be applied.
config.host

required

Type: string

Default value: 127.0.0.1


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

required

Type: integer

Default value: 8125


The port of StatsD server to send data to.
config.metrics

required

Type: Array of record elements

Default value: All metrics are logged


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

required

Type: string

Default value: kong


String to prefix to each metric’s name.
config.hostname_in_prefix

required

Type: boolean

Default value: false


Include the hostname in the prefix for each metric name.
config.udp_packet_size

required

Type: number

Default value: 0 (not combined)


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).
config.use_tcp

required

Type: boolean

Default value: false


Use TCP instead of UDP.
config.allow_status_codes

required

Type: array of string elements

Default value: All responses are passed to log metrics


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

required

Type: string

Default value: custom_id


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.
config.service_identifier_default

required

Type: string

Default value: 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.
config.workspace_identifier_default

required

Type: string

Default value: workspace_id


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.
config.flush_timeout

required

Type: number

Default value: 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.
config.retry_count

required

Type: integer

Default value: 10


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

required

Type: integer

Default value: 1


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

optional

Type: string


The tag style configurations to send metrics with tags. Defaults to nil, which doesn’t add any tags to the metrics. Allowed values are dogstatsd, influxdb, librato, and signalfx.

By default, the plugin sends a packet for each metric it observes. The udp_packet_size option configures the greatest datagram size the plugin can combine. It should be less than 65507 according to UDP protocol. Consider the MTU of the network when setting this parameter.

Metrics

Metric Description Namespace
request_count The number of requests. kong.service.<service_identifier>.request.count
request_size The request’s body size in bytes. kong.service.<service_identifier>.request.size
response_size The response’s body size in bytes. kong.service.<service_identifier>.response.size
latency The time interval in milliseconds between the request and response. kong.service.<service_identifier>.latency
status_count Tracks each status code returned in a response. kong.service.<service_identifier>.status.<status>
unique_users Tracks unique users who made requests to the underlying Service or route. kong.service.<service_identifier>.user.uniques
request_per_user Tracks the request count per consumer. kong.service.<service_identifier>.user.<consumer_identifier>.request.count
upstream_latency Tracks the time in milliseconds it took for the final Service to process the request. kong.service.<service_identifier>.upstream_latency
kong_latency Tracks the internal Kong latency in milliseconds that it took to run all the plugins. kong.service.<service_identifier>.kong_latency
status_count_per_user Tracks the status code per consumer per service. kong.service.<service_identifier>.user.<consumer_identifier>.status.<status>
status_count_per_workspace The status code per workspace. kong.service.<service_identifier>.workspace.<workspace_identifier>.status.<status>
status_count_per_user_per_route The status code per consumer per route. kong.route.<route_id>.user.<consumer_identifier>.status.<status>
shdict_usage The usage of shared dict, sent once every minute. kong.node.<node_hostname>.shdict.<shdict_name>.free_space and kong.node.<node_hostname>.shdict.<shdict_name>.capacity
cache_datastore_hits_total The total number of cache hits. (Kong Enterprise only) kong.service.<service_identifier>.cache_datastore_hits_total
cache_datastore_misses_total The total number of cache misses. (Kong Enterprise only) kong.service.<service_identifier>.cache_datastore_misses_total

If a request URI doesn’t match any Routes, the following metrics are sent instead:

Metric Description Namespace
request_count The request count. kong.global.unmatched.request.count
request_size The request’s body size in bytes. kong.global.unmatched.request.size
response_size The response’s body size in bytes. kong.global.unmatched.response.size
latency The time interval between when the request started and when the response is received from the upstream server. kong.global.unmatched.latency
status_count The status count. kong.global.unmatched.status.<status>.count
kong_latency The internal Kong latency in milliseconds that it took to run all the plugins. kong.global.unmatched.kong_latency

If you enable the tag_style configuration for the StatsD plugin, the following metrics are sent instead:

Metric Description Namespace
request_count The number of requests. kong.request.count
request_size The request’s body size in bytes. kong.request.size
response_size The response’s body size in bytes. kong.response.size
latency The time interval in milliseconds between the request and response. kong.latency
request_per_user Tracks the request count per consumer. kong.request.count
upstream_latency Tracks the time in milliseconds it took for the final service to process the request. kong.upstream_latency
shdict_usage The usage of shared dict, sent once every minute. kong.shdict.free_space and kong.shdict.capacity
cache_datastore_hits_total The total number of cache hits. (Kong Enterprise only) kong.cache_datastore_hits_total
cache_datastore_misses_total The total number of cache misses. (Kong Enterprise only) kong.cache_datastore_misses_total

The StatsD plugin supports Librato, InfluxDB, DogStatsD, and SignalFX-style tags, which are used like Prometheus labels.

  • Librato-style tags: Must be appended to the metric name with a delimiting #, for example: metric.name#tagName=val,tag2Name=val2:0|c See the Librato StatsD documentation for more information.

  • InfluxDB-style tags: Must be appended to the metric name with a delimiting comma, for example: metric.name,tagName=val,tag2Name=val2:0|c See the InfluxDB StatsD documentation for more information.

  • DogStatsD-style tags: Appended as a |# delimited section at the end of the metric, for example: metric.name:0|c|#tagName:val,tag2Name:val2 See the Datadog StatsD Tags documentation for more information about the concept description and Datagram Format. AWS CloudWatch also uses the DogStatsD protocol.

  • SignalFX dimension: Add the tags to the metric name in square brackets, for example: metric.name[tagName=val,tag2Name=val2]:0|c See the SignalFX StatsD documentation for more information.

When the tag_style config is enabled, Kong Gateway uses a filter label, like service, route, workspace, consumer, node, or status, on the metrics tags to see if these can be found. For shdict_usage metrics, only node and shdict are added.

For example:

kong.request.size,workspace=default,route=d02485d7-8a28-4ec2-bc0b-caabed82b499,status=200,consumer=d24d866a-020a-4605-bc3c-124f8e1d5e3f,service=bdabce05-e936-4673-8651-29d2e9eca382,node=c80a9c5845bd:120|c

Metric Fields

The plugin can be configured with any combination of Metrics, with each entry containing the following fields:

Field Description Datatype Allowed values
name
required		 StatsD metric’s name. String Metrics
stat_type
required		 Determines what sort of event a metric represents. String gauge, timer, counter, histogram, meter and set
sample_rate
required
conditional		 Sampling rate. Number number
consumer_identifier
conditional		 Authenticated user detail. String One of the following options: consumer_id, custom_id, username, null
service_identifier
conditional		 Service detail. String One of the following options: service_id, service_name, service_host, service_name_or_host, null
workspace_identifier
conditional		 Workspace detail. String One of the following options:workspace_id, workspace_name, null

Metric behaviors

  • By default, all metrics get logged.
  • Metric with stat_type set to counter or gauge must have sample_rate defined as well.
  • unique_users metric only works with stat_type as set.
  • status_count, status_count_per_user, status_count_per_user_per_route and request_per_user work only with stat_type as counter.
  • shdict_usage work only with stat_type as gauge.
  • status_count_per_user, request_per_user, unique_users and status_count_per_user_per_route must have customer_identifier defined.
  • All metrics can optionally configure service_identifier; by default it’s set to service_name_or_host.
  • status_count_per_workspace must have workspace_identifier defined.

Kong Process Errors

This logging plugin logs HTTP request and response data, and also supports streams data (TCP, TLS, and UDP).

If you are looking for the Kong process error file (which is the nginx error file), you can find it at the following path:

{prefix}/logs/error.log

Changelog

Kong Gateway 3.2.x

  • Added the tag_style configuration parameter. This allows you to send metrics with tags. Defaults to nil, which doesn’t add any tags to the metrics.

Kong Gateway 3.1.x

  • Added support for managing queues and connection retries when sending messages to the upstream with the queue_size,flush_timeout, and retry_count configuration parameters.

Kong Gateway 3.0.x

  • Merged features of the StatsD Advanced plugin into the StatsD plugin. The StatsD plugin now includes the following:
    • New parameters for StatsD: hostname_in_prefix, udp_packet_size, ues_tcp, allow_status_codes, consumer_identifier_default, service_identifier_default, workspace_identifier_default.
    • New metrics: status_count_per_workspace, status_count_per_user_per_route, shdict_usage
    • New metric fields: service_identifier, workspace_identifier
  • Breaking changes
    • The metric name that is related to the service has been renamed by adding a service. prefix. e.g. kong.service.<service_identifier>.request.count
    • The metric kong.<service_identifier>.request.status.<status>.count from metrics status_count and status_count_per_user has been renamed to kong.service.<service_identifier>.status.<status>.count
    • The metric *.status.<status>.total from metrics status_count and status_count_per_user has been removed.
    • The metric kong.<service_identifier>.request_size and kong.<service_identifier>.response_size stat type has been changed from timer to counter.