OpenTelemetry trace ingest API

Ingests OpenTelemetry traces to Dynatrace. Use this endpoint as a target for OpenTelemetry exporters. For more information, see Export with OTLP.

The request consumes an application/x-protobuf payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/otlp/v1/traces
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/otlp/v1/traces

Authentication

To execute this request, you need an access token with openTelemetryTrace.ingest scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
body
byte[]
An ExportTraceServiceRequest message in binary protobuf format.
body
required

Response

Response codes

Code
Type
Description
200
-

The request has been received and will be processed.

400
-

The request could not be processed. This may happen if the message is malformed.

413
-

The OTLP message exceeded the payload size limit.

415
-

The request was sent with an unsupported content type. This API supports requests in binary protobuf format with content type application/x-protobuf.

500
-

The request could not be processed due to an internal server error.

503
-

The service is currently unavailable.

4XX

Client side error.

5XX

Server side error.

Limitations

  • The search of traces/spans by OpenTelemetry resources attribute is limited to the service.name. Use the Service name filter on the Distributed traces page.
  • The search of traces/spans by OpenTelemetry span attribute is limited to the span name. Use the Request filter on the Distributed traces page.

OneAgent endpoint

In addition to the OpenTelemetry trace ingest API, OneAgent also provides a local-only OpenTelemetry endpoint for trace ingestion.

This endpoint address is http://localhost:14499/otlp/v1/traces at the default TCP port 14499 (configurable via oneagentctl) and requires a POST request.

Enable the endpoint

The endpoint is disabled by default.

  1. Go to Settings and select Preferences > Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.
  3. Turn on Enable local HTTP Metric, Log and Event Ingest API.
  1. Go to Deployment Status and then select OneAgents.
  2. On the OneAgent deployment page, turn off Show new OneAgent deployments.
  3. Filter the table by Host group and select the host group you want to configure.

    The Host group property is not displayed when the selected host doesn't belong to any host group.

    This displays the OneAgent deployment page filtered by the selected host group. Each listed host has a Host group: <group name> link, where <group name> is the name of the host group that you want to configure.
  4. Select the host group name in any row.
    As you have filtered by host group, all displayed hosts go to the same host group.
  1. In the host group settings, select Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.
  1. Go to Hosts or Hosts Classic (latest Dynatrace).
  2. Find and select your host to display the host overview page.
  3. In the upper-right corner of the host overview page, select More (…) > Settings.
  1. In the host settings, select Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.

Comparison of ingestion API and OneAgent endpoint

Ingestion API

OneAgent endpoint

  • Supports all OpenTelemetry signals (traces, metrics, logs)
  • No automatic information enrichment
  • SSL and authentication
  • Automatic information enrichment
  • No support for metrics and logs (only traces)
  • No authentication

Related topics