Configuration

configobject
Hide Child Parameters
connect_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

default_header_typestring

Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.

Allowed values:awsb3b3-singledatadoggcpinstanajaegerotw3c

Default:b3

default_service_namestring

Set a default service name to override unknown-service-name in the Zipkin spans.

header_typestring

All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests

Allowed values:awsb3b3-singledatadoggcpignoreinstanajaegerotpreservew3c

Default:preserve

http_endpointstring

A string representing a URL, such as https://example.com/path/to/resource?q=search.

http_response_header_for_traceidstring
http_span_namestring

Specify whether to include the HTTP path in the span name.

Allowed values:methodmethod_path

Default:method

include_credentialboolean

Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.

Default:true

local_service_namestring

The name of the service as displayed in Zipkin.

Default:kong

phase_duration_flavorstring

Specify whether to include the duration of each phase as an annotation or a tag.

Allowed values:annotationstags

Default:annotations

propagationobject

Default:{"default_format":"b3"}

Hide Child Parameters
cleararray[string]

Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.

default_formatstringrequired

The default header format to use when extractors did not match any format in the incoming headers and inject is configured with the value: preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included in extract.

Allowed values:awsb3b3-singledatadoggcpinstanajaegerotw3c

extractarray[string]

Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.

Allowed values:awsb3datadoggcpinstanajaegerotw3c

injectarray[string]

Header formats used to inject tracing context. The value preserve will use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.

Allowed values:awsb3b3-singledatadoggcpinstanajaegerotpreservew3c

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

read_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:5000

>= 0<= 2147483646

sample_rationumber

How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.

Default:0.001

>= 0<= 1

send_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:5000

>= 0<= 2147483646

static_tagsarray[object]

The tags specified on this property will be added to the generated request traces.

Hide Child Parameters
namestringrequired
valuestringrequired
tags_headerstring

The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.

Default:Zipkin-Tags

traceid_byte_countinteger

The length in bytes of each request’s Trace ID.

Allowed values:816

Default:16

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!