Collecte de traces APM avec Kubernetes

• Si vous ne l’avez pas déjà fait, installez le chart Helm.

La configuration par défaut crée un répertoire sur le host et le monte dans l’Agent. L’Agent crée ensuite un fichier de socket /var/run/datadog/apm.socket et effectue une écoute sur ce fichier. Les pods d’application peuvent alors être montés de la même façon sur ce volume et rédiger des données sur ce socket. Vous pouvez modifier le chemin et le socket avec les paramètres datadog.apm.hostSocketPath et datadog.apm.socketPath.

Cette fonctionnalité peut être désactivée à l’aide de l’option datadog.apm.socketEnabled.

Configurer l’Agent Datadog pour qu’il accepte les traces via TCP (facultatif)

Il est possible de configurer l’Agent Datadog afin qu’il reçoive les traces via TCP. Pour activer cette fonctionnalité, procédez comme suit :

• Mettez à jour votre fichier values.yaml avec la configuration APM suivante :

  datadog:
    ## Enable apm agent and provide custom configs
    apm:
      # datadog.apm.portEnabled -- Enable APM over TCP communication (port 8126 by default)
      ## ref: https://docs.datadoghq.com/agent/kubernetes/apm/
      portEnabled: true
  

Ensuite, mettez à jour votre chart Helm Datadog à l’aide de la commande suivante : helm upgrade -f values.yaml <NOM_VERSION> datadog/datadog. Si vous n’avez pas défini votre système d’exploitation dans values.yaml, ajoutez --set targetSystem=linux ou --set targetSystem=windows à cette commande.

Attention : le paramètre datadog.apm.portEnabled ouvre un port sur votre host. Assurez-vous que votre pare-feu accorde uniquement un accès à vos applications ou à d’autres sources de confiance. Si votre plug-in réseau ne prend pas en charge hostPorts, ajoutez hostNetwork: true aux spécifications de pod de votre Agent afin de partager l’espace de nommage réseau de votre host avec l’Agent Datadog. Cela signifie également que tous les ports ouverts sur le conteneur sont également ouverts sur le host. Si un port est utilisé sur le host et dans votre conteneur, ces derniers peuvent entrer en conflit (puisqu’ils partagent le même espace de nommage réseau), empêchant ainsi le pod de démarrer. Cela n’est pas possible avec certaines installations Kubernetes.

Pour activer la collecte de traces APM, ouvrez le fichier de configuration DaemonSet et modifiez les éléments suivants :

• Autorisez la réception de données sur le port 8126 (transmission du trafic du host à l’Agent) dans le conteneur trace-agent :

    # (...)
    containers:
      - name: trace-agent
        # (...)
        ports:
          - containerPort: 8126
            hostPort: 8126
            name: traceport
            protocol: TCP
    # (...)
  

• Si vous utilisez une ancienne version de l’Agent (7.17 ou antérieure), en plus des étapes ci-dessus, vous devez définir les variables DD_APM_NON_LOCAL_TRAFFIC et DD_APM_ENABLED sur true dans la section env du manifeste de l’Agent de trace datadog.yaml :

    # (...)
    containers:
      - name: trace-agent
        # (...)
        env:
          - name: DD_APM_ENABLED
            value: 'true'
          - name: DD_APM_NON_LOCAL_TRAFFIC
            value: "true"
          # (...)
  

Attention : le paramètre hostPort ouvre un port sur votre host. Assurez-vous que votre pare-feu accorde uniquement un accès à vos applications ou à d’autres sources de confiance. Si votre plug-in réseau ne prend pas en charge hostPorts, ajoutez hostNetwork: true aux spécifications de pod de votre Agent afin de partager l’espace de nommage réseau de votre host avec l’Agent Datadog. Cela signifie également que tous les ports ouverts sur le conteneur sont également ouverts sur le host. Si un port est utilisé sur le host et dans votre conteneur, ces derniers peuvent entrer en conflit (puisqu’ils partagent le même espace de nommage réseau), empêchant ainsi le pod de démarrer. Cela n’est pas possible avec certaines installations Kubernetes.

Pour activer la collecte de traces APM, ouvrez le fichier de configuration DaemonSet et modifiez les éléments suivants :

  # (...)
  containers:
  - name: trace-agent
    # (...)
    env:
    - name: DD_APM_ENABLED
      value: "true"
    - name: DD_APM_RECEIVER_SOCKET
      value: "/var/run/datadog/apm.socket"
  # (...)
    volumeMounts:
    - name: apmsocket
      mountPath: /var/run/datadog/
  volumes:
  - hostPath:
      path: /var/run/datadog/
      type: DirectoryOrCreate
  # (...)

Cette configuration crée un répertoire sur le host et le monte dans l’Agent. L’Agent crée ensuite un fichier de socket dans ce répertoire avec la valeur DD_APM_RECEIVER_SOCKET de /var/run/datadog/apm.socket et effectue une écoute sur ce fichier. Les pods d’application peuvent alors être montés de la même façon sur ce volume et rédiger des données sur ce socket.

