Install Datadog Agent 6

This guide covers installing Agent 6. Datadog recommends installing or upgrading to Agent 7 for the latest features. For information on installing the latest version of the Agent, follow the latest Agent Installation Instructions. For information on upgrading to Agent 7 from an earlier version, see Upgrade to Datadog Agent v7.

macOS

  • Datadog Agent version 6 requires macOS 10.12 or higher.
  • Agent 6.34 is the last release to support macOS 10.12.
  • Agent 6.38 is the last Agent 6 release for macOS.

Install the Agent

Command line

Run the following command, replacing MY_API_KEY with your Datadog API key:

DD_AGENT_MAJOR_VERSION=6 DD_API_KEY=MY_API_KEY DD_SITE="${site}" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"

The Agent runs at login. You can disable it from the system tray.

LaunchDaemon

The Datadog Agent can be installed as a system-wide LaunchDaemon by specifying DD_SYSTEMDAEMON_INSTALL=true and DD_SYSTEMDAEMON_USER_GROUP=username:groupname. Replace MY_API_KEY with your Datadog API key:

DD_SYSTEMDAEMON_INSTALL=true DD_SYSTEMDAEMON_USER_GROUP=username:groupname DD_AGENT_MAJOR_VERSION=6 DD_API_KEY=MY_API_KEY DD_SITE="datad0g.com" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"

The Agent runs at system startup. A valid non-root user and its group must be provided using the DD_SYSTEMDAEMON_USER_GROUP variable. The agent process runs under this user and group.

The system tray app is not supported under system-wide LaunchDaemon installs.

GUI

  1. Download and install the DMG package.
  2. Add the following line to /opt/datadog-agent/etc/datadog.yaml, replacing MY_API_KEY with your Datadog API key:
    api_key: MY_API_KEY
site: datad0g.com

Manage the Agent

To manage the Agent, use:

  • the Datadog Agent app in the system tray for a single user install.
  • launchctl for a system-wide LaunchDaemon install.
  • the datadog-agent command. The binary is located in /usr/local/bin.

Enable or disable integrations in /opt/datadog-agent/etc/conf.d.

Windows

Starting with release 6.11.0, the core and APM/trace components of the Windows Agent run under the ddagentuser account and are created at install time, instead of running under the LOCAL_SYSTEM account. If you’re upgrading from a Datadog Agent version6.x to 6.11 or greater, review the Windows Agent user documentation before your upgrade.

Links to all available versions of the Windows installer are available in JSON format.

Install the Agent

Interactive

  1. Download and run the Datadog Agent installer.
  2. Run the installer (as Administrator) by opening datadog-agent-6-latest.amd64.msi.
  3. Follow the prompts, accept the license agreement, and enter your Datadog API key.
  4. Enter your Datadog region: .
  5. Optionally, launch the Datadog Agent Manager when prompted.

Unattended

  1. Download and run the Datadog Agent installer.
  2. Run one of the following commands inside the directory where you downloaded the installer, replacing MY_API_KEY with your Datadog API key:
    • Command prompt:
      start /wait msiexec /qn /i datadog-agent-6-latest.amd64.msi APIKEY="MY_API_KEY" SITE="datad0g.com"
    • Powershell:
      Start-Process -Wait msiexec -ArgumentList '/qn /i datadog-agent-6-latest.amd64.msi APIKEY="MY_API_KEY" SITE="datad0g.com"'

HOSTNAME and TAGS are optional values. See the Windows Agent documentation for all available options.

Deployment to Azure

To install the Agent on Azure, follow the Microsoft Azure documentation.

Linux and Unix

    One-step install

    The one-step command installs the APT 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.

    To install the Agent, run the following command, replacing MY_API_KEY with your Datadog API key:

    DD_API_KEY=MY_API_KEY DD_SITE="datad0g.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent6.sh)"

    Multi-step install

    1. Set up APT so it can download through HTTPS and install curl and gnupg:

      sudo apt-get update
