Skip to content

Set up development requirements

Tooling

The dda CLI is required in all aspects of development and must be available on PATH.

Package managers

Homebrew

Install the dda cask using Homebrew.

brew install --cask dda

You can upgrade to the latest version by running the following command.

brew upgrade --cask dda

Installers

  1. In your browser, download the .pkg file: dda-universal.pkg
  2. Run your downloaded file and follow the on-screen instructions.
  3. Restart your terminal.
  4. To verify that the shell can find and run the dda command in your PATH, use the following command. 
    $ dda --version
0.25.0
  1. Download the file using the curl command. The -o option specifies the file name that the downloaded package is written to. In this example, the file is written to dda-universal.pkg in the current directory. 
    curl -Lo dda-universal.pkg https://github.com/DataDog/datadog-agent-dev/releases/latest/download/dda-universal.pkg
  2. Run the standard macOS installer program, specifying the downloaded .pkg file as the source. Use the -pkg parameter to specify the name of the package to install, and the -target / parameter for the drive in which to install the package. The files are installed to /usr/local/dda, and an entry is created at /etc/paths.d/dda that instructs shells to add the /usr/local/dda directory to. You must include sudo on the command to grant write permissions to those folders. 
    sudo installer -pkg ./dda-universal.pkg -target /
  3. Restart your terminal.
  4. To verify that the shell can find and run the dda command in your PATH, use the following command. 
    $ dda --version
0.25.0
  1. In your browser, download one the .msi files:
  2. Run your downloaded file and follow the on-screen instructions.
  3. Restart your terminal.
  4. To verify that the shell can find and run the dda command in your PATH, use the following command. 
    $ dda --version
0.25.0

  1. Download and run the installer using the standard Windows msiexec program, specifying one of the .msi files as the source. Use the /passive and /i parameters to request an unattended, normal installation.

    msiexec /passive /i https://github.com/DataDog/datadog-agent-dev/releases/latest/download/dda-x64.msi

    msiexec /passive /i https://github.com/DataDog/datadog-agent-dev/releases/latest/download/dda-x86.msi

  2. Restart your terminal.

  3. To verify that the shell can find and run the dda command in your PATH, use the following command. 
    $ dda --version
0.25.0

Standalone binaries

After downloading the archive corresponding to your platform and architecture, extract the binary to a directory that is on your PATH and rename to dda.

Upgrade

You can upgrade to the latest version by running the following command.

dda self update

If you installed dda using a package manager, prefer its native upgrade mechanism.

Docker

Docker is required for both running the developer environment and building images containing the Agent.

  1. Install Docker Desktop for Mac.
  2. Right-click the Docker taskbar item and update Preferences > File Sharing with any locations you need to open.
  1. Install Docker Desktop for Windows.
  2. Right-click the Docker taskbar item and update Settings > Shared Drives with any locations you need to open e.g. C:\.

Install Docker Desktop for your distribution:

Docker Desktop for Ubuntu

Docker Desktop for Debian

Docker Desktop for Fedora

Docker Desktop for Arch

Docker Desktop for RHEL

SSH

Accessing and contributing to the Datadog Agent repositories requires using SSH. Your local SSH agent must be configured with a key that is added to your GitHub account.

If these requirements are met, you can skip this section.

Key generation

Run the following command to generate a new SSH key, replacing <EMAIL_ADDRESS> with one of the email addresses associated with your GitHub account. This email will be used for every Git commit you make to the Datadog Agent repositories.

ssh-keygen -t ed25519 -C "<EMAIL_ADDRESS>"

It should then ask you for the path in which to save the key. It's recommended to name the key dda and save it in the same directory as the default location.

Enter file in which to save the key (/root/.ssh/id_ed25519): /root/.ssh/dda

Finally, you will be asked to enter an optional passphrase.

Key awareness

Add the key from the previous step to your local SSH agent.

ssh-add /root/.ssh/dda

Running the following command should now display the key.

ssh-add -L

Follow GitHub's guide for adding the key to your GitHub account and test that it works. The path to the public key is the path to the key from the previous step with a .pub file extension e.g. /root/.ssh/dda.pub.

Next steps

Follow the developer environment tutorial to get started.