Login 24/7 Support Community tyk.io

New Relic

Why should you use the Trace API?

  • You have your own custom distributed tracing tool and want to see that data in New Relic without changing your instrumentation.
  • You have a tool that emits tracing data but that requires a backend for trace storage.
  • You want to report distributed tracing data to New Relic without the use of other installed solutions.
  • You use Zipkin and want to see that trace data in New Relic without changing your instrumentation.

Configuring

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": "https://trace-api.newrelic.com/trace/v1?Api-Key=NEW_RELIC_LICENSE_KEY&Data-Format=zipkin&Data-Format-Version=2"
      }
    }
  }
}

Note

Based on Trace API compatibility with Zipkin, you can use send tracing data to New relic by enabling zipkin opentracing.

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