OS X

Basic Agent Usage for OS X

Overview

This page outlines the basic functionality of the Datadog Agent. If you haven’t installed the Agent yet, instructions can be found in the Datadog Agent integration page.

By default, your Agent is installed in its own sandbox located at /opt/datadog-agent. You’re free to move this folder wherever you like. However, we assume that the Agent is installed in its default location, so be sure to modify the instructions accordingly if you decide to move it to another location.

Commands

lifecycle commands (former datadog-agent start/stop/restart/status on the Agent 5) are replaced by launchctl commands on the com.datadoghq.agent service, and should be run under the logged-in user. For these commands, you can also use the Datadog Agent systray app, all the other commands can still be run with the datadog-agent command (located in the PATH (/usr/local/bin/) by default)

Configuration

The configuration files and folders for the Agent are located at:

Configuration files for integrations:

Troubleshooting

Run the info or status command to see the state of the Agent. The Agent logs are located in the /var/log/datadog/ directory:

• For Agent v6 all logs are in the agent.log file

• For Agent v5 logs are in:

  • datadog-supervisord.log
  • collector.log
  • dogstatsd.log
  • forwarder.log

If you’re still having trouble, our support team will be glad to provide further assistance.

Switch between Agent v5 and v6

Upgrade to Agent 6

You can either download the DMG package and install it manually, or use the one-line install script.

Manual installation

1. Download the DMG package of the latest Agent version, use the latest macOS release listed on the release page of the repository
2. Install the DMG package
3. Add your api key to /opt/datadog-agent/etc/datadog.yaml

Then start the Datadog Agent app (once started, you should see it in the system tray), and manage the Agent from there. The Agent6 also ships a web-based GUI to edit the Agent configuration files and much more, refer to the [changes and deprecations document][changes] document for more information.

Install script

To Upgrade

The Agent 6.x installer can automatically convert your 5.x style Agent configuration at upgrade:

  DD_UPGRADE=true bash -c "$(curl -L https://raw.githubusercontent.com/DataDog/datadog-agent/master/cmd/agent/install_mac_os.sh)"

To Install Fresh

In case you want to install on a clean box (or have an existing Agent 5 install from which you do not wish to import the configuration) you have to provide an api key:

 DD_API_KEY=YOUR_API_KEY bash -c "$(curl -L https://raw.githubusercontent.com/DataDog/datadog-agent/master/cmd/agent/install_mac_os.sh)"

Downgrade to Agent v5

1. Stop the Agent with the systray app, if it’s running
2. Exit the systray app
3. Uninstall the Datadog Agent application
4. Install the Agent 5 DMG package using your preferred installation method

Uninstall the Agent

Stop and Close the Datadog Agent: via the bone icon in the Tray.

Drag the Datadog Application from the application folder to the Trash Bin.

$ sudo rm -rf /opt/datadog-agent
$ sudo rm -rf /usr/local/bin/datadog-agent
$ sudo rm -rf ~/.datadog-agent/**​ #to remove broken symlinks

If you ran the optional install commands to have the Agent run at boot time, run the following to finish uninstalling:

$ sudo launchctl unload -w /Library/LaunchDaemons/com.datadoghq.agent.plist
$ sudo rm /Library/LaunchDaemons/com.datadoghq.agent.plist

Further Reading