Pour exécuter l’OpenTelemetry Collector en tant qu’image Docker et recevoir des traces depuis le même host :

1. Choisissez une image Docker publiée telle que otel/opentelemetry-collector-contrib.

2. Déterminez quels ports ouvrir sur votre conteneur afin que les traces OpenTelemetry soient envoyées à l’OpenTelemetry Collector. Par défaut, les traces sont envoyées via gRPC sur le port 4317. Si vous n’utilisez pas gRPC, utilisez le port 4318.

3. Exécutez le conteneur et exposez le port nécessaire, en utilisant le fichier collector.yaml. Par exemple, si vous utilisez le port 4317 :

   $ docker run \
       -p 4317:4317 \
       --hostname $(hostname) \
       -v $(pwd)/otel_collector_config.yaml:/etc/otelcol-contrib/config.yaml \
       otel/opentelemetry-collector-contrib
   

Pour exécuter le Collector OpenTelemetry en tant qu’image Docker et recevoir des traces d’autres conteneurs :

1. Créez un réseau Docker :

   docker network create <NETWORK_NAME>
   

2. Exécutez l’OpenTelemetry Collector et les conteneurs d’application au sein du même réseau.

   # Run the OpenTelemetry Collector
   docker run -d --name opentelemetry-collector \
       --network <NETWORK_NAME> \
       --hostname $(hostname) \
       -v $(pwd)/otel_collector_config.yaml:/etc/otelcol-contrib/config.yaml \
       otel/opentelemetry-collector-contrib
   

   Lors de l’exécution du conteneur d’application, assurez-vous que la variable d’environnement OTEL_EXPORTER_OTLP_ENDPOINT est configurée pour utiliser le nom de host approprié pour l’OpenTelemetry Collector. Dans l’exemple ci-dessous, il s’agit de opentelemetry-collector.

   # Run the application container
   docker run -d --name app \
       --network <NETWORK_NAME> \
       --hostname $(hostname) \
       -e OTEL_EXPORTER_OTLP_ENDPOINT=http://opentelemetry-collector:4317 \
       company/app:latest
   

L’utilisation d’un DaemonSet est le moyen le plus courant et recommandé pour configurer la collecte OpenTelemetry dans un environnement Kubernetes. Pour déployer l’OpenTelemetry Collector et le Datadog Exporter dans une infrastructure Kubernetes :

1. Utilisez cet exemple de configuration, incluant la configuration de l’application, pour configurer l’OpenTelemetry Collector avec le Datadog Exporter en tant que DaemonSet.

2. Assurez-vous que les ports essentiels pour le DaemonSet sont exposés et accessibles à votre application. Les options de configuration suivantes issues de l’exemple définissent ces ports :

   # ...
        ports:
        - containerPort: 4318 # default port for OpenTelemetry HTTP receiver.
          hostPort: 4318
        - containerPort: 4317 # default port for OpenTelemetry gRPC receiver.
          hostPort: 4317
        - containerPort: 8888  # Default endpoint for querying Collector observability metrics.
   # ...
   

   Si votre application ne nécessite pas à la fois HTTP et gRPC, supprimez les ports inutilisés de la configuration.

3. Pour collecter des attributs Kubernetes précieux, qui sont utilisés pour le marquage des conteneurs Datadog, rapportez l’IP du Pod en tant qu’attribut de ressource, comme indiqué dans l’exemple :

   # ...
           env:
           - name: POD_IP
             valueFrom:
               fieldRef:
                 fieldPath: status.podIP
           # The k8s.pod.ip is used to associate pods for k8sattributes
           - name: OTEL_RESOURCE_ATTRIBUTES
             value: "k8s.pod.ip=$(POD_IP)"
   # ...
   

   Cela garantit que le processeur d’attributs Kubernetes, qui est utilisé dans la config map, est capable d’extraire les métadonnées nécessaires pour les associer aux traces. Il existe des rôles supplémentaires qui doivent être définis pour permettre l’accès à ces métadonnées. L’exemple est complet, prêt à l’emploi et dispose des rôles correctement configurés.

