Ce guide décrit comment installer la version 6 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
La version 6 de l’Agent Datadog nécessite macOS 10.12 ou ultérieur.
La version 6.34 de l’Agent est la dernière à prendre en charge macOS 10.12.
La version 6.38 de l’Agent est la dernière version 6 pour macOS.
Installer l’Agent
Ligne de commande
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
L’Agent s’exécute à l’ouverture de la session. Vous pouvez le désactiver à partir de la barre d’état système.
LaunchDaemon
L’Agent Datadog peut être installé en tant que LaunchDaemon dans l’ensemble du système en spécifiant DD_SYSTEMDAEMON_INSTALL=true et DD_SYSTEMDAEMON_USER_GROUP=username:groupname. Remplacez MY_API_KEY par votre clé d’API Datadog :
L’Agent s’exécute au démarrage du système. Un utilisateur non root valide et son groupe doivent être fournis à l’aide de la variable DD_SYSTEMDAEMON_USER_GROUP. Le processus de l’Agent s’exécute sous cet utilisateur et ce groupe.
L’application de la barre d’état système n’est pas prise en charge par les installations via un LaunchDaemon dans l’ensemble du système.
Ajoutez la ligne suivante à /opt/datadog-agent/etc/datadog.yaml, en remplaçant MY_API_KEY par votre clé d’API Datadog :
api_key: MY_API_KEY
site: datad0g.com
Gérer l’Agent
Vous disposez des ressources suivantes pour gérer l’Agent :
L’application de l’Agent Datadog dans la barre d’état système, pour les installations basées sur un seul utilisateur
launchctl pour les installations via un LaunchDaemon dans l’ensemble du système
La commande datadog-agent ; le binaire se trouve dans /usr/local/bin
Activez ou désactivez les intégrations dans /opt/datadog-agent/etc/conf.d.
Windows
Depuis la version 6.11.0, les composants principaux, APM et de tracing de l’Agent Windows s’exécutent sous le compte ddagentuser et sont créés au moment de l’installation, au lieu de s’exécuter sous le compte LOCAL_SYSTEM. Si vous passez d’une version 6.x de l’Agent Datadog à la version 6.11 ou à une version ultérieure, consultez la documentation Utilisateur de l’Agent pour Windows avant de procéder à la mise à niveau.
Les liens vers les différentes versions du programme d’installation de Windows sont fournis au format JSON.
Exécutez l’une des commandes suivantes dans le répertoire où vous avez téléchargé le programme d’installation, en remplaçant MY_API_KEY par votre clé d’API Datadog :
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.
Si vous disposez d’un fichier de configuration de l’Agent, les valeurs existantes sont conservées lors de la mise à jour.
Vous pouvez configurer certaines des options de l’Agent au cours de la procédure d’installation initiale. Pour en savoir plus, consultez les options de configuration install_script.
Pour installer l’Agent, exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
Si vous effectuez une mise à niveau depuis la version 5.17 ou une version ultérieure de l’Agent, vous pouvez choisir d’importer votre configuration existante de l’Agent 5 :
Si vous n’effectuez pas de mise à niveau et que vous ne souhaitez pas utiliser une ancienne configuration, copiez l’exemple de configuration et installez le fichier Agent. 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"
Configurez la région Datadog :
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/'
/etc/datadog-agent/datadog.yaml"
Assurez-vous que les autorisations de l’utilisateur de l’Agent sont correctes :
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Démarrez l’Agent :
sudo systemctl restart datadog-agent.service
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 :
Si vous effectuez une mise à niveau depuis la version 5.17 ou une version ultérieure de l’Agent, vous pouvez choisir d’importer votre configuration existante de l’Agent 5 :
Si vous n’effectuez pas de mise à niveau et que vous ne souhaitez pas utiliser une ancienne configuration, copiez l’exemple de configuration et installez le fichier Agent. 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"
Configurez la région Datadog :
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Assurez-vous que les autorisations de l’utilisateur de l’Agent sont correctes :
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Démarrez l’Agent :
Ubuntu 16.04 et versions ultérieures :
sudo systemctl restart datadog-agent.service
Ubuntu 14.04 :
sudo initctl start datadog-agent
Installation en une seule étape
La commande en une seule étape installe les packages YAM 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.
Si vous disposez d’un fichier de configuration de l’Agent, les valeurs existantes sont conservées lors de la mise à jour.
Vous pouvez configurer certaines des options de l’Agent au cours de la procédure d’installation initiale. Pour en savoir plus, consultez les options de configuration install_script.
Exécutez la commande suivante, en remplaçant MY_API_KEY par votre clé d’API Datadog :
If you’re not upgrading and do not want to use an old configuration, copy the example config into place and install the Agent. Replace MY_API_KEY with your Datadog API key:
sudo sh -c "sed 's/api_key:.*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Configure the Datadog region:
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Ensure the Agent user’s permissions are correct::
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Start the Agent:
Amazon Linux 2.0:
sudo systemctl restart datadog-agent.service
Amazon Linux 1.0:
sudo initctl start datadog-agent
One-step install
The one-step command installs the YUM packages for the Datadog Agent and prompts you for your password.
If the Agent is not already installed on your machine and you don’t want it to start automatically after the installation, prepend DD_INSTALL_ONLY=true to the command before running it.
If you have an existing Agent configuration file, existing values are retained during the update.
You can configure some of the Agent options during the initial install process. For more information, check the install_script configuration options.
Run the following command, replacing MY_API_KEY with your Datadog API key:
If you’re not upgrading and do not want to use an old configuration, copy the example config into place and install the Agent. Replace MY_API_KEY with your Datadog API key:
sudo sh -c "sudo sh -c "sed 's/api_key:.*/api_key: .*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Configure the Datadog region:
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Ensure the Agent user’s permissions are correct::
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Start the Agent:
Centos or Red Hat 7 and higher:
sudo systemctl restart datadog-agent.service
Centos or Red Hat 6:
sudo initctl start datadog-agent
One-step install
The one-step command installs the YUM packages for the Datadog Agent and prompts you for your password.
If the Agent is not already installed on your machine and you don’t want it to start automatically after the installation, prepend DD_INSTALL_ONLY=true to the command before running it.
If you have an existing Agent configuration file, existing values are retained during the update.
You can configure some of the Agent options during the initial install process. For more information, check the install_script configuration options.
Run the following command, replacing MY_API_KEY with your Datadog API key:
If you’re not upgrading and do not want to use an old configuration, copy the example config into place and install the Agent. Replace MY_API_KEY with your Datadog API key:
sudo sh -c "sudo sh -c "sed 's/api_key:.*/api_key: .*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Configure the Datadog region:
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Ensure the Agent user’s permissions are correct::
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Restart the Agent:
sudo systemctl restart datadog-agent.service
One-step install
The one-step command installs the YUM packages for the Datadog Agent and prompts you for your password.
If the Agent is not already installed on your machine and you don’t want it to start automatically after the installation, prepend DD_INSTALL_ONLY=true to the command before running it.
If you have an existing Agent configuration file, existing values are retained during the update.
You can configure some of the Agent options during the initial install process. For more information, check the install_script configuration options.
Run the following command, replacing MY_API_KEY with your Datadog API key:
If you’re not upgrading and do not want to use an old configuration, copy the example config into place and install the Agent. Replace MY_API_KEY with your Datadog API key:
sudo sh -c "sudo sh -c "sed 's/api_key:.*/api_key: .*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Configure the Datadog region:
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Ensure the Agent user’s permissions are correct::
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Restart the Agent:
sudo systemctl restart datadog-agent.service
One-step install
The one-step command installs the YUM packages for the Datadog Agent and prompts you for your password.
If the Agent is not already installed on your machine and you don’t want it to start automatically after the installation, prepend DD_INSTALL_ONLY=true to the command before running it.
If you have an existing Agent configuration file, existing values are retained during the update.
You can configure some of the Agent options during the initial install process. For more information, check the install_script configuration options.
Run the following command, replacing MY_API_KEY with your Datadog API key:
Si vous effectuez une mise à niveau depuis la version 5.17 ou une version ultérieure de l’Agent, vous pouvez choisir d’importer votre configuration existante de l’Agent 5 :
Si vous n’effectuez pas de mise à niveau et que vous ne souhaitez pas utiliser une ancienne configuration, copiez l’exemple de configuration et installez le fichier Agent. Remplacez MY_API_KEY par votre clé d’API Datadog :
sudo sh -c "sudo sh -c "sed 's/api_key:.*/api_key: .*/api_key: MY_API_KEY/' /etc/datadog-agent/datadog.yaml.example > /etc/datadog-agent/datadog.yaml"
Configurez la région Datadog :
sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"
Assurez-vous que les autorisations de l’utilisateur de l’Agent sont correctes :
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 640 /etc/datadog-agent/datadog.yaml"
Restart the Agent:
sudo systemctl restart datadog-agent.service
Installation en une seule étape
The one-step command installs the latest BFF package for the Datadog Agent and prompts you for your password if necessary. 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 :
Ensure that the Datadog Agent has the correct permissions:
sudo sh -c "chown dd-agent:dd-agent /etc/datadog-agent/datadog.yaml && chmod 660 /etc/datadog-agent/datadog.yaml"
Stop the Agent service:
sudo stopsrc -s datadog-agent
Verify the Agent service has stopped:
sudo lssrc -s datadog-agent
Restart the Agent service:
sudo startsrc -s datadog-agent
Cloud and containers
Run the Datadog Agent directly in your Kubernetes cluster to start collecting your cluster and applications metrics, traces, and logs. You can deploy the Agent with a Helm chart, the Datadog Operator or directly with a DaemonSet. For more information about installing the Datadog Agent on different distributions, see the Kubernetes distributions documentation.
Installing the Datadog Agent
To install the chart with a custom release name RELEASE_NAME:
This chart adds the Datadog Agent to all nodes in your cluster using a DaemonSet. Soon after installation, Datadog begins to report hosts and metrics data in your account.
Enabling log collection
To enable log collection with Helm, update your datadog-values.yaml file with the following log collection configuration:
The one-step installation command runs a signed Docker container which embeds the Datadog Agent to monitor your host. The Docker integration is enabled by default, as well as Autodiscovery in automatic configuration mode.
You must not run more than one Datadog Agent per node. Running multiple Agents may result in unexpected behavior.
For a one-step install, run the following command. Replace MY_API_KEY with your Datadog API key:
If the one-step installation command does not work, it’s possible that your system mounts the cgroup directory in an unexpected place or does not use CGroups for memory management. CGroups are required for the Docker check to succeed. To enable CGroups, see the Setup documentation.
If CGroups are enabled, but the check is failing because of an unexpected cgroup directory location:
Run mount | grep "cgroup type tmpfs" to retrieve the location of the cgroup directory.
Replace the first occurrence of /sys/fs/cgroup in the one-step installation command with the location of the cgroup directory.
Send custom metrics with DogStatsD
By default, DogStatsD only listens to localhost. To listen to DogStatsD packets from other containers:
Add -e DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true to the container’s parameters.
Bind the container’s statsd port to the hosts’s IP by adding the -p 8125:8125/udp option to the container’s parameters.
Configure your client library to send UDP packets to the hosts’s IP.
Running CoreOS Container Linux is supported with the Docker runtime. For installation instructions, see Docker.
To run CoreOS Tectonic on Kubernetes, see Kubernetes.
Starting with version 6.1, the Datadog Agent supports monitoring OpenShift Origin and Enterprise clusters. Depending on your needs and the security constraints of your cluster, three deployment scenarios are supported:
The Datadog Agent BOSH release only works on Ubuntu and Red Hat stemcells.
Upload the Datadog Agent release to your BOSH Director:
# 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
Configure Datadog as an addon in your runtime config. Replace MY_API_KEY with your Datadog API key::
# 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: "."
Install the Datadog Ansible collection from Ansible Galaxy on your Ansible server:
ansible-galaxy collection install datadog.dd
The Datadog Ansible collection is also available through the Red Hat Automation Hub where it is officially certified by Red Hat.
Installing the collection is recommended. If needed, you can also install Datadog using the standalone role.
To deploy the Datadog Agent on hosts, add the Datadog role and your API key to your playbook. Replace MY_API_KEY with your Datadog API key:
- 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:6datadog_site:"datad0g.com"
To ensure that the Agent can group your hosts together, only use node hostnames that the Datadog Agent is tracking. You can check what hostnames the Agent is tracking using the following command:
sudo datadog-agent status
Specific Agent checks
To use a specific Agent check or integration on one of your nodes, you can use the datadog_checks variable. Here is an example for the process check:
- 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:6datadog_site:"datad0g.com"datadog_checks:process:init_config:instances:- name:sshsearch_string:['ssh','sshd']- name:syslogsearch_string:['rsyslog']cpu_check_interval:0.2exact_match:trueignore_denied_access:true
You can find more examples of the Agent role usage on the GitHub repo for the standalone role.
Metrics and events
To get metrics and events on Datadog after Ansible runs, see the Ansible callback project’s GitHub page.
Starting with version 2.9.0, the datadog_agent module supports both Windows and Linux nodes. Previous versions of the datadog_agent module only support Linux nodes.
Requirements:
Requires Puppet Open Source version >= 4.6 or Puppet Enterprise version >= 2016.4
Install the Agent
Install the datadog_agent module from the Puppet Forge on your Puppet server:
For fresh installs, run the module install command:
puppet module install datadog-datadog_agent
If the module is already installed, upgrade it:
puppet module upgrade datadog-datadog_agent
To deploy the Datadog Agent on nodes, add this parametrized class to your manifests. Replace MY_API_KEY with your Datadog API key:
To ensure that the Agent can group your hosts together, only use node hostnames that the Datadog Agent is tracking. You can check what hostnames the Agent is tracking using the following command:
sudo datadog-agent status
Enable reporting to Datadog on your Puppet server:
Add the following parameters to /etc/puppet/puppet.conf:
Run Puppet on your Puppet server to install all necessary dependencies.
Restart your Puppet server to begin receiving Puppet data in Datadog.
Specific Agent checks
To use a specific Agent check or integration on one of your nodes, see the relevant integration manifest for a code sample. Here is an example for the elasticsearch integration:
If you are using Berkshelf, add the cookbook to your Berksfile:
cookbook 'datadog', '~> 4.0'
If you’re not using Berkshelf, install the cookbook in to your repository using Knife:
knife cookbook site install datadog
Set the Datadog-specific attributes in either a role, environment, or another recipe. Replace MY_API_KEY with your Datadog API key:
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"
# Enable install for Agent version 6
node.default['datadog']['agent_major_version'] = 6
# Set the Datadog site
node.default['datadog']['site'] = "datad0g.com"
The Datadog Saltstack formula only supports Debian-based and RedHat-based systems.
The following instructions add the Datadog formula to the base Salt environment. To add it to another Salt environment, replace references to base with the name of your Salt environment.
Install using gitfs_remotes
Install the Datadog formula in the base environment of your Salt Master node, using the gitfs_remotes option in your Salt Master configuration file (by default /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