Configuration avancée de l'Agent Datadog sur Kubernetes

La collecte d’événements est activée par défaut par l’Operator Datadog. Pour configurer cette fonctionnalité, utilisez le paramètre features.eventCollection.collectKubernetesEvents dans votre fichier de configuration datadog-agent.yaml.

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

  features:
    eventCollection:
      collectKubernetesEvents: true

Pour recueillir des événements Kubernetes avec l’Agent de cluster Datadog, assurez-vous que les options clusterAgent.enabled, datadog.collectEvents et clusterAgent.rbac.create sont définies sur true dans votre fichier datadog-values.yaml.

datadog:
  collectEvents: true
clusterAgent:
  enabled: true
  rbac: 
    create: true

Si vous ne souhaitez pas utiliser l’Agent de cluster, vous pouvez vous servir d’un Agent de nœud pour recueillir les événements Kubernetes en définissant les options datadog.leaderElection, datadog.collectEvents et agents.rbac.create sur true dans votre fichier datadog-values.yaml.

datadog:
  leaderElection: true
  collectEvents: true
agents:
  rbac:
    create: true

Dans votre fichier datadog-agent.yaml, définissez features.npm.enabled sur true.

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

  features:
    npm:
      enabled: true

Ensuite, appliquez la nouvelle configuration :

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

Modifiez votre fichier datadog-values.yaml en indiquant la configuration suivante :

datadog:
  # (...)
  networkMonitoring:
    enabled: true

Mettez ensuite à niveau votre chart Helm :

helm upgrade -f datadog-values.yaml <NOM_VERSION> datadog/datadog

Dans votre fichier datadog-agent.yaml, définissez features.logCollection.enabled et features.logCollection.containerCollectAll sur true.

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

  features:
    logCollection:
      enabled: true
      containerCollectAll: true

Ensuite, appliquez la nouvelle configuration :

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

Modifiez votre fichier datadog-values.yaml en indiquant la configuration suivante :

datadog:
  # (...)
  logs:
    enabled: true
    containerCollectAll: true

Mettez ensuite à niveau votre chart Helm :

helm upgrade -f datadog-values.yaml <NOM_VERSION> datadog/datadog

Dans votre fichier datadog-agent.yaml, définissez features.liveProcessCollection.enabled sur true.

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

  features:
    liveProcessCollection:
      enabled: true

Ensuite, appliquez la nouvelle configuration :

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

Modifiez votre fichier datadog-values.yaml en indiquant la configuration suivante :

datadog:
  # (...)
  processAgent:
    enabled: true
    processCollection: true

Mettez ensuite à niveau votre chart Helm :

helm upgrade -f datadog-values.yaml <NOM_VERSION> datadog/datadog

À partir de la version 1.0.0 de l’Operator Datadog, l’Agent de cluster est activé par défaut. L’Operator crée les autorisations RBAC nécessaires et déploie l’Agent de cluster. Les deux Agents utilisent la même clé d’API.

L’Operator génère automatiquement un token aléatoire dans un Secret Kubernetes. Ce token est partagé avec l’Agent Datadog et l’Agent de cluster afin de sécuriser leurs communications.

Vous pouvez spécifier ce token dans le champ global.clusterAgentToken de votre fichier datadog-agent.yaml :

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
      appKey: <CLÉ_APPLICATION_DATADOG>
  clusterAgentToken: <TOKEN_AGENT_CLUSTER_DATADOG>

Il est également possible de spécifier ce token en faisant référence au nom d’un Secret existant et au nom de la clé de données contenant ce token :

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
      appKey: <CLÉ_APPLICATION_DATADOG>
  clusterAgentTokenSecret: 
    secretName: <NOM_SECRET>
    keyName: <NOM_CLÉ>

Remarque : lorsque le token est défini manuellement, il doit être composé de 32 caractères alphanumériques.

Ensuite, appliquez la nouvelle configuration :

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

À partir de la version 2.7.0 du chart Helm, l’Agent de cluster est activé par défaut.

Pour vous assurer que l’Agent de cluster est bien activé, vérifiez que clusterAgent.enabled est défini sur true dans votre fichier datadog-values.yaml :

clusterAgent:
  enabled: true

Helm génère automatiquement un token aléatoire dans un Secret Kubernetes. Ce token est partagé avec l’Agent Datadog et l’Agent de cluster afin de sécuriser leurs communications.

Vous pouvez spécifier ce token dans le champ clusterAgent.token de votre fichier datadog-agent.yaml :

clusterAgent:
  enabled: true
  token: <TOKEN_AGENT_CLUSTER_DATADOG>

Il est également possible de spécifier ce token en faisant référence au nom d’un Secret existant comportant la clé token comportant le token :

clusterAgent:
  enabled: true
  tokenExistingSecret: <NOM_SECRET>

