Open Tracing

Last updated: Sep 13, 2023 1 minute read.

Deprecation

OpenTracing is now deprecated. We have introduced support of OpenTelemetry in v5.2. We recommend users to migrate to OpenTelemetry for better supports of your tracing needs.

Supported observability tools

Jaeger
Zipkin
New Relic

Enabling OpenTracing

To enable OpenTracing, add the following tracing configuration to your Gateway tyk.conf file.

{
  "tracing": {
    "enabled": true,
    "name": "${tracer_name}",
    "options": {}
  }
}

name is the name of the supported tracer
enabled: set this to true to enable tracing
options: key/value pairs for configuring the enabled tracer. See the supported tracer documentation for more details.

Tyk will automatically propagate tracing headers to APIs when tracing is enabled.