Configure Telemetry in Tyk Cloud

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

• Distributed Traces: Track request flow, identify bottlenecks, and troubleshoot issues.
• Gateway Metrics: Export RED (Rate, Error, Duration) metrics to monitor API performance.
• Application Logs: Stream application logs in real time to your configured provider.

​

Available Telemetry Providers

• Datadog
• Dynatrace
• New Relic
• Elastic
• Custom

​

Instructions

1. Configure a provider at the organization level.
2. Enable telemetry export on a Cloud Data Plane.

​

Step 1: Configure a telemetry provider

1. In the Tyk Cloud Console, select Telemetry. A grid shows all supported providers.
   Only one provider can be configured at a time.
   
2. Click your preferred provider to open its configuration form.
3. Configure the following settings shared by all providers:
   • Connection Toggle: Activates or deactivates telemetry export. When enabled, Tyk sends monitoring data to your chosen platform.
   • Sampling Rate: Percentage of API traffic to send (default: 10%, meaning one in every ten API calls).
4. Optionally configure:
   • Tags to Add to the Traces: Custom labels that make telemetry data easier to filter and analyze. For example:
     environment: production
     region: europe
     team: api-gateway
     
   • Fields to Filter: Fields to exclude from telemetry, useful for preventing sensitive data from reaching your monitoring platform.
5. Configure the provider-specific connection settings:
   • Datadog
   • Dynatrace
   • New Relic
   • Elastic
   • Custom

   • Provider Site: Your Datadog URL (for example, us5.datadoghq.com). See Datadog site documentation.
   • API Key: Your Datadog API key. See Datadog API key documentation.
     Provider Site: us5.datadoghq.com
     API Key: your-datadog-api-key
     
     

   • Provider Endpoint: Your Dynatrace environment URL. See Dynatrace environment documentation.
   • API Token: Your Dynatrace access token. See Dynatrace access token documentation.
     Provider Endpoint: https://<YOUR-ENVIRONMENT-STRING>.live.dynatrace.com/api/v2/otlp
     API Token: your-dynatrace-token
     
     

   • Provider Endpoint: Your New Relic HTTP endpoint. See New Relic endpoint documentation.
   • API Token: Your New Relic license key. See New Relic API key documentation.
     Provider Endpoint: https://security-api.newrelic.com/security/v1
     API Token: your-newrelic-api-key
     
     

   • Provider Endpoint: Your Elastic APM server address.
   • Secret Token: Your Elastic APM authentication token. See Elastic secret token documentation.
     Provider Endpoint: https://your-elastic-cluster:8200
     Secret Token: your-elastic-secret-token
     
     

   • Exporter: Choose gRPC or HTTP.
   • Provider Endpoint: Your monitoring system URL.
   • Authorization: Configure authentication for your monitoring system.
     Exporter: gRPC
     Provider Endpoint: grpc://your-collector:4317
     Authorization Header Name: Authorization
     Authorization Header Value: Bearer your-token
     
     

​

Step 2: Enable telemetry export on a Cloud Data Plane

1. Navigate to your Cloud Data Plane deployment (create new or edit existing).
2. In the telemetry export section, enable the types you want:
   • Enable Traces: Enable distributed tracing.
   • Enable Metrics: Enable gateway metrics export (requires Gateway v5.13.0 or later). See Default Metrics Exported for what is included.
   • Enable Logs: Enable real-time application log streaming.
3. If traces are enabled, optionally set a Sampling Rate Override to control what percentage of trace data to export (default: 10%). This setting applies to traces only — not metrics or logs.
   The sampling rate can be set at the organization level and overridden per Cloud Data Plane. The Cloud Data Plane setting takes precedence.
4. Save and redeploy the Cloud Data Plane.
5. In the deployment overview, confirm that Telemetry Export shows as enabled:

​

Default Metrics Exported