Variables d'environnement de l'Agent

Variables d'environnement de l'Agent

Si vous utilisez l'Agent v5, référez-vous au référentiel GitHub de l'Agent Docker.

Présentation

Si vous utilisez l’Agent v6, la plupart des options du fichier de configuration principal de l’Agent (datadog.yaml) peuvent être définies via des variables d’environnement.

Recommandations

Datadog vous conseille d’utiliser le tagging de service unifié lorsque vous assignez des tags. Le tagging de service unifié permet de lier les données de télémétrie Datadog entre elles via trois tags standards : env, service et version. Pour découvrir comment configurer le tagging unifié pour votre environnement, consultez la documentation dédiée au tagging de service unifié.

Cas d’utilisation généraux

Dans la plupart des cas, les règles suivantes doivent être respectées :

  • Les noms d’option doivent être écrits en majuscules et précédés de DD_ : hostname -> DD_HOSTNAME

  • Les différentes valeurs doivent être séparées par des espaces :

       container_include:
         - "image:cp-kafka"
         - "image:k8szk"
       # DD_CONTAINER_INCLUDE="image:cp-kafka image:k8szk"
    
  • Les options de configuration imbriquées dont les clés sont prédéfinies doivent être séparées par des tirets bas :

       cluster_agent:
         cmd_port: 5005
       # DD_CLUSTER_AGENT_CMD_PORT=5005
    
  • Les options de configuration imbriquées dont les clés sont définies par l’utilisateur doivent être au format JSON :

       docker_env_as_tags:
         ENVVAR_NAME: tag_name
       # DD_DOCKER_ENV_AS_TAGS='{"ENVVAR_NAME": "tag_name"}'
    

Remarque : lorsque vous spécifiez une option imbriquée avec une variable d’environnement, toutes les options imbriquées spécifiées sous l’option de configuration sont ignorées. L’option de configuration proxy fait toutefois exception à cette règle. Consultez la documentation relative au proxy de l’Agent pour en savoir plus.

Exceptions

  • Toutes les options du fichier datadog.yaml ne peuvent pas être définies via des variables d’environnement. Référez-vous au fichier config.go dans le référentiel GitHub de l’Agent Datadog. Les options disponibles via les variables d’environnement commencent par config.BindEnv*.

  • Les variables d’environnement spécifiques à un composant qui ne sont pas répertoriées dans le fichier config.go peuvent également être prises en charge.

Pour aller plus loin