OpenTelemetry Configuration

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

  string required

  The name of the plugin, in this case opentelemetry.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example opentelemetry_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• 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/SERVICE_NAME|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/ROUTE_NAME|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/CONSUMER_NAME|ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • endpoint

    string required 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

    Attributes to add to the OpenTelemetry resource object, following the spec for Semantic Attributes. The following attributes are automatically added:

    • service.name: The name of the service (default: kong).
    • service.version: The version of Kong Gateway.
    • service.instance.id: The node ID of Kong Gateway.

    You can use this property to override default attribute values. For example, to override the default for service.name, you can specify { "service.name": "my-service" }.

  • queue

    record required
    • 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.

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

  • 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

    Specifies a custom header for the trace_id. If set, the plugin sets the corresponding header in the response.

  • header_type

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

    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.