Basic Agent Usage for macOS
Overview
This page outlines the basic features of the Datadog Agent for macOS. If you haven’t installed the Agent yet, instructions can be found in the Datadog Agent Integration documentation.
By default, the Agent is installed in a sandbox located at /opt/datadog-agent. You can move this folder anywhere; however, this documentation assumes a default installation location.
Supported macOS versions
| macOS version | Supported Agent versions |
|---|
| macOS 10.10 & 10.11 | Agent v5 |
| macOS 10.12 | Agent v5, Agent v6 until v6.34.0, Agent v7 until v7.34.0 |
| macOS 10.13 | Agent v5, Agent v6 until v6.38.2, Agent v7 until v7.38.2 |
| macOS 10.14+ | Agent v5, Agent v6, Agent v7 |
Commands
In Agent v6 and v7, the launchctl service manager provided by the operating system is responsible for the Agent lifecycle, while other commands must be run through the Agent binary directly. Alternatively, lifecycle commands can also be managed through the systray app, and other commands can be executed with the web GUI.
| Description | Command |
|---|
| Start Agent as a service | launchctl start com.datadoghq.agent or systray app |
| Stop Agent running as a service | launchctl stop com.datadoghq.agent or systray app |
| Restart Agent running as a service | run stop then start or systray app |
| Status of Agent service | launchctl list com.datadoghq.agent or systray app |
| Status page of running Agent | datadog-agent status or web GUI |
| Send flare | datadog-agent flare or web GUI |
| Display command usage | datadog-agent --help |
| Run a check | datadog-agent check <CHECK_NAME> |
| Description | Command |
|---|
| Start Agent as a service | datadog-agent start |
| Stop Agent running as a service | datadog-agent stop |
| Restart Agent running as a service | datadog-agent restart |
| Status of Agent service | datadog-agent status |
| Status page of running Agent | datadog-agent info |
| Send flare | datadog-agent flare |
| Display command usage | not implemented |
| Run a check | datadog-agent check <CHECK_NAME> |
Configuration
The configuration files and folders for the Agent are located in:
~/.datadog-agent/datadog.yaml
Configuration files for Integrations:
The configuration files and folders for the Agent are located in:
~/.datadog-agent/datadog.conf
Configuration files for Integrations:
Uninstall the Agent
Single user installation
To remove the Agent and all Agent configuration files:
- Stop and close the Datadog Agent with the bone icon in the tray.
- Drag the Datadog application from the application folder to the trash bin.
- Run the following commands:
sudo rm -rf /opt/datadog-agent
sudo rm -rf /usr/local/bin/datadog-agent
sudo rm -rf ~/.datadog-agent/** # to remove broken symlinks
launchctl remove com.datadoghq.agent
sudo rm -rf /var/log/datadog
- Reboot your machine for the changes to take effect.
System-wide LaunchDaemon installation
To remove the Agent and all Agent configuration files:
- Drag the Datadog application from the application folder to the trash bin.
- To remove remaining files, run the following:
sudo rm -rf /opt/datadog-agent
sudo rm -rf /usr/local/bin/datadog-agent
sudo rm -rf ~/.datadog-agent/** # to remove broken symlinks
sudo launchctl disable system/com.datadoghq.agent && sudo launchctl bootout system/com.datadoghq.agent
sudo rm /Library/LaunchDaemons/com.datadoghq.agent.plist
sudo rm -rf /var/log/datadog
- Reboot your machine for the changes to take effect.
- Stop and close the Datadog Agent with the bone icon in the tray.
- Drag the Datadog application from the application folder to the trash bin.
- Run:
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
This method removes the Agent, as well as all Agent configuration files.
Troubleshooting
See the Agent Troubleshooting documentation.
Working with the embedded Agent
The Agent contains an embedded Python environment at /opt/datadog-agent/embedded/. Common binaries such as python and pip are contained within /opt/datadog-agent/embedded/bin/.
See the instructions on how to add packages to the embedded Agent for more information.
Further Reading
Additional helpful documentation, links, and articles:
