Datadog plugin

Log metrics for a Service, Route to a local Datadog agent.

Note: The functionality of this plugin as bundled with versions of Kong prior to 1.4.0 differs from what is documented herein. Refer to the CHANGELOG for details.

Configuration Reference

You can configure this plugin using the Kong Admin API or through declarative configuration, which involves directly editing the Kong configuration file.

This plugin is compatible with requests with the following protocols:

http
https
tcp
tls
udp

This plugin is compatible with DB-less mode.

In DB-less mode, Kong does not have an Admin API. If using this mode, configure the plugin using declarative configuration.

Enabling the plugin on a Service

Kong Admin API

Kubernetes

Declarative (YAML)

For example, configure this plugin on a Service by making the following request:

$ curl -X POST http://<admin-hostname>:8001/services/<service>/plugins \
    --data "name=datadog"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125"

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <datadog-example>
config: 
  host: 127.0.0.1
  port: 8125
plugin: datadog

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

apiVersion: v1
kind: Service
metadata:
  name: <service>
  labels:
    app: <service>
  annotations:
    konghq.com/plugins: <datadog-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: <service>
  selector:
    app: <service>

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.

For example, configure this plugin on a Service by adding this section to your declarative configuration file:

plugins:
- name: datadog
  service: <service>
  config: 
    host: 127.0.0.1
    port: 8125

<service> is the id or name of the Service that this plugin configuration will target.

Enabling the plugin on a Route

Kong Admin API

Kubernetes

Declarative (YAML)

For example, configure this plugin on a Route with:

$ curl -X POST http://<admin-hostname>:8001/routes/<route>/plugins \
    --data "name=datadog"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125"

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <datadog-example>
config: 
  host: 127.0.0.1
  port: 8125
plugin: datadog

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

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: <route>
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <datadog-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

For example, configure this plugin on a Route by adding this section to your declarative configuration file:

plugins:
- name: datadog
  route: <route>
  config: 
    host: 127.0.0.1
    port: 8125

<route> is the id or name of the Route that this plugin configuration will target.

Enabling the plugin on a Consumer

Kong Admin API

Kubernetes

Declarative (YAML)

For example, configure this plugin on a Consumer with:

$ curl -X POST http://<admin-hostname>:8001/consumers/<consumer>/plugins \
    --data "name=datadog"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125"

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: <datadog-example>
config: 
  host: 127.0.0.1
  port: 8125
plugin: datadog

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

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: <consumer>
  annotations:
    konghq.com/plugins: <datadog-example>
    kubernetes.io/ingress.class: kong

For example, configure this plugin on a Consumer by adding this section to your declarative configuration file:

plugins:
- name: datadog
  consumer: <consumer>
  config: 
    host: 127.0.0.1
    port: 8125

<consumer> is the id or username of the Consumer that this plugin configuration will target.

Enabling the plugin globally

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.

Kong Admin API

Kubernetes

Declarative (YAML)

For example, configure this plugin globally with:

$ curl -X POST http://<admin-hostname>:8001/plugins/ \
    --data "name=datadog"  \
    --data "config.host=127.0.0.1" \
    --data "config.port=8125"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-datadog>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  host: 127.0.0.1
  port: 8125
plugin: datadog

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: datadog
  config: 
    host: 127.0.0.1
    port: 8125

Parameters

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

Form Parameter	Description
`name` Type: string	The name of the plugin to use, in this case `datadog`.
`service.id` Type: string	The ID of the Service the plugin targets.
`route.id` Type: string	The ID of the Route the plugin targets.
`consumer.id` Type: string	The ID of the Consumer the plugin targets.
`enabled` Type: boolean Default value: `true`	Whether this plugin will be applied.
`config.host` optional Default value: 127.0.0.1	The IP address or host name to send data to.
`config.port` optional Default value: 8125	The port to send data to on the upstream server
`config.metrics` optional Default value: All metrics are logged	List of Metrics to be logged. Available values are described at Metrics.
`config.prefix` optional Default value: kong	String to be attached as prefix to metric’s name.

Metrics

Plugin currently logs the following metrics to the Datadog server about a Service or Route.

Metric	description	namespace
`request_count`	tracks the request	kong.request.count
`request_size`	tracks the request’s body size in bytes	kong.request.size
`response_size`	tracks the response’s body size in bytes	kong.response.size
`latency`	tracks the time interval between the request started and response received from the upstream server	kong.latency
`upstream_latency`	tracks the time it took for the final service to process the request	kong.upstream_latency
`kong_latency`	tracks the internal Kong latency that it took to run all the plugins	kong.kong_latency

The metrics will be sent with the tags name and status carrying the API name and HTTP status code respectively. If you specify consumer_identifier with the metric, a tag consumer will be added.

Metric fields

Plugin can be configured with any combination of Metrics, with each entry containing the following fields.

Field	description	allowed values
`name`	Datadog metric’s name	Metrics
`stat_type`	determines what sort of event the metric represents	`gauge`, `timer`, `counter`, `histogram`, `meter` and `set`
`sample_rate` conditional	sampling rate	`number`
`customer_identifier` conditional	authenticated user detail	`consumer_id`, `custom_id`, `username`
`tags` optional	List of tags	`key[:value]`

Metric requirements

by default all metrics get logged.
metric with stat_type as counter or gauge must have sample_rate defined as well.

Migrating Datadog queries

The plugin updates replace the api, status, and consumer-specific metrics with a generic metric name. You have to change your Datadog queries in dashboards and alerts to reflect the metrics updates.

For example, the following query:

avg:kong.sample_service.latency.avg{*}

would need to change to:

avg:kong.latency.avg{name:sample-service}

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

About this Plugin
Made by
Categories	Analytics & Monitoring
DB-less compatible?	Yes (Kong Gateway only)
Bundled with...
Kong Enterprise 2.2.x 2.1.x 0.36-x 0.35-x 0.34-x 0.33-x 0.32-x 0.31-x Kong Community 2.2.x 2.1.x 2.0.x 1.5.x 1.4.x 1.3.x 1.2.x 1.1.x 1.0.x 0.14.x 0.13.x 0.12.x 0.11.x 0.10.x 0.9.x 0.8.x 0.7.x 0.6.x