Zipkin

Last updated: Dec 18, 2023 1 minute read.

How to send Tyk Gateway traces to Zipkin

Tyk uses OpenTracing with the Zipkin Go tracer to send Tyk Gateway traces to Zipkin. Support for OpenTelemetry is on the near-term roadmap for us. More information can be found on this community post.

Note

The CNCF (Cloud Native Foundation) has archived the OpenTracing project. This means that no new pull requests or feature requests are accepted into OpenTracing repositories.

While support for OpenTelemetry is on our near-term roadmap, you can continue to leverage OpenTracing to get timing and data from Tyk in your traces.

Configuring Zipkin

In tyk.conf on tracing setting

{
  "tracing": {
    "enabled": true,
    "name": "zipkin",
    "options": {}
  }
}

options are settings that are used to initialise the Zipkin client.

Sample configuration

{
  "tracing": {
    "enabled": true,
    "name": "zipkin",
    "options": {
      "reporter": {
        "url": "http:localhost:9411/api/v2/spans"
      }
    }
  }
}

reporter.url is the URL to the Zipkin server, where trace data will be sent.