Send Tyk Traces to Dynatrace

​

Prerequisites

• Docker installed on your machine
• Dynatrace account
• Dynatrace Token
• Gateway v5.2.0 or higher
• OTel Collector docker image

​

Instructions

​

Step 1. Generate Dynatrace Token

1. In the Dynatrace console, navigate to access keys.
2. Click on Create a new key
3. You will be prompted to select a scope. Choose Ingest OpenTelemetry traces.
4. Save the generated token securely; it cannot be retrieved once lost. Example of a generated token (taken from Dynatrace website):
   dt0s01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
   

​

Step 2. Configuration Files

1. OTel Collector Configuration File Create a YAML file named otel-collector-config.yml. In this file replace <YOUR-ENVIRONMENT-STRING> with the string from the address bar when you log into Dynatrace. Replace <YOUR-DYNATRACE-API-KEY> with the token you generated earlier. Here’s a sample configuration file:

receivers:
  otlp:
    protocols:
      http:
        endpoint: 0.0.0.0:4318
      grpc:
        endpoint: 0.0.0.0:4317
processors:
  batch:
exporters:
  otlphttp:
    endpoint: "https://<YOUR-ENVIRONMENT-STRING>.live.dynatrace.com/api/v2/otlp"
    headers:
      Authorization: "Api-Token <YOUR-DYNATRACE-API-KEY>" # You must keep 'Api-Token', just modify <YOUR-DYNATRACE-API-KEY>
extensions:
  health_check:
  pprof:
    endpoint: :1888
  zpages:
    endpoint: :55679
service:
  extensions: [pprof, zpages, health_check]
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlphttp]

2. Docker Compose File Create a file named docker-compose.yml. Here is the sample Docker Compose file:

version: "3.9"
services:
  otel-collector:
    image: otel/opentelemetry-collector:latest
    volumes:
      - ./configs/otel-collector-config.yml:/etc/otel-collector.yml
    command: ["--config=/etc/otel-collector.yml"]
    networks:
      - tyk
    ports:
      - "1888:1888" # pprof extension
      - "13133:13133" # health_check extension
      - "4317:4317" # OTLP gRPC receiver
      - "4318:4318" # OTLP http receiver
      - "55670:55679" # zpages extension
networks:
  tyk:

​

Step 3. Testing and Viewing Traces

1. Launch the Docker containers: docker-compose up -d
2. Initialize your Tyk environment.
3. Deploy a simple HTTP API on your Tyk Gateway.
4. Use cURL or Postman to send requests to the Gateway.
5. Navigate to Dynatrace -> Services -> Tyk-Gateway.
6. Wait for 5 minutes and refresh.
7. Traces, along with graphs, should appear. If they don’t, click on the “Full Search” button.

​

Use Dynatrace OneAgent Instead of the OTel Collector

1. Enable the OneAgent OTLP endpoint. In Dynatrace, enable the Extension Execution Controller for your Tyk Gateway hosts. See Use OneAgent with OpenTelemetry data. For an environment-level setup, also turn on the Enable local HTTP Metric, Log and Event Ingest API setting.
2. Configure tracing in Tyk Gateway. Use the http exporter and the OneAgent port. The OneAgent endpoint accepts OTLP over HTTP only. The default port is 14499.
   {
     "opentelemetry": {
       "traces": {
         "enabled": true,
         "exporter": "http",
         "endpoint": "localhost:14499"
       }
     }
   }
   

   See all 9 lines
3. Set the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT environment variable for the Tyk Gateway process.
   OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:14499/otlp/v1/traces
   
   Tyk Gateway uses only the host and port from opentelemetry.traces.endpoint, and sends traces to the /v1/traces path. The OneAgent endpoint uses the /otlp/v1/traces path. This environment variable sets the correct path.
4. Restart Tyk Gateway.

​

Trace Retention in Dynatrace

​

Troubleshooting

• try clicking on the “Full Search” button after waiting for 5 minutes.
• Make sure your Dynatrace token is correct in the configuration files.
• Validate the Docker Compose setup by checking the logs for any errors: docker-compose logs