Lorsque la solution APM est activée, la configuration par défaut crée un répertoire sur le host et le monte dans l’Agent. L’Agent crée ensuite un fichier de socket /var/run/datadog/apm/apm.socket et effectue une écoute sur ce fichier. Les pods d’application peuvent alors être montés de la même façon sur ce volume et rédiger des données sur ce socket. Vous pouvez modifier le chemin et le socket avec le paramètre features.apm.unixDomainSocketConfig.path.

Configurer l’Agent Datadog pour qu’il accepte les traces via TCP (facultatif)

Il est possible de configurer l’Agent Datadog afin qu’il reçoive les traces via TCP. Pour activer cette fonctionnalité, procédez comme suit :

Modifiez votre manifeste DatadogAgent en indiquant ce qui suit :

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
    site: <SITE_DATADOG>

  features:
    apm:
      enabled: true
      hostPortConfig:
        enabled: true

Remplacez <SITE_DATADOG> par (valeur par défaut : datadoghq.com).

Consultez l’exemple de manifeste avec activation de l’APM et de la collecte des métriques pour un exemple complet.

Ensuite, appliquez la nouvelle configuration :

kubectl apply -n $DD_NAMESPACE -f datadog-agent.yaml

Attention : le paramètre hostPort ouvre un port sur votre host. Assurez-vous que votre pare-feu accorde uniquement un accès à vos applications ou à d’autres sources de confiance. Si votre plug-in réseau ne prend pas en charge hostPorts, ajoutez hostNetwork: true aux spécifications de pod de votre Agent afin de partager l’espace de nommage réseau de votre host avec l’Agent Datadog. Cela signifie également que tous les ports ouverts sur le conteneur sont également ouverts sur le host. Si un port est utilisé sur le host et dans votre conteneur, ces derniers peuvent entrer en conflit (puisqu’ils partagent le même espace de nommage réseau), empêchant ainsi le pod de démarrer. Cela n’est pas possible avec certaines installations Kubernetes.

Le contrôleur d’admission Datadog est un composant de l’Agent de cluster Datadog qui simplifie la configuration des pods de votre application. Pour en savoir plus, consultez la section Contrôleur d’admission Datadog.

Le contrôleur d’admission Datadog vous permet d’injecter des variables d’environnement et de monter les volumes nécessaires sur les nouveaux pods d’application. Ainsi, les communications entre les pods et les traces de l’Agent sont automatiquement configurées. Pour découvrir comment configurer automatiquement votre application de façon à envoyer les traces à l’Agent Datadog, lisez la documentation relative à l’injection de bibliothèques à l’aide du contrôleur d’admission.

Si vous envoyez des traces à l’Agent à l’aide d’un socket de domaine Unix, montez le répertoire du host dans lequel le socket se trouve (le répertoire créé par l’Agent) sur le conteneur de l’application, et spécifiez le chemin du socket avec DD_TRACE_AGENT_URL :

apiVersion: apps/v1
kind: Deployment
#(...)
    spec:
      containers:
      - name: "<NOM_CONTENEUR>"
        image: "<IMAGE_CONTENEUR>/<TAG>"
        env:
        - name: DD_TRACE_AGENT_URL
          value: 'unix:///var/run/datadog/apm.socket'
        volumeMounts:
        - name: apmsocketpath
          mountPath: /var/run/datadog
        #(...)
      volumes:
        - hostPath:
            path: /var/run/datadog/
          name: apmsocketpath

Configurer les traceurs de votre application pour générer des traces

Après avoir configuré votre Agent Datadog de façon à ce qu’il recueille des traces et transmis aux pods de votre application l’emplacement vers lequel envoyer les traces, installez le traceur Datadog sur votre application afin de générer des traces. Une fois cette étape terminée, le traceur envoie les traces vers l’endpoint DD_AGENT_HOST (pour IP:Port) ou DD_TRACE_AGENT_URL (pour un socket de domaine Unix), selon le cas.

Si vous envoyez des traces à l’Agent via le protocole TCP (<ADRESSE_IP>:8126), transmettez cette adresse aux pods de votre application, que ce soit automatiquement avec le contrôleur d’admission Datadog ou manuellement avec l’API Downward (afin de récupérer l’IP du host). La variable d’environnement DD_AGENT_HOST doit pointer sur status.hostIP pour le conteneur d’application :

apiVersion: apps/v1
kind: Deployment
#(...)
    spec:
      containers:
      - name: "<NOM_CONTENEUR>"
        image: "<IMAGE_CONTENEUR>/<TAG>"
        env:
          - name: DD_AGENT_HOST
            valueFrom:
              fieldRef:
                fieldPath: status.hostIP

Remarque : pour cette configuration, vous devez configurer l’Agent pour qu’il accepte les traces via TCP.

Configurer les traceurs de votre application pour générer des traces

Après avoir configuré votre Agent Datadog de façon à ce qu’il recueille des traces et transmis aux pods de votre application l’emplacement vers lequel envoyer les traces, installez le traceur Datadog sur votre application afin de générer des traces. Une fois cette étape terminée, le traceur envoie automatiquement les traces vers l’endpoint DD_AGENT_HOST (pour IP:Port) ou DD_TRACE_AGENT_URL (pour un socket de domaine Unix), selon le cas.