Agent Docker

Présentation

L’Agent Docker Datadog est la version conteneurisée de l’Agent pour host. L’image Docker officielle est disponible sur Docker Hub.

L’image est disponible en versions pour architectures x86 64 bits et Arm v8.

Implémentation

Si vous n’avez pas encore installé l’Agent Docker, consultez les informations ci-dessous ou les instructions d’installation intégrées à l’application. Consultez la documentation de l’Agent pour connaître les versions prises en charge.

Installation

Utilisez la commande d’installation en une étape. Remplacez <VOTRE_CLÉ_API_DATADOG> par votre clé d’API Datadog.

Dropdown

DOCKER_CONTENT_TRUST=1 \
docker run -d -v /var/run/docker.sock:/var/run/docker.sock:ro \
              -v /proc/:/host/proc/:ro \
              -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
              -e DD_API_KEY=<VOTRE_CLÉ_API_DATADOG> \
              datadog/agent:latest

DOCKER_CONTENT_TRUST=1 \
docker run -d --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro \
                              -v /proc/:/host/proc/:ro \
                              -v /cgroup/:/host/sys/fs/cgroup:ro \
                              -e DD_API_KEY=<VOTRE_CLÉ_API_DATADOG> \
                              datadog/agent:latest

Remarque : pour Docker Compose, consultez Compose et l’Agent Datadog.

Configuration

Le fichier de configuration principal de l’Agent est datadog.yaml. Pour l’Agent Docker, les options de configuration datadog.yaml sont envoyées via des variables d’environnement.

Variables d’environnement

Options globales

Variable d’environnement	Description
`DD_API_KEY`	Votre clé d’API Datadog (obligatoire).
`DD_HOSTNAME`	Le hostname à utiliser pour les métriques (si la détection automatique échoue).
`DD_TAGS`	Tags de host séparés par des espaces. Exemple : `tag-simple-0 clé-tag-1:valeur-tag-1`.
`DD_SITE`	Le site auquel vous transmettez vos métriques, traces et logs. Vous pouvez choisir entre `datadoghq.com` pour le site américain de Datadog et `datadoghq.eu` pour le site européen.
`DD_DD_URL`	Paramètre facultatif pour remplacer l’URL utilisée pour l’envoi de métriques.
`DD_CHECK_RUNNERS`	Par défaut, l’Agent exécute tous les checks simultanément (valeur par défaut : `4` runners). Pour exécuter les checks de manière séquentielle, définissez la valeur sur `1`. Si vous devez exécuter un grand nombre de checks (ou plusieurs checks lents), le composant `collector-queue` peut prendre du retard et renvoyer un échec au check de santé. Vous pouvez accroître le nombre de runners pour exécuter davantage de checks en parallèle.

Paramètres de proxy

À partir de l’Agent v6.4.0 (et v6.5.0 pour l’Agent de trace), vous pouvez remplacer les paramètres de proxy de l’Agent via les variables d’environnement suivantes :

Variable d’environnement	Description
`DD_PROXY_HTTP`	URL HTTP à utiliser comme proxy pour les requêtes `http`.
`DD_PROXY_HTTPS`	URL HTTPS à utiliser comme proxy pour les requêtes `https`.
`DD_PROXY_NO_PROXY`	Une liste d’URL, séparées par des espaces, pour lesquelles aucun proxy ne doit être utilisé.

Pour en savoir plus sur les paramètres de proxy, consultez la documentation relative au proxy de l’Agent v6.

Agents de collecte facultatifs

Par défaut, les Agents de collecte facultatifs sont désactivés pour des raisons de sécurité et de performances. Utilisez les variables d’environnement suivantes pour les activer :

Variable d’environnement	Description
`DD_APM_ENABLED`	Active la collecte de traces avec l’Agent de traces.
`DD_LOGS_ENABLED`	Active la collecte de logs avec l’Agent de logs.
`DD_PROCESS_AGENT_ENABLED`	Active la collecte de live processes via l’Agent de processus. Par défaut, la vue Live Container est déjà activée si le socket Docker est disponible. Si définie sur `false`, la collecte de live processes et la vue Live Container sont désactivées.

DogStatsD (métriques custom)

Envoyez des métriques custom avec le protocole StatsD :

Variable d’environnement	Description
`DD_DOGSTATSD_NON_LOCAL_TRAFFIC`	Effectue une écoute des paquets DogStatsD issus d’autres conteneurs (requis pour envoyer des métriques custom).
`DD_HISTOGRAM_PERCENTILES`	Les centiles à calculer pour l’histogramme (séparés par des espaces). Valeur par défaut : « 0.95 ».
`DD_HISTOGRAM_AGGREGATES`	Les agrégations à calculer pour l’histogramme (séparées par des espaces). Valeur par défaut : « max median avg count ».
`DD_DOGSTATSD_SOCKET`	Chemin vers le socket Unix à écouter. Doit être dans le volume `rw` monté.
`DD_DOGSTATSD_ORIGIN_DETECTION`	Active la détection de conteneurs et l’ajout de tags pour les métriques de socket Unix.
`DD_DOGSTATSD_TAGS`	Les tags supplémentaires à ajouter à l’ensemble des métriques, événements et checks de service reçus par ce serveur DogStatsD. Par exemple : `["env:golden", "group:retrievers"]`.

En savoir plus sur l’utilisation de DogStatsD sur un socket de domaine Unix.

Tagging

Datadog recueille automatiquement les tags courants à partir de Docker, Kubernetes, ECS, Swarm, Mesos, Nomad et Rancher. Pour extraire des tags supplémentaires, utilisez les options suivantes :

Variable d’environnement	Description
`DD_DOCKER_LABELS_AS_TAGS`	Extrait les étiquettes de conteneur Docker
`DD_DOCKER_ENV_AS_TAGS`	Extrait les variables d’environnement de conteneur Docker
`DD_KUBERNETES_POD_LABELS_AS_TAGS`	Extrait les étiquettes de pod
`DD_KUBERNETES_POD_ANNOTATIONS_AS_TAGS`	Extrait les annotations de pod
`DD_COLLECT_EC2_TAGS`	Extrait les tags EC2 personnalisés sans utiliser l’intégration AWS

La clé de carte correspond au nom de la source (label/envvar), tandis que sa valeur correspond au nom du tag Datadog. Par exemple :

DD_KUBERNETES_POD_LABELS_AS_TAGS='{"app":"kube_app","release":"helm_release"}'
DD_DOCKER_LABELS_AS_TAGS='{"com.docker.compose.service":"service_name"}'

Des exemples supplémentaires sont disponibles sur la page Appliquer et extraire des tags.

Utiliser des secrets

Les identifiants des intégrations peuvent être conservés dans des secrets Docker ou Kubernetes et utilisés dans les modèles Autodiscovery. Pour en savoir plus, consultez la documentation sur la Gestion des secrets.

Ignorer des conteneurs

Excluez des conteneurs de la collecte de logs, de la collecte de métriques et d’Autodiscovery. Par défaut, Datadog exclut les conteneurs pause de Kubernetes et d’OpenShift.

Variable d’environnement	Description
`DD_AC_INCLUDE`	Liste des conteneurs à inclure (séparés par des espaces). Utilisez `.` pour tous les inclure. Exemple : `"image:nom_image_1 image:nom_image_2"`, `image:.`
`DD_AC_EXCLUDE`	Liste des conteneurs à exclure (séparés par des espaces). Utilisez `.` pour tous les exclure. Exemple : `"image:nom_image_3 image:nom_image_4"`. (Remarque* : cette variable est seulement traitée pour Autodiscovery.), `image:.*`

Des exemples supplémentaires sont disponibles sur la page Gestion de la découverte de conteneurs.

Remarque : ces paramètres n’ont aucun effet sur les métriques docker.containers.running, .stopped, .running.total et .stopped.total, qui prennent en compte l’ensemble des conteneurs. Cela n’a aucune incidence sur le nombre de conteneurs facturés.

Divers

