Configuration

configobject
Hide Child Parameters
allow_status_codesarray[string]

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

Match pattern:^[0-9]+-[0-9]+$

consumer_identifier_defaultstring

Allowed values:consumer_idcustom_idusername

Default:custom_id

flush_timeoutnumber
hoststring

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

Default:localhost

hostname_in_prefixboolean

Default:false

metricsarray[object]

List of metrics to be logged.

Default:{"name":"cache_datastore_misses_total","sample_rate":1,"stat_type":"counter"}

Hide Child Parameters
consumer_identifierstring

Authenticated user detail.

Allowed values:consumer_idcustom_idusername

namestringrequired

StatsD metric’s name.

Allowed values:cache_datastore_hits_totalcache_datastore_misses_totalkong_latencylatencyrequest_countrequest_per_userrequest_sizeresponse_sizeshdict_usagestatus_countstatus_count_per_userstatus_count_per_user_per_routestatus_count_per_workspaceunique_usersupstream_latency

sample_ratenumber

Sampling rate

>= 0

service_identifierstring

Service detail.

Allowed values:service_hostservice_idservice_nameservice_name_or_host

stat_typestringrequired

Determines what sort of event a metric represents.

Allowed values:countergaugehistogrammetersettimer

workspace_identifierstring

Workspace detail.

Allowed values:workspace_idworkspace_name

portinteger

The port of StatsD server to send data to.

Default:8125

>= 0<= 65535

prefixstring

String to prefix to each 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
retry_countinteger
service_identifier_defaultstring

Allowed values:service_hostservice_idservice_nameservice_name_or_host

Default:service_name_or_host

tag_stylestring

Allowed values:dogstatsdinfluxdblibratosignalfx

udp_packet_sizenumber

Default:0

>= 0<= 65507

use_tcpboolean

Default:false

workspace_identifier_defaultstring

Allowed values:workspace_idworkspace_name

Default:workspace_id

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

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!