4. Configurez votre conteneur d’application pour utiliser le nom de host d’endpoint OTLP correct. Comme l’OpenTelemetry Collector s’exécute en tant que DaemonSet, le host actuel doit être ciblé. Définissez la variable d’environnement OTEL_EXPORTER_OTLP_ENDPOINT de votre conteneur d’application en conséquence, comme dans le graphique d’exemple :

   # ...
           env:
           - name: HOST_IP
             valueFrom:
               fieldRef:
                 fieldPath: status.hostIP
             # The application SDK must use this environment variable in order to successfully
             # connect to the DaemonSet's collector.
           - name: OTEL_EXPORTER_OTLP_ENDPOINT
             value: "http://$(HOST_IP):4318"
   # ...
   

5. Configurez la collecte des métadonnées du host pour garantir des informations de host précises. Configurez votre DaemonSet pour collecter et transférer les métadonnées du host :

   processors:
     resourcedetection:
       detectors: [system, env]
     k8sattributes:
       # existing k8sattributes config
     transform:
       trace_statements:
         - context: resource
           statements:
             - set(attributes["datadog.host.use_as_metadata"], true)
   ...
   service:
     pipelines:
       traces:
         receivers: [otlp]
         processors: [resourcedetection, k8sattributes, transform, batch]
         exporters: [datadog]
   

Cette configuration collecte les métadonnées du host à l’aide du processeur resourcedetection, ajoute les métadonnées Kubernetes avec le processeur k8sattributes et définit l’attribut datadog.host.use_as_metadata sur true. Pour plus d’informations, consultez Mappage des conventions sémantiques OpenTelemetry aux informations des hosts de la liste des infrastructures.

Pour déployer le Collector OpenTelemetry et l’exportateur Datadog dans un déploiement Kubernetes en tant que passerelle :

1. Utilisez cet exemple de configuration, incluant la configuration de l’application, pour configurer l’OpenTelemetry Collector avec le Datadog Exporter en tant que DaemonSet.

2. Assurez-vous que les ports essentiels pour le DaemonSet sont exposés et accessibles à votre application. Les options de configuration suivantes issues de l’exemple définissent ces ports :

   # ...
        ports:
        - containerPort: 4318 # default port for OpenTelemetry HTTP receiver.
          hostPort: 4318
        - containerPort: 4317 # default port for OpenTelemetry gRPC receiver.
          hostPort: 4317
        - containerPort: 8888  # Default endpoint for querying Collector observability metrics.
   # ...
   

   Si votre application ne nécessite pas à la fois HTTP et gRPC, supprimez les ports inutilisés de la configuration.

3. Pour collecter des attributs Kubernetes précieux, qui sont utilisés pour le marquage des conteneurs Datadog, rapportez l’IP du Pod en tant qu’attribut de ressource, comme indiqué dans l’exemple :

   # ...
           env:
           - name: POD_IP
             valueFrom:
               fieldRef:
                 fieldPath: status.podIP
           # The k8s.pod.ip is used to associate pods for k8sattributes
           - name: OTEL_RESOURCE_ATTRIBUTES
             value: "k8s.pod.ip=$(POD_IP)"
   # ...
   

   Cela garantit que le processeur d’attributs Kubernetes, qui est utilisé dans la config map, est capable d’extraire les métadonnées nécessaires pour les associer aux traces. Il existe des rôles supplémentaires qui doivent être définis pour permettre l’accès à ces métadonnées. L’exemple est complet, prêt à l’emploi et dispose des rôles correctement configurés.