Variable d’environnement	Description
`DD_PROCESS_AGENT_CONTAINER_SOURCE`	Remplace la détection automatique des sources de conteneurs par une source unique, comme `"docker"`, `"ecs_fargate"` ou `"kubelet"`
`DD_HEALTH_PORT`	Définir cette variable sur `5555` pour exposer le check de santé de l’Agent sur le port `5555`.

Remarque : si vous utilisez le runtime containerd, définissez DD_PROCESS_AGENT_CONTAINER_SOURCE="kubelet" pour faire apparaître vos conteneurs sur la page des conteneurs.

Vous pouvez ajouter d’autres écouteurs et fournisseurs de configuration à l’aide des variables d’environnement DD_EXTRA_LISTENERS et DD_EXTRA_CONFIG_PROVIDERS. Elles viennent s’ajouter aux variables définies dans les sections listeners et config_providers du fichier de configuration datadog.yaml.

Validation

Exécutez la commande status de l’Agent Docker pour vérifier l’installation.

Commandes

Ces commandes sont exécutées sur le host.

Type	Commande
Démarrer	Utilisez la commande d’installation.
Arrêter	`docker exec -it <NOM_CONTENEUR> agent stop`
Redémarrer	Utilisez la commande d’installation.
Statut	`docker exec -it <NOM_CONTENEUR> agent status`

Données collectées

Métriques

Par défaut, l’Agent Docker recueille les métriques associées aux checks principaux suivants. Pour recueillir les métriques associées à d’autres technologies, consultez la section Intégrations.

Check	Métriques
CPU	Système
Disk	Disque
Docker	Docker
File Handle	Système
IO	Système
Load	Système
Memory	Système
Réseau	Réseau
NTP	NTP
Uptime	Système

Événements

L’Agent Docker envoie des événements à Datadog lorsqu’un Agent est démarré ou redémarré.

Checks de service

datadog.agent.up :
Renvoie CRITICAL si l’Agent n’est pas capable de se connecter à Datadog. Si ce n’est pas le cas, renvoie OK.

datadog.agent.check_status :
Renvoie CRITICAL si un check de l’Agent n’est pas capable d’envoyer des métriques à Datadog. Si ce n’est pas le cas, renvoie OK.

Intégrations

L’intégration Docker envoie automatiquement des métriques avec l’Agent Docker. Pour configurer d’autres intégrations, utilisez Autodiscovery ou le montage de fichiers.

Autodiscovery

Pour activer Autodiscovery sur l’Agent Docker lorsque vous utilisez l’installation en une étape, montez /var/run/docker.sock.

Pour ajouter des intégrations avec Autodiscovery, consultez la page Modèles d’intégration Autodiscovery.

Monter conf.d

Les fichiers de configuration de votre intégration peuvent être copiés dans /etc/datadog-agent/conf.d/ lorsque l’Agent Docker démarre en montant un répertoire /conf.d.

Créez un répertoire de configuration sur le host avec vos fichiers YAML :

mkdir /opt/datadog-agent-conf.d
touch /opt/datadog-agent-conf.d/http_check.yaml

Lors de l’installation de l’Agent Docker, ajoutez -v /opt/datadog-agent-conf.d:/conf.d:ro. Par exemple :

DOCKER_CONTENT_TRUST=1 \
docker run -d -v /var/run/docker.sock:/var/run/docker.sock:ro \
              -v /proc/:/host/proc/:ro \
              -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
              -v /opt/datadog-agent-conf.d:/conf.d:ro \
              -e DD_API_KEY=<YOUR_DATADOG_API_KEY> \
              datadog/agent:latest

Lorsque le conteneur démarre, tous les fichiers sur le host dans /opt/datadog-agent-conf.d qui possèdent l’extension .yaml sont copiés vers /etc/datadog-agent/conf.d/. Remarque : si vous ajoutez de nouveaux fichiers YAML dans /opt/datadog-agent-conf.d, redémarrez l’Agent Docker.

Il en va de même pour le dossier /checks.d. Tous les fichiers Python du dossier /checks.d sont automatiquement copiés vers /etc/datadog-agent/checks.d/ lorsque l’Agent Docker démarre.