sudo apt-get install apt-transport-https curl gnupg

    2. Set up the Datadog Debian repo on your system and create a Datadog archive keyring:

      sudo sh -c "echo 'deb [signed-by=/usr/share/keyrings/datadog-archive-keyring.gpg] https://apt.datadoghq.com/ stable 6' > /etc/apt/sources.list.d/datadog.list"
sudo touch /usr/share/keyrings/datadog-archive-keyring.gpg
sudo chmod a+r /usr/share/keyrings/datadog-archive-keyring.gpg

curl https://keys.datadoghq.com/DATADOG_APT_KEY_CURRENT.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_06462314.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_C0962C7D.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_F14F620E.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_382E94DE.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch

    3. If running Debian 8 or earlier, copy the keyring to /etc/apt/trusted.gpg.d:

      sudo cp -a /usr/share/keyrings/datadog-archive-keyring.gpg /etc/apt/trusted.gpg.d/

    4. Update your local APT repo and install the Agent:

      sudo apt-get update
sudo apt-get install datadog-agent datadog-signing-keys

    5. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    6. 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"

    7. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/'
                 /etc/datadog-agent/datadog.yaml"

    8. 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"

    9. Start the Agent:

      sudo systemctl restart datadog-agent.service

    One-step install

    The one-step command installs the APT 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.

    Run the following command, replacing MY_API_KEY with your Datadog API key:

    DD_API_KEY=MY_API_KEY bash -c "$(curl -L https://raw.githubusercontent.com/DataDog/dd-agent/master/packaging/datadog-agent/source/install_agent.sh)"

    Multi-step install

    1. Set up APT so it can download through HTTPS and install curl and gnupg:

      sudo apt-get update
sudo apt-get install apt-transport-https curl gnupg

    2. Set up the Datadog Debian repo on your system and create a Datadog archive keyring:

      sudo sh -c "echo 'deb [signed-by=/usr/share/keyrings/datadog-archive-keyring.gpg] https://apt.datadoghq.com/ stable 6' > /etc/apt/sources.list.d/datadog.list"
sudo touch /usr/share/keyrings/datadog-archive-keyring.gpg
sudo chmod a+r /usr/share/keyrings/datadog-archive-keyring.gpg

curl https://keys.datadoghq.com/DATADOG_APT_KEY_CURRENT.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_06462314.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_C0962C7D.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_F14F620E.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch
curl https://keys.datadoghq.com/DATADOG_APT_KEY_382E94DE.public | sudo gpg --no-default-keyring --keyring /usr/share/keyrings/datadog-archive-keyring.gpg --import --batch

    3. If running Ubuntu 14 or earlier, copy the keyring to /etc/apt/trusted.gpg.d:

      sudo cp -a /usr/share/keyrings/datadog-archive-keyring.gpg /etc/apt/trusted.gpg.d/

    4. Update your local APT repo and install the Agent:

      sudo apt-get update
sudo apt-get install datadog-agent datadog-signing-keys

    5. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    6. 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"

    7. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    8. 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"

    9. Start the Agent:

      • Ubuntu 16.04 and higher:
        sudo systemctl restart datadog-agent.service
      • Ubuntu 14.04:
        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.

    1. Run the following command, replacing MY_API_KEY with your Datadog API key:

      DD_API_KEY=MY_API_KEY DD_SITE="datad0g.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent6.sh)"

    2. For Amazon Linux 2022 installations on Agent version <= 6.39. The Agent requires the libxcrypt-compat package:

      dnf install -y libxcrypt-compat

    Multi-step install

    1. On an x86_64 host, set up the Datadog YUM repo by creating /etc/yum.repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=https://yum.datadoghq.com/stable/6/x86_64/
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

    2. On an arm64 host, set up the Datadog YUM repo by creating /etc/yum.repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=https://yum.datadoghq.com/stable/6/aarch64/ 
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

    3. If upgrading from Agent 5 or 6, delete the obsolete RPM GPG key:

      sudo sh -c 'if rpm -q gpg-pubkey-4172a230-55dd14f6 >/dev/null; then rpm --erase gpg-pubkey-4172a230-55dd14f6; fi'

    4. Update your local yum repo and install the Agent:

      sudo yum makecache
sudo yum install datadog-agent

    5. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    6. 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"

    7. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    8. 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"

    9. 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:

    DD_UPGRADE=true DD_SITE="datad0g.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent6.sh)"

    Multi-step install

    1. Set up the Datadog YUM repo by creating /etc/yum.repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=https://yum.datadoghq.com/rpm/x86_64/
enabled=1
gpgcheck=0
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

      Note: The repo_gpgcheck=0 option is a workaround for a bug in DNF.

    2. If you’re upgrading from Agent 5 or a previous version of Agent 6, delete the obsolete RPM GPG key:

      sudo sh -c 'if rpm -q gpg-pubkey-4172a230-55dd14f6 >/dev/null; then rpm --erase gpg-pubkey-4172a230-55dd14f6; fi'

    3. Update your local yum repo and install the Agent:

      sudo yum makecache
sudo yum remove datadog-agent-base
sudo yum install datadog-agent

    4. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    5. 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"

    6. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    7. 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"

    8. 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:

    DD_UPGRADE=true DD_SITE="datad0g.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent6.sh)"

    Multi-step install

    1. Set up the Datadog YUM repo by creating /etc/yum.repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=https://yum.datadoghq.com/rpm/x86_64/
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

    2. If you’re upgrading from Agent 5 or a previous version of Agent 6, delete the obsolete RPM GPG key:

      sudo sh -c 'if rpm -q gpg-pubkey-4172a230-55dd14f6 >/dev/null; then rpm --erase gpg-pubkey-4172a230-55dd14f6; fi'

    3. Update your local yum repo and install the Agent:

      sudo yum makecache
sudo yum remove datadog-agent-base
sudo yum install datadog-agent

    4. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    5. 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"

    6. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    7. 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"

    8. 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:

    DD_API_KEY=MY_API_KEY bash -c "$(curl -L https://raw.githubusercontent.com/DataDog/dd-agent/master/packaging/datadog-agent/source/install_agent.sh)"

    Multi-step install

    1. Set up the Datadog YUM repo by creating /etc/yum.repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=https://yum.datadoghq.com/rpm/x86_64/
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

    2. If you’re upgrading from Agent 5 or a previous version of Agent 6, delete the obsolete RPM GPG key:

      sudo sh -c 'if rpm -q gpg-pubkey-4172a230-55dd14f6 >/dev/null; then rpm --erase gpg-pubkey-4172a230-55dd14f6; fi'

    3. Update your local yum repo and install the Agent:

      sudo yum makecache
sudo yum install datadog-agent

    4. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    5. 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"

    6. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    7. 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"

    8. 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:

    DD_API_KEY=MY_API_KEY DD_SITE="datad0g.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent6.sh)"

    Multi-step install

    1. Set up the Datadog YUM repo by creating /etc/zypp/repos.d/datadog.repo with the following configuration:

      [datadog]
name=Datadog, Inc.
baseurl=hhttps://yum.datadoghq.com/suse/stable/6/x86_64
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
       https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public

    2. If you’re upgrading from Agent 5 or a previous version of Agent 6, delete the obsolete RPM GPG key:

      sudo sh -c 'if rpm -q gpg-pubkey-4172a230-55dd14f6 >/dev/null; then rpm --erase gpg-pubkey-4172a230-55dd14f6; fi'

    3. Update your local zypper repo and install the Agent:

      sudo zypper refresh
