You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Datadog 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
datadog
.- 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
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 to send data to.
-
integer default:
8125
between:0
65535
The port to send data to on the upstream server.
-
string default:
kong
String to be attached as a prefix to a metric’s name.
-
string default:
name
String to be attached as the name of the service.
-
string default:
status
String to be attached as the tag of the HTTP status.
-
string default:
consumer
String to be attached as tag of the consumer.
-
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.
-
array of type
record
required default:{"consumer_identifier"=>"custom_id", "tags"=>["app:kong"], "sample_rate"=>1, "name"=>"request_count", "stat_type"=>"counter"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"latency"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"request_size"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"response_size"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"upstream_latency"}, {"tags"=>["app:kong"], "consumer_identifier"=>"custom_id", "stat_type"=>"timer", "name"=>"kong_latency"}
List of metrics to be logged. Available values are described at Metrics. By default, the plugin logs all available metrics. If you specify an array of metrics, only the listed metrics are logged.
-
string required Must be one of:
kong_latency
,latency
,request_count
,request_size
,response_size
,upstream_latency
-
string required Must be one of:
counter
,gauge
,histogram
,meter
,set
,timer
,distribution
-
array of type
string
-
number between:
0
1
-
string Must be one of:
consumer_id
,custom_id
,username
-
-