4. Configurez votre conteneur d’application pour utiliser le nom de host d’endpoint OTLP correct. Comme l’OpenTelemetry Collector s’exécute en tant que DaemonSet, le host actuel doit être ciblé. Définissez la variable d’environnement OTEL_EXPORTER_OTLP_ENDPOINT de votre conteneur d’application en conséquence, comme dans le graphique d’exemple :

   # ...
           env:
           - name: HOST_IP
             valueFrom:
               fieldRef:
                 fieldPath: status.hostIP
             # The application SDK must use this environment variable in order to successfully
             # connect to the DaemonSet's collector.
           - name: OTEL_EXPORTER_OTLP_ENDPOINT
             value: "http://$(HOST_IP):4318"
   # ...
   

5. Modifiez le DaemonSet pour inclure un exportateur OTLP au lieu de l’exportateur Datadog actuellement en place :

   # ...
   exporters:
     otlp:
       endpoint: "<GATEWAY_HOSTNAME>:4317"
   # ...
   

6. Assurez-vous que les pipelines de service utilisent cet exportateur, au lieu de celui de Datadog qui est en place dans l’exemple :

   # ...
       service:
         pipelines:
           metrics:
             receivers: [hostmetrics, otlp]
             processors: [resourcedetection, k8sattributes, batch]
             exporters: [otlp]
           traces:
             receivers: [otlp]
             processors: [resourcedetection, k8sattributes, batch]
             exporters: [otlp]
   # ...
   

   Cela garantit que chaque Agent transmet ses données via le protocole OTLP à la passerelle du collecteur.

7. Remplacez <GATEWAY_HOSTNAME> par l’adresse de votre passerelle OpenTelemetry Collector.

8. Configurez le processeur k8sattributes pour transférer l’adresse IP du Pod au collecteur de passerelle afin qu’il puisse obtenir les métadonnées :

   # ...
   k8sattributes:
     passthrough: true
   # ...
   

   Pour plus d’informations sur l’option passthrough, lisez sa documentation :

9. Assurez-vous que la configuration du collecteur de passerelle utilise les mêmes paramètres d’exportateur Datadog que ceux qui ont été remplacés par l’exportateur OTLP dans les agents : Par exemple (où <DD_SITE> est votre site, ) :

   # ...
   exporters:
     datadog:
       api:
         site: <DD_SITE>
         key: ${env:DD_API_KEY}
   # ...
   

10. Configurez la collecte des métadonnées de host : Dans un déploiement de passerelle, vous devez vous assurer que les métadonnées de host sont collectées par les collecteurs d’agent et préservées par le collecteur de passerelle. Cela garantit que les métadonnées de host sont collectées par les agents et correctement transférées via la passerelle vers Datadog.
    Pour plus d’informations, consultez Mappage des conventions sémantiques OpenTelemetry aux informations des hosts de la liste des infrastructures.

    Configuration du collecteur d’Agent :

    processors:
      resourcedetection:
        detectors: [system, env]
      k8sattributes:
        passthrough: true
    
    exporters:
      otlp:
        endpoint: "<GATEWAY_HOSTNAME>:4317"
    
    service:
      pipelines:
        traces:
          receivers: [otlp]
          processors: [resourcedetection, k8sattributes, transform, batch]
          exporters: [otlp]
    

    Configuration du collecteur de passerelle :

    processors:
      k8sattributes:
        extract:
          metadata: [node.name, k8s.node.name]
    
    exporters:
      datadog:
        api:
          key: ${DD_API_KEY}
        hostname_source: resource_attribute
    
    service:
      pipelines:
        traces:
          receivers: [otlp]
          processors: [k8sattributes, batch]
          exporters: [datadog]
    

Pour utiliser l’opérateur OpenTelemetry, suivez la documentation officielle pour le déploiement de l’opérateur OpenTelemetry. Tel que décrit dans la documentation, déployez également le gestionnaire de certificats en plus de l’opérateur.

Configurez l’Operator au moyen d’une des configurations Kubernetes standard du Collector OpenTelemetry :

• Déploiement DaemonSet - Utilisez le déploiement DaemonSet si vous souhaitez vous assurer de recevoir les métriques du host.
• Déploiement Gateway