• Docker
• Docker Compose v2.0.0+
• Make (optional)

• Kubernetes 1.24+
• Helm 3.9+
• An active Kubernetes cluster with kubectl configured to connect to it

1. Open the demo repository. Create a file called docker-compose.override.yml in the root folder.

2. Open the created file. Paste the following content and set the Datadog site and Datadog API key environment variables:

   services: 
     otelcol:
       command: 
         - "--config=/etc/otelcol-config.yml"
         - "--config=/etc/otelcol-config-extras.yml"
         - "--feature-gates=exporter.datadogexporter.UseLogsAgentExporter"
       environment:
         - DD_SITE_PARAMETER=<Your API Site>
         - DD_API_KEY=<Your API Key>
   

3. To configure the OpenTelemetry Collector, open src/otelcollector/otelcol-config-extras.yml and add the following to the file:

   exporters:
     datadog:
       traces:
         span_name_as_resource_name: true
         trace_buffer: 500
       hostname: "otelcol-docker"
       api:
         site: ${env:DD_SITE_PARAMETER}
         key: ${env:DD_API_KEY}
   
   processors:
     resource:
       attributes:
         - key: deployment.environment
           value: "otel"
           action: upsert
   
   connectors:
     datadog/connector:
       traces:
         span_name_as_resource_name: true
   
   service:
     pipelines:
       traces:
         processors: [resource, batch]
         exporters: [otlp, debug, spanmetrics, datadog, datadog/connector]
       metrics:
         receivers: [docker_stats, httpcheck/frontendproxy, otlp, prometheus, redis, spanmetrics, datadog/connector]
         processors: [resource, batch]
         exporters: [otlphttp/prometheus, debug, datadog]
       logs:
         processors: [resource, batch]
         exporters: [opensearch, debug, datadog]
   

   By default, the collector in the demo application merges the configuration from two files:

   • src/otelcollector/otelcol-config.yml: contains the default configuration for the collector.
   • src/otelcollector/otelcol-config-extras.yml: used to add extra configuration to the collector.
   When merging YAML values, objects are merged and arrays are replaced. That's why there are more components specified in the pipelines than actually configured. The previous configuration does not replace the values configured in the main otelcol-config file.

1. Create a secret named dd-secrets to store Datadog Site and API Key secrets:

   kubectl create secret generic dd-secrets --from-literal="DD_SITE_PARAMETER=<Your API Site>" --from-literal="DD_API_KEY=<Your API Key>"
   

2. Add the OpenTelemetry Helm chart to your repo to manage and deploy the OpenTelemetry Demo:

   helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
   

3. Create a file named my-values-file.yml with the following content:

   opentelemetry-collector:
     extraEnvsFrom:
       - secretRef:
           name: dd-secrets
     config:
       exporters:
         datadog:
           traces:
             span_name_as_resource_name: true
             trace_buffer: 500
           hostname: "otelcol-helm"
           api:
             site: ${DD_SITE_PARAMETER}
             key: ${DD_API_KEY}
   
       processors:
         resource:
           attributes:
             - key: deployment.environment
               value: "otel"
               action: upsert
   
       connectors:
         datadog/connector:
           traces:
             span_name_as_resource_name: true
   
       service:
         pipelines:
           traces:
             processors: [resource, batch]
             exporters: [otlp, debug, spanmetrics, datadog, datadog/connector]
           metrics:
             receivers: [httpcheck/frontendproxy, otlp, redis, spanmetrics, datadog/connector]
             processors: [resource, batch]
             exporters: [otlphttp/prometheus, debug, datadog]
           logs:
             processors: [resource, batch]
             exporters: [opensearch, debug, datadog]
   

   When merging YAML values, objects are merged and arrays are replaced. That's why there are more components specified in the pipelines than actually configured. The previous configuration does not replace the values configured in the main otelcol-config file.

If you have make installed, you can use the following command to start the demo:

make start

If you don’t have make installed, you can use the the docker compose command directly:

docker compose up --force-recreate --remove-orphans --detach

To deploy the demo application on Kubernetes using Helm, run the following command:

helm install my-otel-demo open-telemetry/opentelemetry-demo --values my-values-file.yml

Go to http://localhost:8080.

1. If you are running a local cluster, you need to port forward the frontend proxy:

   kubectl port-forward svc/my-otel-demo-frontendproxy 8080:8080
   

2. Go to http://localhost:8080.