Dans le fichier datadog-agent.yaml, spécifiez une clé d’application sous spec.global.credentials.appKey et définissez features.externalMetricsServer.enabled sur true.

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

  features:
    externalMetricsServer:
      enabled: true

Ensuite, appliquez la nouvelle configuration :

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

Dans le fichier datadog-values.yaml, spécifiez une clé d’application datadog.appKey et définissez clusterAgent.metricsProvider.enabled sur true.

datadog:
  apiKey: <CLÉ_API_DATADOG>
  appKey: <CLÉ_APPLICATION_DATADOG>

  clusterAgent:
    enabled: true
    metricsProvider:
      enabled: true

Mettez ensuite à niveau votre chart Helm :

helm upgrade -f datadog-values.yaml <NOM_VERSION> datadog/datadog

L’Operator Datadog active par défaut l’Agent de processus.

Pour vous assurer que l’Agent de processus est bien activé, vérifiez que features.liveContainerCollection.enabled est défini sur true dans votre datadog-agent.yaml :

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
      appKey: <CLÉ_APPLICATION_DATADOG>
  features:
    liveContainerCollection:
      enabled: true

Le chart Helm active par défaut l’Agent de processus.

Pour vous assurer que l’Agent de processus est bien activé, vérifiez que processAgent.enabled est défini sur true dans votre fichier datadog-values.yaml :

datadog:
  # (...)
  processAgent:
    enabled: true

Dans certaines configurations, il arrive que l’Agent de processus et l’Agent de cluster ne parviennent pas à détecter automatiquement un nom de cluster Kubernetes. Lorsque c’est le cas, la fonctionnalité ne démarre pas et l’avertissement suivant s’affiche dans le log de l’Agent de cluster : Orchestrator explorer enabled but no cluster name set: disabling. Vous devez alors définir datadog.clusterName sur le nom de votre cluster dans le fichier values.yaml.

datadog:
  #(...)
  clusterName: <NOM_CLUSTER>
  #(...)
  processAgent:
    enabled: true

L’Operator Datadog active par défaut l’Orchestrator Explorer.

Pour vous assurer que cette vue est bien activée, vérifiez que le paramètre features.orchestratorExplorer.enabled est défini sur true dans votre fichier datadog-agent.yaml :

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
      appKey: <CLÉ_APPLICATION_DATADOG>
  features:
    orchestratorExplorer:
      enabled: true

Le chart Helm active par défaut l’Orchestrator Explorer.

Pour vous assurer que cette vue est bien activée, vérifiez que le paramètre orchestratorExplorer.enabled est défini sur true dans votre fichier datadog-values.yaml :

datadog:
  # (...)
  processAgent:
    enabled: true
  orchestratorExplorer:
    enabled: true

Pour obtenir la liste complète des variables d’environnements pour l’Operator Datadog, consultez la spécification v2alpha1 de l’Operator. Pour les versions antérieures, consultez la spécification v1alpha1 de l’Operator.

Pour obtenir la liste complète des variables d’environnement pour le chart Helm, consultez la liste des options pour le fichier datadog-values.yaml.

Exemples

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  global:
    credentials:
      apiKey: <CLÉ_API_DATADOG>
    namespaceLabelsAsTags:
      env: environment
      # <ÉTIQUETTE_ESPACE_NOMMAGE_KUBERNETES>: <CLÉ_TAG_DATADOG>
    nodeLabelsAsTags:
      beta.kubernetes.io/instance-type: aws-instance-type
      kubernetes.io/role: kube_role
      # <ÉTIQUETTE_NŒUD_KUBERNETES>: <CLÉ_TAG_DATADOG>
    podLabelsAsTags:
      app: kube_app
      release: helm_release
      # <ÉTIQUETTE_KUBERNETES>: <CLÉ_TAG_DATADOG>
    podAnnotationsAsTags:
      iam.amazonaws.com/role: kube_iamrole
       # <ANNOTATIONS_KUBERNETES>: <CLÉ_TAG_DATADOG>

Exemples

datadog:
  # (...)
  namespaceLabelsAsTags:
    env: environment
    # <ÉTIQUETTE_ESPACE_NOMMAGE_KUBERNETES>: <CLÉ_TAG_DATADOG>
  nodeLabelsAsTags:
    beta.kubernetes.io/instance-type: aws-instance-type
    kubernetes.io/role: kube_role
    # <ÉTIQUETTE_NŒUD_KUBERNETES>: <CLÉ_TAG_DATADOG>
  podLabelsAsTags:
    app: kube_app
    release: helm_release
    # <ÉTIQUETTE_KUBERNETES>: <CLÉ_TAG_DATADOG>
  podAnnotationsAsTags:
    iam.amazonaws.com/role: kube_iamrole
     # <ANNOTATIONS_KUBERNETES>: <CLÉ_TAG_DATADOG>