StatsD: Enable StatsD metrics - Plugin

Enable StatsD metrics

Log requests in a status range to a StatsD server.

Prerequisites

A Gateway Service and Route to log metrics from
A StatsD server

Environment variables

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

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: statsd
    config:
      host: ${{ env "DECK_HOST" }}
      port: 8125
      allow_status_codes:
      - 200-205
      - 400-499
      flush_timeout: 2
      retry_count: 10

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: statsd
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  host: '$HOST'
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd
" | kubectl apply -f -

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_statsd" "my_statsd" {
  enabled = true

  config = {
    host = var.host
    port = 8125
    allow_status_codes = ["200-205", "400-499"]
    flush_timeout = 2
    retry_count = 10
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "host" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: statsd
    service: serviceName|Id
    config:
      host: ${{ env "DECK_HOST" }}
      port: 8125
      allow_status_codes:
      - 200-205
      - 400-499
      flush_timeout: 2
      retry_count: 10

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  host: '$HOST'
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=statsd

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_statsd" "my_statsd" {
  enabled = true

  config = {
    host = var.host
    port = 8125
    allow_status_codes = ["200-205", "400-499"]
    flush_timeout = 2
    retry_count = 10
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "host" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: statsd
    route: routeName|Id
    config:
      host: ${{ env "DECK_HOST" }}
      port: 8125
      allow_status_codes:
      - 200-205
      - 400-499
      flush_timeout: 2
      retry_count: 10

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  host: '$HOST'
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=statsd

kubectl annotate -n kong ingress  konghq.com/plugins=statsd

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_statsd" "my_statsd" {
  enabled = true

  config = {
    host = var.host
    port = 8125
    allow_status_codes = ["200-205", "400-499"]
    flush_timeout = 2
    retry_count = 10
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "host" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: statsd
    consumer: consumerName|Id
    config:
      host: ${{ env "DECK_HOST" }}
      port: 8125
      allow_status_codes:
      - 200-205
      - 400-499
      flush_timeout: 2
      retry_count: 10

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "statsd",
      "config": {
        "host": "'$HOST'",
        "port": 8125,
        "allow_status_codes": [
          "200-205",
          "400-499"
        ],
        "flush_timeout": 2,
        "retry_count": 10
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: statsd
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  host: '$HOST'
  port: 8125
  allow_status_codes:
  - 200-205
  - 400-499
  flush_timeout: 2
  retry_count: 10
plugin: statsd
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong  CONSUMER_NAME konghq.com/plugins=statsd

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_statsd" "my_statsd" {
  enabled = true

  config = {
    host = var.host
    port = 8125
    allow_status_codes = ["200-205", "400-499"]
    flush_timeout = 2
    retry_count = 10
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "host" {
  type = string
}

StatsD

Enable StatsD metrics

Prerequisites

Environment variables

Set up the plugin

Help us make these docs great!

Still need help