sudo rpm --import https://keys.datadoghq.com/DATADOG_RPM_KEY_CURRENT.public
sudo rpm --import https://keys.datadoghq.com/DATADOG_RPM_KEY_4F09D16B.public
sudo rpm --import https://keys.datadoghq.com/DATADOG_RPM_KEY_B01082D3.public
sudo rpm --import https://keys.datadoghq.com/DATADOG_RPM_KEY_FD4BF915.public
sudo rpm --import https://keys.datadoghq.com/DATADOG_RPM_KEY_E09422B3.public
sudo zypper install datadog-agent

    4. Optionally, if upgrading from Agent 5.17 or higher, import your existing Agent 5 configuration:

      sudo -u dd-agent -- datadog-agent import /etc/dd-agent /etc/datadog-agent

    5. 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"

    6. Configure the Datadog region:

      sudo sh -c "sed -i 's/# site:.*/site: datad0g.com/' /etc/datadog-agent/datadog.yaml"

    7. 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"

    8. Restart the Agent:

      sudo systemctl restart datadog-agent.service

    One-step install

    The one-step command installs the latest BFF package for the Datadog Agent and prompts you for your password if necessary. 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.

    Run the following command, replacing MY_API_KEY with your Datadog API key:

    DD_API_KEY=MY_API_KEY DD_SITE="datad0g.com" ksh -c "$(curl -L https://raw.githubusercontent.com/DataDog/datadog-unix-agent/master/scripts/install_script.sh)"

    Upgrade from a previous installation

    To install the Agent while keeping your existing configuration, run the following command:

    DD_UPGRADE=true DD_SITE="datad0g.com" ksh -c "$(curl -L https://raw.githubusercontent.com/DataDog/datadog-unix-agent/master/scripts/install_script.sh)"

    For a full list of the available installation script environment variables, see Basic Agent Usage for AIX.

    Multi-step install

    1. Download the preferred BFF from the datadog-unix-agent repo releases.

    2. Install the artifact as root with installp:

      installp -aXYgd datadog-unix-agent-latest.powerpc.aix..bff datadog-unix-agent

    3. If you don’t have an existing configuration file, copy the example config into place. 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"

    4. Configure the Datadog region:

      sudo sh -c "sed \'s/# site:.*/site: datad0g.com/\' /etc/datadog-agent/datadog.yaml > /etc/datadog-agent/datadog.yaml.new && mv /etc/datadog-agent/datadog.yaml.new /etc/datadog-agent/datadog.yaml"

    5. 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"

    6. Stop the Agent service:

      sudo stopsrc -s datadog-agent

    7. Verify the Agent service has stopped:

      sudo lssrc -s datadog-agent

    8. 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:

      1. Install Helm.

      2. Add the Datadog Helm repository:

        helm repo add datadog https://helm.datadoghq.com

      3. Fetch the latest version of newly added charts:

        helm repo update

      4. Create an empty values.yaml file, and override any of the default values if desired. See the Datadog helm-charts repo for examples.

      5. Deploy the Datadog Agent, replacing MY_API_KEY with your Datadog API key: With Helm v3+:

        helm install RELEASE_NAME -f datadog-values.yaml --set datadog.site='datad0g.com' --set agents.image.tag='6' --set datadog.apiKey=MY_API_KEY datadog/datadog

        With Helm v1 or v2:

        helm install -f datadog-values.yaml --name RELEASE_NAME --set datadog.site='datad0g.com' --set agents.image.tag='6' --set datadog.apiKey=MY_API_KEY datadog/datadog

        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:

      datadog:
  logs:
    enabled: true
    containerCollectAll: true

      Then upgrade your Datadog Helm chart:

      helm upgrade -f datadog-values.yaml RELEASE_NAME datadog/datadog

      Enabling trace collection

      Follow the dedicated APM setup documentation to learn how to collect your application traces in a Kubernetes environment.

      Further Reading

      For information on available Agent features, see the Kubernetes documentation.

      One-step install

      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:

      On Amazon Linux v2:

      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=MY_API_KEY -e DD_SITE="datad0g.com" gcr.io/datadoghq/agent:6

      On other operating systems:

      docker run -d --name dd-agent -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=MY_API_KEY -e DD_SITE="datad0g.com" gcr.io/datadoghq/agent:6

      Troubleshooting

      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:

      1. Run mount | grep "cgroup type tmpfs" to retrieve the location of the cgroup directory.
      2. Replace the first occurence 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:

      1. Add -e DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true to the container’s parameters.
      2. Bind the container’s statsd port to the hosts’s IP by adding the -p 8125:8125/udp option to the container’s parameters.
      3. Configure your client library to send UDP packets to the hosts’s IP.

      Customize your Agent configuration

      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:

      To install OpenShift, see the Kubernetes installation instructions. The Kubernetes integration targets OpenShift 3.7.0+ by default. For older versions of OpenShift, you must complete additional installation steps. For more information, see the OpenShift integration documentation.

      The Datadog Agent BOSH release only works on Ubuntu and Red Hat stemcells.

      1. Upload the Datadog Agent release to your BOSH Director:

        # BOSH CLI v1
