Basic Agent Usage for Ubuntu
Overview
This page outlines the basic features of the Datadog Agent for Ubuntu.
To install the Agent, see the installation instructions. Packages are available for 64-bit x86 and Arm v8 architectures. For other architectures, use the source install.
Note: Ubuntu 14.04 and above are supported on the 64-bit x86 architecture. Ubuntu 16.04 and above are supported on the 64-bit Arm v8 architecture.
Commands
In Agent v6 and v7, the service manager provided by the operating system is responsible for the Agent lifecycle, while other commands must be run through the Agent binary directly. In Agent v5, almost everything is done through the service manager.
| Description | Command |
|---|
| Start Agent as a service | sudo service datadog-agent start |
| Stop Agent running as a service | sudo service datadog-agent stop |
| Restart Agent running as a service | sudo service datadog-agent restart |
| Status of Agent service | sudo service datadog-agent status |
| Status page of running Agent | sudo datadog-agent status |
| Send flare | sudo datadog-agent flare |
| Display command usage | sudo datadog-agent --help |
| Run a check | sudo -u dd-agent -- datadog-agent check <CHECK_NAME> |
| Description | Command |
|---|
| Start Agent as a service | sudo service datadog-agent start |
| Stop Agent running as a service | sudo service datadog-agent stop |
| Restart Agent running as a service | sudo service datadog-agent restart |
| Status of Agent service | sudo service datadog-agent status |
| Status page of running Agent | sudo service datadog-agent info |
| Send flare | sudo service datadog-agent flare |
| Display command usage | sudo service datadog-agent |
| Run a check | sudo -u dd-agent -- dd-agent check <CHECK_NAME> |
Note: If the service wrapper is not available on your system, use:
- On
upstart-based systems: sudo start/stop/restart/status datadog-agent - On
systemd-based systems: sudo systemctl start/stop/restart/status datadog-agent
Learn more about Service lifecycle commands
Configuration
The configuration files and folders for the Agent are located in:
/etc/datadog-agent/datadog.yaml
Configuration files for Integrations:
/etc/datadog-agent/conf.d/
The configuration files and folders for the Agent are located in:
/etc/dd-agent/datadog.conf
Configuration files for Integrations:
Uninstall the Agent
sudo apt-get remove datadog-agent -y
This command removes the Agent, but does not remove:
- The
datadog.yaml configuration file - User-created files in the
/etc/datadog-agent configuration folder - User-created files in the
/opt/datadog-agent folder - The
dd-agent user - Datadog log files
If you also want to remove these elements, run this command after removing the Agent:
sudo apt-get remove --purge datadog-agent -y
sudo apt-get remove datadog-agent -y
This command removes the Agent, but does not remove:
- The
datadog.yaml configuration file - User-created files in the
/etc/dd-agent configuration folder - User-created files in the
/opt/datadog-agent folder - The
dd-agent user - Datadog log files
If you also want to remove these elements, run this command after removing the Agent:
sudo apt-get --purge remove datadog-agent -y
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:
