OpenTelemetry Configuration

You are browsing unreleased documentation.

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
  • traces_endpoint

    string referenceable

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

  • logs_endpoint

    string referenceable

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

  • 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

  • queue

    record required default: {"max_batch_size"=>200}
    • max_batch_size

      integer default: 1 between: 1 1000000

      Maximum number of entries that can be processed at a time.

    • max_coalescing_delay

      number default: 1 between: 0 3600

      Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.

    • max_entries

      integer default: 10000 between: 1 1000000

      Maximum number of entries that can be waiting on the queue.

    • max_bytes

      integer

      Maximum number of bytes that can be waiting on a queue, requires string content.

    • max_retry_time

      number default: 60

      Time in seconds before the queue gives up calling a failed handler for a batch.

    • initial_retry_delay

      number default: 0.01 between: 0.001 1000000

      Time in seconds before the initial retry is made for a failing batch.

    • max_retry_delay

      number default: 60 between: 0.001 1000000

      Maximum time in seconds between retries, caps exponential backoff.

    • concurrency_limit

      integer default: 1 Must be one of: -1, 1

      The number of of queue delivery timers. -1 indicates unlimited.

  • batch_span_count

    integer default: 200

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

    Deprecation notice: opentelemetry: config.batch_span_count is deprecated, please use config.queue.max_batch_size instead. This field is planned to be removed in version 4.0.

  • batch_flush_delay

    integer default: 3

    The delay, in seconds, between two consecutive batches.

    Deprecation notice: opentelemetry: config.batch_flush_delay is deprecated, please use config.queue.max_coalescing_delay instead. This field is planned to be removed in version 4.0.

  • connect_timeout

    integer default: 1000 between: 0 2147483646

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

  • send_timeout

    integer default: 5000 between: 0 2147483646

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

  • read_timeout

    integer default: 5000 between: 0 2147483646

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

  • http_response_header_for_traceid

    string

  • header_type

    string default: preserve default: preserve Must be one of: preserve, ignore, b3, b3-single, w3c, jaeger, ot, aws, gcp, datadog
    Deprecation notice: opentelemetry: config.header_type is deprecated, please use config.propagation options instead. This field is planned to be removed in version 4.0.

  • sampling_rate

    number between: 0 1

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

  • propagation

    record required default: {"default_format"=>"w3c"}
    • extract

      array of type string Must be one of: gcp, jaeger, aws, ot, w3c, datadog, b3

      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.

    • clear

      array of type 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.

    • inject

      array of type string Must be one of: preserve, gcp, b3-single, jaeger, aws, ot, w3c, datadog, b3

      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.

    • default_format

      string required Must be one of: gcp, b3-single, jaeger, aws, ot, w3c, datadog, b3

      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.

• endpoint

  string referenceable

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

  Deprecation notice: OpenTelemetry: config.endpoint is deprecated, please use config.traces_endpoint instead. This field is planned to be removed in version 4.0.