Datadog

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

consumer_tagstring

String to be attached as tag of the consumer.

Default:consumer

flush_timeoutnumber

Optional time in seconds. If queue_size > 1, this is the max idle time before sending a log with less than queue_size records.

hoststring

A string representing a host name, such as example.com.
This field is referenceable.

Default:localhost

metricsarray[object]

List of metrics to be logged.

Default:{"consumer_identifier":"custom_id","name":"kong_latency","sample_rate":1,"stat_type":"timer","tags":["app:kong"]}

Hide Child Parameters

consumer_identifierstring

Authenticated user detail

Allowed values:consumer_idcustom_idusername

namestringrequired

Datadog metric’s name

Allowed values:kong_latencylatencyrequest_countrequest_sizeresponse_sizeupstream_latency

sample_ratenumber

Sampling rate

>= 0<= 1

stat_typestringrequired

Determines what sort of event the metric represents

Allowed values:counterdistributiongaugehistogrammetersettimer

tagsarray[string]

List of tags

Match pattern:^.*[^:]$

portinteger

An integer representing a port number between 0 and 65535, inclusive.

Default:8125

>= 0<= 65535

prefixstring

String to be attached as a prefix to a metric’s name.

Default:kong

queueobject

Hide Child Parameters

concurrency_limitinteger

The number of of queue delivery timers. -1 indicates unlimited.

Allowed values:-11

Default:1

initial_retry_delaynumber

Time in seconds before the initial retry is made for a failing batch.

Default:0.01

>= 0.001<= 1000000

max_batch_sizeinteger

Maximum number of entries that can be processed at a time.

Default:1

>= 1<= 1000000

max_bytesinteger

Maximum number of bytes that can be waiting on a queue, requires string content.

max_coalescing_delaynumber

Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.

Default:1

>= 0<= 3600

max_entriesinteger

Maximum number of entries that can be waiting on the queue.

Default:10000

>= 1<= 1000000

max_retry_delaynumber

Maximum time in seconds between retries, caps exponential backoff.

Default:60

>= 0.001<= 1000000

max_retry_timenumber

Time in seconds before the queue gives up calling a failed handler for a batch.

Default:60

queue_sizeinteger

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

retry_countinteger

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

service_name_tagstring

String to be attached as the name of the service.

Default:name

status_tagstring

String to be attached as the tag of the HTTP status.

Default:status

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Datadog

Configuration

Did this doc help?

Help us make these docs great!

Still need help