bosh upload release https://cloudfoundry.datadoghq.com/datadog-agent/datadog-agent-boshrelease-latest.tgz

# BOSH CLI v2
bosh upload-release https://cloudfoundry.datadoghq.com/datadog-agent/datadog-agent-boshrelease-latest.tgz

      2. Configure Datadog as an addon in your runtime config. Replace MY_API_KEY with your Datadog API key::

        # runtime.yml
---
releases:
- name: datadog-agent
   version: $UPLOADED_VERSION # e.g. 1.0.5140

addons:
- name: datadog
jobs:
- name: dd-agent
   release: datadog-agent
properties:
   dd:
      use_dogstatsd: yes
      dogstatsd_port: 18125 # Many Cloud Foundry deployments have their own StatsD listening on port 8125
      api_key: MY_API_KEY
      tags: ["my-cloud-foundry-deployment"] # optional. Add any tags you wish
      # Optionally, enable any Agent Checks here
      # integrations:
      #   directory:
      #     init_config: {}
      #     instances:
      #       directory: "."

      3. Add the runtime to your runtime config:

        # BOSH cli v1
bosh update runtime-config runtime.yml

# BOSH cli v2
bosh update-runtime-config runtime.yml

      4. Redeploy any existing deployments:

        # BOSH cli v1
bosh deployment myDeployment.yml
bosh -n deploy

# BOSH cli v2
bosh -n -d myDeployment deploy myDeployment.yml

      Configuration management

        Installing the Agent with Ansible requires Ansible version 2.10 or higher.

        The Datadog Ansible collection supports most Debian, RHEL-based and SUSE-based Linux distributions, macOS, and Windows.

        Prerequisites

        Windows

        Before you can use the Datadog Ansible Collection to manage Windows hosts, you must install the ansible.windows collection:

        ansible-galaxy collection install ansible.windows

        openSUSE and SLES

        Before you can use the Datadog Ansible Collection to manage openSUSE/SLES hosts, you must install the community.general collection:

        ansible-galaxy collection install community.general

        Install Datadog

        1. 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.

        2. 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: servers
tasks:
   - name: Import the Datadog Agent role from the Datadog collection
      import_role:
      name: datadog.dd.agent
vars:
   datadog_api_key: "MY_API_KEY"
   datadog_agent_major_version: 6
   datadog_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: servers
  tasks:
    - name: Import the Datadog Agent role from the Datadog collection
      import_role:
        name: datadog.dd.agent
  vars:
    datadog_api_key: "MY_API_KEY"
    datadog_agent_major_version: 6
    datadog_site: "datad0g.com"
    datadog_checks:
      process:
        init_config:
        instances:
          - name: ssh
            search_string: ['ssh', 'sshd']
          - name: syslog
            search_string: ['rsyslog']
            cpu_check_interval: 0.2
            exact_match: true
            ignore_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

        1. 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

        2. To deploy the Datadog Agent on nodes, add this parametrized class to your manifests. Replace MY_API_KEY with your Datadog API key:

          node "db1.mydomain.com" {
   class { "datadog_agent":
      api_key => "MY_API_KEY",
      datadog_site => "datad0g.com",
      agent_major_version => 6,
   }
}

          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

        3. Enable reporting to Datadog on your Puppet server:

          1. Add the following parameters to /etc/puppet/puppet.conf:

            [master]
