Ce guide décrit comment installer la version 5 de l’Agent. Datadog recommande d’installer la version 7 de l’Agent ou d’effectuer la mise à niveau vers celle-ci pour bénéficier des dernières fonctionnalités. Pour en savoir plus sur l’installation de la dernière version de l’Agent, suivez les instructions d’installation les plus récentes de l’Agent. Pour obtenir plus d’informations sur la mise à niveau vers la version 7 de l’Agent à partir d’une version antérieure, consultez la section relative à la mise à niveau vers la version 7 de l’Agent Datadog.
macOS
Installer l’Agent
Ligne de commande
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Pour gérer l’Agent, utilisez la commande datadog-agent. Par défaut, le binaire datadog-agent se trouve dans /usr/local/bin. Activez ou désactivez les intégrations dans /opt/datadog-agent/etc/conf.d.
Ajoutez la ligne suivante à /opt/datadog-agent/etc/datadog.conf, en remplaçant MY_API_KEY par votre clé d’API Datadog :
api_key:MY_API_KEY
Pour gérer l’Agent, utilisez l’application Datadog Agent dans la barre d’état système. Activez ou désactivez les intégrations dans /opt/datadog-agent/etc/conf.d.
Comportement d’exécution de l’Agent
Par défaut, l’Agent s’exécute à la connexion. Vous pouvez le désactiver à l’aide de l’application Datadog Agent dans la barre d’état système. Si vous souhaitez exécuter l’Agent au démarrage, utilisez ces commandes :
Si vous avez exécuté les commandes d’installation facultatives pour que l’Agent se lance au démarrage, exécutez les commandes suivantes pour finaliser la désinstallation :
Si vous effectuez une mise à niveau depuis une version de l’Agent Datadog <5.12.0, utilisez la méthode d’installation EXE.
Dans un shell cmd.exe dans le répertoire où vous avez téléchargé le programme d’installation, exécutez la commande suivante. Remplacez MY_API_KEY par votre clé d’API Datadog :
Nouvelle procédure de mise à niveau pour la version 5.12
Si vous êtes un client existant exécutant un Agent Windows antérieur à la version 5.12, des étapes supplémentaires peuvent être nécessaires pour mettre à niveau votre appareil. Plus précisément, le dernier Agent est une installation « par machine ». Les versions précédentes de l’Agent étaient « par utilisateur » par défaut. Des étapes supplémentaires peuvent également être nécessaires si vous déployez avec Chef. Pour plus d’informations, consultez la section Installation de l’Agent Windows.
Désinstallation
L’Agent peut être désinstallé de deux façons différentes sur Windows. Les deux méthodes suppriment l’Agent, mais pas le dossier de configuration C:\ProgramData\Datadog sur le host.
Remarque : pour l’Agent < v5.12.0, il est important de désinstaller l’Agent avec le compte d’origine utilisé pour installer l’Agent, sinon il peut ne pas être supprimé proprement.
Ajouter ou supprimer des programmes
Appuyez sur CTRL et Échap ou utilisez la touche Windows pour lancer la recherche Windows.
Recherchez ajouter et cliquez sur Ajouter ou supprimer des programmes.
Recherchez Datadog Agent et cliquez sur Désinstaller.
PowerShell
Remarque : activez WinRM pour utiliser les commandes ci-dessous.
Utilisez la commande PowerShell suivante pour désinstaller l’Agent sans redémarrage :
La commande en une seule étape installe les packages APT pour l’Agent Datadog et vous demande de saisir votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Exécutez la commande suivante pour copier l’exemple de configuration en place. Remplacez MY_API_KEY par votre clé d’API Datadog :
sudo sh -c "sed 's/api_key:.*/api_key:MY_API_KEY /' /etc/dd-agent/datadog.conf.example > /etc/dd-agent/datadog.conf"
Démarrez l’Agent :
sudo /etc/init.d/datadog-agent start
Installation en une seule étape
La commande en une seule étape installe les packages APT pour l’Agent Datadog et vous demande de saisir votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Exécutez la commande suivante pour copier l’exemple de configuration en place. Remplacez MY_API_KEY par votre clé d’API Datadog :
sudo sh -c "sed 's/api_key:.*/api_key:MY_API_KEY /' /etc/dd-agent/datadog.conf.example > /etc/dd-agent/datadog.conf"
Démarrez l’Agent :
sudo /etc/init.d/datadog-agent start
Désinstallation
Pour désinstaller l’Agent, exécutez la commande suivante :
sudo apt-get remove datadog-agent -y
Cette commande supprime l’Agent, mais pas :
Le fichier de configuration datadog.yaml
Fichiers créés par l’utilisateur dans le dossier de configuration /etc/dd-agent
Les fichiers créés par l’utilisateur dans le dossier /opt/datadog-agent
L’utilisateur dd-agent
Fichiers de log Datadog
Si vous souhaitez également supprimer ces éléments, exécutez cette commande après avoir supprimé l’Agent :
sudo apt-get --purge remove datadog-agent -y
Installation en une seule étape
La commande en une seule étape installe les paquets YUM pour l’Agent Datadog et vous demande votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog:
La commande en une seule étape installe les paquets YUM pour l’Agent Datadog et vous demande votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
La commande en une seule étape installe les paquets YUM pour l’Agent Datadog et vous demande votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
La commande en une seule étape installe les paquets YUM pour l’Agent Datadog et vous demande votre mot de passe. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
La commande en une seule étape installe le dernier paquet BFF pour l’Agent Datadog et vous demande votre mot de passe si nécessaire. Si l’Agent n’est pas déjà installé sur votre machine et que vous ne souhaitez pas qu’il démarre automatiquement après l’installation, ajoutez DD_INSTALL_ONLY=true au début de la commande avant de l’exécuter.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Pour obtenir une liste complète des variables d’environnement du script d’installation disponibles, consultez la section Utilisation de base de l’Agent pour AIX.
Installation en plusieurs étapes
Téléchargez le BFF préféré depuis les versions du référentiel datadog-unix-agent :
Installez l’artefact en tant que root avec installp :
Si vous n’avez pas de fichier de configuration existant, copiez l’exemple de configuration en place. Remplacez MY_API_KEY par votre clé d’API Datadog :
sudo sh -c "sed 's/api_key:.*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Assurez-vous que l’Agent Datadog dispose des autorisations correctes :
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 660 /etc/datadog-agent/datadog.yaml"
Arrêtez le service de l’Agent :
sudo stopsrc -s datadog-agent
Vérifiez que le service de l’Agent s’est arrêté :
sudo lssrc -s datadog-agent
Redémarrez le service de l’Agent :
sudo startsrc -s datadog-agent
Désinstallation
Pour désinstaller l’Agent, exécutez la commande suivante :
Pour supprimer un Agent installé, exécutez la commande installp suivante :
Remarque : les logs de désinstallation de l’Agent se trouvent dans le fichier dd-aix-install.log. Pour désactiver l’enregistrement de ces logs, supprimez le paramètre -e de la commande de désinstallation.
Cloud et conteneurs
Installer l’Agent
Installation avec DaemonSets
Si vous exécutez Kubernetes >= 1.1.0, vous pouvez profiter des DaemonSets pour déployer automatiquement l’Agent Datadog sur tous vos nœuds
Créez un secret qui contient votre clé d’API. Ce secret est utilisé dans le manifeste pour déployer l’Agent Datadog. Remplacez MY_API_KEY par votre clé d’API Datadog :
Ce manifeste active la fonctionnalité de configuration automatique d'Autodiscovery. Pour désactiver la configuration automatique, supprimez la définition de la variable d'environnement SD_BACKEND. Pour apprendre à configurer Autodiscovery, consultez la section Autodiscovery des intégrations Kubernetes.
Exécuter l’Agent en tant que conteneur Docker
Si vous n’exécutez pas Kubernetes 1.1.0 ou version ultérieure, ou si vous ne souhaitez pas utiliser DaemonSets, exécutez l’Agent en tant que conteneur Docker sur chaque nœud que vous souhaitez surveiller. Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Configurez votre bibliothèque client pour envoyer des paquets UDP à l’adresse IP du nœud. Si vous utilisez le réseau en pont, la passerelle par défaut du conteneur de votre application correspond à l’adresse IP du nœud. Vous pouvez également utiliser l’API descendante pour exposer le nom d’hôte du nœud en tant que variable d’environnement.
Personnaliser la configuration de votre Agent
Pour personnaliser la configuration de votre Agent, consultez la documentation dans le référentiel docker-dd-agent de l’Agent 5. Pour ajuster la configuration d’Autodiscovery, consultez la section Autodiscovery des intégrations Kubernetes. Pour désactiver Autodiscovery, supprimez la variable d’environnement SD_BACKEND de votre manifeste.
Pour obtenir des informations sur la collecte de métriques, de checks de service et d’événements, consultez la documentation de l’intégration Kubernetes.
Installation en une seule étape
L’installation en une seule étape exécute un conteneur Docker qui intègre l’Agent Datadog pour surveiller votre host. L’intégration Docker est activée par défaut, ainsi qu’Autodiscovery en mode de configuration automatique. Pour désactiver Autodiscovery, supprimez la variable SD_BACKEND de la commande d’installation en une seule étape.
Amazon Linux
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Si la commande d’installation en une seule étape ne fonctionne pas, il est possible que votre système monte le répertoire cgroup dans un emplacement inattendu ou n’utilise pas CGroups pour la gestion de la mémoire. Les CGroups sont nécessaires pour que le check Docker réussisse. Pour activer les CGroups, consultez la documentation dans le référentiel docker-dd-agent. Si le check échoue en raison d’un emplacement de répertoire cgroup inattendu :
Exécutez mount | grep "cgroup type tmpfs" pour récupérer l’emplacement du répertoire cgroup.
Remplacez la première occurrence de /sys/fs/cgroup dans la commande d’installation en une étape par l’emplacement du répertoire cgroup.
Envoyer des métriques custom
Pour envoyer des métriques custom à l’aide de DogStatsD :
Ajoutez l’option -p 8125:8125/udp à la commande d’installation. Cela lie le port StatsD du conteneur à l’adresse IP de l’host.
Configurez votre bibliothèque client pour envoyer des paquets UDP à l’adresse IP de l’host.
Personnaliser la configuration de votre Agent
Pour personnaliser la configuration de votre Agent, consultez la documentation dans le référentiel docker-dd-agent de l’Agent 5. Pour ajuster la configuration d’Autodiscovery, consultez la section Autodiscovery des intégrations Docker. Pour désactiver Autodiscovery, supprimez la variable d’environnement SD_BACKEND de la commande d’installation en une seule étape.
Running CoreOS Container Linux is supported with the Docker runtime. For installation instructions, see Docker.
Pour exécuter CoreOS Tectonic sur Kubernetes, consultez la section Kubernetes.
For information on installing Datadog with OpenShift, see the datadog-openshift repo.
La version BOSH de l'Agent Datadog ne fonctionne que sur les stemcells Ubuntu et Red Hat.
Téléchargez la version de l’Agent Datadog sur votre directeur BOSH :
# BOSH CLI v1bosh upload release https://cloudfoundry.datadoghq.com/datadog-agent/datadog-agent-boshrelease-latest.tgz
# BOSH CLI v2bosh upload-release https://cloudfoundry.datadoghq.com/datadog-agent/datadog-agent-boshrelease-latest.tgz
Configurez Datadog en tant que module complémentaire dans votre configuration de runtime. Remplacez MY_API_KEY par votre clé d’API Datadog :
# runtime.yml---releases:- name:datadog-agentversion:$UPLOADED_VERSION# e.g. 1.0.5140addons:- name:datadogjobs:- name:dd-agentrelease:datadog-agentproperties:dd:use_dogstatsd:yesdogstatsd_port:18125# Many Cloud Foundry deployments have their own StatsD listening on port 8125api_key:MY_API_KEYtags:["my-cloud-foundry-deployment"]# optional. Add any tags you wish# Optionally, enable any Agent Checks here# integrations:# directory:# init_config: {}# instances:# directory: "."
Ajoutez le runtime à votre configuration de runtime :
# BOSH cli v1bosh update runtime-config runtime.yml
# BOSH cli v2bosh update-runtime-config runtime.yml
Redéployez tous les déploiements existants :
# BOSH cli v1bosh deployment myDeployment.yml
bosh -n deploy
# BOSH cli v2bosh -n -d myDeployment deploy myDeployment.yml
Gestion de la configuration
La collection Ansible Datadog prend en charge la plupart des distributions Linux basées sur Debian, RHEL et SUSE, macOS et Windows. Nécessite Ansible version 2.10 ou supérieure.
Prérequis
Windows
Avant de pouvoir utiliser la collection Ansible Datadog pour gérer les hosts Windows, vous devez installer la collection ansible.windows :
ansible-galaxy collection install ansible.windows
openSUSE et SLES
Avant de pouvoir utiliser la collection Ansible Datadog pour gérer les hosts openSUSE/SLES, vous devez installer la collection community.general :
Installez la collection Ansible Datadog depuis Ansible Galaxy sur votre serveur Ansible :
ansible-galaxy collection install datadog.dd
La collection Ansible Datadog est également disponible via le Red Hat Automation Hub où elle est officiellement certifiée par Red Hat.
L’installation de la collection est recommandée. Si nécessaire, vous pouvez également installer Datadog à l’aide du rôle autonome.
Pour déployer l’Agent Datadog sur les hosts, ajoutez le rôle Datadog et votre clé d’API à votre playbook. Remplacez MY_API_KEY par votre clé d’API Datadog :
- hosts:serverstasks:- name:Import the Datadog Agent role from the Datadog collectionimport_role:name:datadog.dd.agentvars:datadog_api_key:"MY_API_KEY"datadog_agent_major_version:5
Pour vous assurer que l’Agent peut regrouper vos hosts ensemble, utilisez uniquement les noms d’hôtes de nœuds que l’Agent Datadog suit. Vous pouvez vérifier quels noms d’hôtes l’Agent suit à l’aide de la commande suivante :
service datadog-agent info
Checks spécifiques de l’Agent
Pour utiliser un check ou une intégration spécifique de l’Agent sur l’un de vos nœuds, vous pouvez utiliser la variable datadog_checks. Voici un exemple pour le check de processus :
- hosts:serverstasks:- name:Import the Datadog Agent role from the Datadog collectionimport_role:name:datadog.dd.agentvars:datadog_api_key:"MY_API_KEY"datadog_agent_major_version:5datadog_checks:process:init_config:instances:- name:sshsearch_string:['ssh','sshd']- name:syslogsearch_string:['rsyslog']cpu_check_interval:0.2exact_match:trueignore_denied_access:true
Vous pouvez trouver d’autres exemples d’utilisation du rôle Agent sur le référentiel Github du rôle autonome.
Métriques et événements
Pour obtenir des métriques et des événements sur Datadog après l’exécution d’Ansible, consultez la page Github du projet de rappel Ansible.
Le module datadog_agent ne prend en charge que les nœuds Linux. Nécessite Puppet Agent version 2.7 ou supérieure.
Installez le module datadog_agent depuis le Puppet Forge sur votre serveur Puppet :
Pour les nouvelles installations, exécutez la commande module install :
puppet module install datadog-datadog_agent
Si le module est déjà installé, mettez-le à niveau :
puppet module upgrade datadog-datadog_agent
Pour déployer l’Agent Datadog sur les nœuds, ajoutez cette classe paramétrée à vos manifestes. Remplacez MY_API_KEY par votre clé d’API Datadog :
Pour vous assurer que l’Agent peut regrouper vos hosts ensemble, utilisez uniquement les noms d’hôtes de nœuds que l’Agent Datadog suit. Vous pouvez vérifier quels noms d’hôtes l’Agent suit à l’aide de la commande suivante :
service datadog-agent info
Activer la génération de rapports vers Datadog sur votre serveur Puppet :
Ajoutez les paramètres suivants à /etc/puppet/puppet.conf :
Exécutez Puppet sur votre serveur Puppet pour installer toutes les dépendances nécessaires.
Redémarrez votre serveur Puppet pour commencer à recevoir des données Puppet dans Datadog.
Checks spécifiques de l’Agent
Pour utiliser un check ou une intégration spécifique de l’Agent sur l’un de vos nœuds, consultez le manifeste d’intégration pertinent pour un exemple de code. Voici un exemple pour l’intégration Elasticsearch :
Si vous utilisez Berkshelf, ajoutez le cookbook à votre Berksfile :
cookbook 'datadog'
Si vous n’utilisez pas Berkshelf, installez le cookbook dans votre référentiel à l’aide de Knife :
knife cookbook site install datadog
Définissez les attributs spécifiques à Datadog dans un rôle, un environnement ou une autre recette. Remplacez MY_API_KEY par votre clé d’API Datadog :
node.default['datadog']['api_key'] = "MY_API_KEY"
# Use an existing application key or create a new one for Chef
node.default['datadog']['application_key'] = "Generate Application Key"
Importez le cookbook mis à jour sur votre serveur Chef :
Ajoutez le cookbook à la run_list ou au role de votre nœud :
"run_list": [
"recipe[datadog::dd-agent]"
]
Attendez la prochaine exécution planifiée de chef-client.
La formule Datadog Saltstack ne prend en charge que les systèmes basés sur Debian et RedHat.
Les instructions suivantes ajoutent la formule Datadog à l'environnement Salt de base. Pour l'ajouter à un autre environnement Salt, remplacez les références à base par le nom de votre environnement Salt.
Installer à l’aide de gitfs_remotes
Installez la formule Datadog dans l’environnement de base de votre nœud Salt Master, en utilisant l’option gitfs_remotes dans votre fichier de configuration Salt Master (par défaut /etc/salt/master) :
fileserver_backend:- roots# Active by default, necessary to be able to use the local salt files we define in the next steps- gitfs# Adds gitfs as a fileserver backend to be able to use gitfs_remotesgitfs_remotes:- https://github.com/DataDog/datadog-formula.git:- saltenv:- base:- ref:3.0# Pin here the version of the formula you want to use
Ajoutez le fichier pilier datadog.sls au fichier pillar top (par défaut /srv/pillar/top.sls) :
base:'*':- datadog
Pour utiliser un check ou une intégration spécifique de l’Agent sur l’un de vos hosts, vous pouvez utiliser la variable checks. Voici un exemple pour l’intégration directory :
Consultez le référentiel Github de la formule pour la configuration des logs, les exemples de checks et les cas d’utilisation avancés.
Installation depuis les sources
L'Agent Datadog nécessite python 2.7 et sysstat sur Linux.
Utilisez le script d’installation source en une seule étape. Remplacez MY_API_KEY par votre clé d’API Datadog :
DD_API_KEY=MY_API_KEY sh -c "$(curl -L https://raw.githubusercontent.com/DataDog/dd-agent/master/packaging/datadog-agent/source/setup_agent.sh)"
Le script installe l’Agent dans son propre sandbox autonome situé dans ~/.datadog-agent.
Pour rendre l’installation permanente, configurez votre démon init pour qu’il exécute $sandbox_dir/bin/agent avec $sandbox_dir dans le répertoire de travail actuel. Le répertoire sandbox est portable et peut être exécuté à partir de n’importe quel emplacement de votre système de fichiers. Le répertoire sandbox est défini par défaut sur ~/.datadog-agent.
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles: