Enrich OTLP with OneAgent data (non-containerized)

How-to guide
2-min read

The following configuration example shows how you configure a Collector instance to enrich OpenTelemetry data with OneAgent host entities.

Enrichment is used for linking OpenTelemetry data to its OneAgent host and properly associating it within the topology model. For example, when ingesting logs from different hosts, tying the host entity to the respective log data allows you to run host-based log analytics tasks.

Container environments

Enrichment is specific to non-container OneAgent environments. Configuring a containerized Collector enrichment setup may lead to incorrect host and topology associations.

Prerequisites

One of the following Collector distributions with the Resource Detection processor:
- The Dynatrace OTel Collector
- OpenTelemetry Contrib
- A custom Builder version
A OneAgent running on the same host as the OTel Collector, where the OneAgent monitors in either Full-Stack, Infrastructure, or Foundation & Discovery mode.
The Dynatrace API endpoint URL to which the data should be exported, configured as system environment variable
An API token with the relevant access scope (only required for SaaS and ActiveGate), configured as system environment variable

See Collector Deployment and Collector Configuration on how to set up your Collector with the configuration below.

Demo configuration

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  resource_detection/dynatrace:
    detectors: [dynatrace]
    override: false

exporters:
  otlp_http:
    endpoint: ${env:DT_ENDPOINT}
    headers:
      Authorization: "Bearer ${env:DT_PLATFORM_TOKEN}"

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [resource_detection/dynatrace]
      exporters: [otlp_http]
    metrics:
      receivers: [otlp]
      processors: [resource_detection/dynatrace]
      exporters: [otlp_http]
    logs:
      receivers: [otlp]
      processors: [resource_detection/dynatrace]
      exporters: [otlp_http]

Assign the scope that matches your signal type: openpipeline:logs:ingest for logs, openpipeline:metrics:ingest for metrics, or openpipeline:traces:ingest for traces.

Configuration validation

Validate your settings to avoid any configuration issues.

Components

For our configuration, we configure the following components.

Receivers

Under receivers, we specify the standard otlp receiver as active receiver component for our Collector instance.

This is mainly for demonstration purposes. You can specify any other valid receiver here (for example, zipkin).

Processors

Under processors, we specify the resource_detection processor and configure it with the Dynatrace-specific detector dynatrace.

With this configuration, the resource detector processor will attempt to load the following three attributes from the OneAgent enrichment file:

dt.entity.host
host.name
dt.smartscape.host

If the resource detector could load these values successfully, it will add them as resource attributes to the OTLP request. No additional processor configuration is necessary.

Exporters

Under exporters, we specify the default otlp_http exporter and configure it with our Dynatrace API URL and the required authentication token.

For this purpose, we set the following two environment variables and reference them in the configuration values for endpoint and headers.

DT_ENDPOINT contains the base URL of the Dynatrace API endpoint (for example, https://{your-environment-id}.live.dynatrace.com/api/v2/otlp).
One token variable, depending on the token type you use:
- Platform token: DT_PLATFORM_TOKEN contains your platform token with the openpipeline:logs:ingest, openpipeline:metrics:ingest, and openpipeline:traces:ingest scopes.
- Classic access token: DT_API_TOKEN contains your Classic access token with the Ingest logs (logs.ingest), Ingest metrics (metrics.ingest), and Ingest OpenTelemetry traces (openTelemetryTrace.ingest) scopes.

Service pipeline

Under service, we assemble our receiver, processor, and exporter objects into service pipelines, which will perform these steps:

accept OTLP requests on the configured ports
enrich them with the Dynatrace-relevant host data, using the resource detector processor
and export the enriched data to Dynatrace