report = true
reports = datadog_reports
pluginsync = true

[agent]
report = true
pluginsync = true

          2. In your manifest, add the puppet_run_reports option to your Puppet server. For example:

            node "puppet" {
   class { "datadog_agent":
      api_key => "MY_API_KEY",
      datadog_site => "datad0g.com",
      agent_major_version => 6,
      puppet_run_reports => true,
   }
}

        4. Run Puppet on your Puppet server to install all necessary dependencies.

        5. 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:

        node "elastic-node1.mydomain.com" {
    class { "datadog_agent":
        api_key => "MY_API_KEY",
        datadog_site => "datad0g.com",
        agent_major_version => 6,
    }
    include "datadog_agent::integrations::elasticsearch"
}

        Refer to the GitHub repository of the module for more examples and advanced use cases.

        Requires Chef version 10.14.x or higher.

        1. Add the Datadog cookbook:

          • 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

        2. 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"

        3. Upload the updated cookbook to your Chef server:

          berks upload
# or
knife cookbook upload datadog
knife cookbook list | grep datadog && 
echo -e "e[0;32mdatadog cookbook - OKe[0m" ||
echo -e "e[0;31mmissing datadog cookbook - OKe[0m"

        4. Add the cookbook to your node’s run_list or role:

          "run_list": [
 "recipe[datadog::dd-agent]"
]

        5. Wait for the next scheduled chef-client run.

        For more information and examples, see the Agent GitHub repository.

        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

        1. 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_remotes

gitfs_remotes:
- https://github.com/DataDog/datadog-formula.git:
  - saltenv:
    - base:
    - ref: 3.0 # Pin here the version of the formula you want to use

        2. Restart your Salt Master service:

          systemctl restart salt-master

          or

          service salt-master restart

        Install by cloning the Datadog formula

        1. Clone the Datadog formula on your Salt Master node:
          mkdir -p /srv/formulas && cd /srv/formulas
git clone https://github.com/DataDog/datadog-formula.git
        2. Add the cloned formula to the base environment in the file_roots of your Salt Master configuration file (by default /etc/salt/master):
          file_roots:
  base:
    - /srv/salt/
    - /srv/formulas/datadog-formula/

        Deploy the Agent to your hosts

        1. Add the Datadog formula to your top file (by default /srv/salt/top.sls):

          base:
  '*':
    - datadog

        2. Add a datadog.sls pillar file to your pillar directory (by default /srv/pillar/) and add your API key. Replace MY_API_KEY with your Datadog API key:

          datadog:
  config:
    api_key: MY_API_KEY
  install_settings:
    agent_version: <AGENT6_VERSION>

        3. Add the datadog.sls pillar file to the top pillar file (by default /srv/pillar/top.sls):

          base:
  '*':
    - datadog

        4. To use a specific Agent check or integration on one of your hosts, you can use the checks variable. Here is an example for the directory integration:

          datadog:
  config:
    api_key: MY_API_KEY
  install_settings:
    agent_version: <AGENT6_VERSION>
  checks:
    directory:
      config:
        instances:
          - directory: "/srv/pillar"
            name: "pillars"

        Refer to the formula GitHub repository for logs configuration, check examples, and advanced use cases.

        Install from source

        Follow the instructions in the Agent GitHub repository to build the Agent 6 .deb and .rpm packages on Linux with Docker.

        Alternatively, you can build the Agent binary for version 6 following the Getting Started instructions.

        Further reading

        Additional helpful documentation, links, and articles:

        Basic Agent UsageDOCUMENTATION more more