OpenTelemetry

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

batch_flush_delayinteger

The delay, in seconds, between two consecutive batches.

batch_span_countinteger

The number of spans to be sent in a single batch.

connect_timeoutinteger

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

Default:1000

>= 0<= 2147483646

header_typestring

Allowed values:awsb3b3-singledatadoggcpignoreinstanajaegerotpreservew3c

Default:preserve

headersobject

The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.

* Additional properties are allowed.

http_response_header_for_traceidstring

logs_endpointstring

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

propagationobject

Default:{"default_format":"w3c"}

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

Default:{"max_batch_size":200}

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

resource_attributesobject

* Additional properties are allowed.

sampling_ratenumber

Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_rate setting from kong.conf.

>= 0<= 1

sampling_strategystring

The sampling strategy to use for OTLP traces. Set parent_drop_probability_fallback if you want parent-based sampling when the parent span contains a false sampled flag, and fallback to probability-based sampling otherwise. Set parent_probability_fallback if you want parent-based sampling when the parent span contains a valid sampled flag (true or false), and fallback to probability-based sampling otherwise.

Allowed values:parent_drop_probability_fallbackparent_probability_fallback

Default:parent_drop_probability_fallback

send_timeoutinteger

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

Default:5000

>= 0<= 2147483646

traces_endpointstring

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

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 set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

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

OpenTelemetry

Configuration

Did this doc help?

Help us make these docs great!

Still need help