Zipkin Configuration

You are browsing unreleased documentation.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Zipkin plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

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

  • 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 zipkin_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
  • local_service_name

    string required default: kong

    The name of the service as displayed in Zipkin.

  • http_endpoint

    string

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

  • sample_ratio

    number default: 0.001 between: 0 1

    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.

  • default_service_name

    string

    Set a default service name to override unknown-service-name in the Zipkin spans.

  • include_credential

    boolean required default: true

    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.

  • traceid_byte_count

    integer required default: 16 Must be one of: 8, 16

    The length in bytes of each request’s Trace ID.

  • header_type

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

    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

    Deprecation notice: zipkin: config.header_type is deprecated, please use config.propagation options instead. This field is planned to be removed in version 4.0.

  • default_header_type

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

    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.

    Deprecation notice: zipkin: config.default_header_type is deprecated, please use config.propagation.default_format instead. This field is planned to be removed in version 4.0.

  • tags_header

    string required default: Zipkin-Tags

    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.

  • static_tags

    array of type record

    The tags specified on this property will be added to the generated request traces.

    • name

      string required

    • value

      string required

  • http_span_name

    string required default: method Must be one of: method, method_path

    Specify whether to include the HTTP path in the span name.

  • connect_timeout

    integer default: 2000 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

  • phase_duration_flavor

    string required default: annotations Must be one of: annotations, tags

    Specify whether to include the duration of each phase as an annotation or a tag.

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

    • concurrency_limit

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

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

  • propagation

    record required default: {"default_format"=>"b3"}
    • 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.