You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The OpenTelemetry plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
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
opentelemetry
.- 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
-
boolean default:
true
Whether this plugin will be applied.
-
record required
-
string required
The full HTTP(S) endpoint that Kong Gateway should send OpenTelemetry spans to. The endpoint must be a OTLP/HTTP endpoint.
-
map
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.
-
map
The attributes specified on this property are added to the OpenTelemetry resource object. Kong follows the OpenTelemetry specification for Semantic Attributes.
The following attributes are automatically added to the resource object:
-
service.name
: The name of the service. This iskong
by default. -
service.version
: The version of Kong Gateway. -
service.instance.id
: The node id of Kong Gateway.
The default values for the above attributes can be overridden by specifying them in this property. For example, to override the default value of
service.name
tomy-service
, you can specify{ "service.name": "my-service" }
. -
-
integer required default:
200
The number of spans to be sent in a single batch.
-
integer required default:
3
The delay, in seconds, between two consecutive batches.
-
integer default:
1000
between:0
2147483646
The timeout, in milliseconds, for the OTLP server connection.
-
integer default:
5000
between:0
2147483646
The timeout, in milliseconds, for sending spans to the OTLP server.
-
integer default:
5000
between:0
2147483646
The timeout, in milliseconds, for reading the response from the OTLP server.
-