OpenTelemetry Configuration

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:

• name or plugin

  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.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example opentelemetry_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/{consumerName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • endpoint

    string required

    The full HTTP(S) endpoint that Kong Gateway should send OpenTelemetry spans to. The endpoint must be a OTLP/HTTP endpoint.

  • headers

    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.

  • resource_attributes

    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 is kong 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 to my-service, you can specify { "service.name": "my-service" }.

  • batch_span_count

    integer

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

  • batch_flush_delay

    integer

    The delay, in seconds, between two consecutive batches.

  • queue

    record required

    Configuration parameters for queue

    • max_batch_size

      number default: 1 between: 1 1000000

      Maximum number of entries to be processed together as a batch.

    • max_coalescing_delay

      number default: 1 between: 0 3600

      Maximum number of seconds (as a fraction) that can elapse after the first entry was queued before the queue starts processing entries. This parameter has no effect when batch_max_size is one because queued entries will be sent immediately in that case.

    • max_entries

      number default: 10000 between: 1 1000000

      Maximum number of entries that can be waiting on the queue. Once this number of requests is reached, the oldest entry is deleted from the queue before a new one is added.

    • max_bytes

      number

      Maximum number of bytes that can be waiting on a queue. Once this many bytes are present on a queue, old entries up to the size of a new entry to be enqueued are deleted from the queue.

    • max_retry_time

      number default: 60

      Time (in seconds) before the queue gives up trying to send a batch of entries. Once this time is exceeded for a batch, it is deleted from the queue without being sent. If this parameter is set to -1, no retries will be made for a failed batch.

    • initial_retry_delay

      number default: 0.01

    • max_retry_delay

      number default: 60

      Maximum time (in seconds) between retries sending a batch of entries. The interval between retries follows an exponential back-off algorithm capped at this number of seconds.

  • connect_timeout

    integer default: 1000 between: 0 2147483646

    The timeout, in milliseconds, for the OTLP server connection.

  • send_timeout

    integer default: 5000 between: 0 2147483646

    The timeout, in milliseconds, for sending spans to the OTLP server.

  • read_timeout

    integer default: 5000 between: 0 2147483646

    The timeout, in milliseconds, for reading the response from the OTLP server.

  • http_response_header_for_traceid

    string

  • header_type

    string default: preserve Must be one of: preserve, ignore, b3, b3-single, w3c, jaeger, ot

    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.

    Possible values: b3, b3-single, w3c, preserve, jaeger, ot, or ignore.