New Relic

Last updated: 1 minute read.

How to send Tyk Gateway traces to New Relic

Tyk uses OpenTracing to send Tyk Gateway traces to <em>New Relic</em> using the Zipkin format.
Support for OpenTelemetry is on the near-term roadmap for us. More information can be found on this community post.

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.

Configuring New Relic

In tyk.conf under the tracing section

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

In the options setting you can set the initialisation of 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"
      }
    }
  }
}

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