{"id":33452,"date":"2026-06-23T02:18:09","date_gmt":"2026-06-23T02:18:09","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=33452"},"modified":"2026-06-23T02:18:13","modified_gmt":"2026-06-23T02:18:13","slug":"list-of-all-datadog-agent-commands-with-examples-and-explainations","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/list-of-all-datadog-agent-commands-with-examples-and-explainations\/","title":{"rendered":"Datadog Agent CLI \u2014 datadog-agent and Windows agent.exe with examples"},"content":{"rendered":"\n

This guide covers the Datadog Agent command-line interface<\/strong> for:<\/p>\n\n\n

Linux\/macOS<\/span>: datadog-agent\nWindows<\/span>:     agent.exe<\/code><\/span>Code language:<\/span> HTTP<\/span> (<\/span>http<\/span>)<\/span><\/small><\/pre>\n\n\n
The Datadog Agent CLI is subcommand-based<\/strong>. Datadog\u2019s current Agent command documentation says the general syntax is:<\/p>\n\n\n
<AGENT_BINARY<\/span>><\/span> <SUB_COMMAND<\/span>><\/span> <OPTIONS<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
and recommends using:<\/p>\n\n\n
<AGENT_BINARY<\/span>><\/span> --help\n<AGENT_BINARY<\/span>><\/span> <SUB_COMMAND<\/span>><\/span> --help<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
to see the exact options supported by your installed Agent version. This matters because a few flags can differ between Agent versions and platforms.<\/p>\n\n\n\n
\n\n\n\n
1. Quick answer: executable names<\/h1>\n\n\n\n
Platform<\/th>CLI executable<\/th>Typical command<\/th><\/tr><\/thead>
Linux<\/td>datadog-agent<\/code><\/td>sudo datadog-agent status<\/code><\/td><\/tr>
macOS<\/td>datadog-agent<\/code><\/td>datadog-agent status<\/code><\/td><\/tr>
Windows<\/td>agent.exe<\/code><\/td>agent.exe status<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
On Windows, Datadog documents that the main executable name is agent.exe<\/code><\/strong>, and commands should be run from an elevated PowerShell or Command Prompt using <PATH_TO_AGENT.EXE> <COMMAND><\/code>.<\/p>\n\n\n\n
\n\n\n\n
2. Common executable locations<\/h1>\n\n\n\n
Linux<\/h2>\n\n\n\n
Common command:<\/p>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
Common binary\/symlink locations:<\/p>\n\n\n
\/usr\/bin\/datadog-agent\n\/opt\/datadog-agent\/bin\/agent\/agent<\/code><\/span><\/pre>\n\n\n
Useful check:<\/p>\n\n\n
which datadog-agent<\/code><\/span><\/pre>\n\n\n
Linux Agent service commands are usually managed through systemctl<\/code>. Datadog\u2019s Linux documentation lists sudo systemctl start|stop|restart|status datadog-agent<\/code>, plus sudo datadog-agent status<\/code>, sudo datadog-agent flare<\/code>, and sudo datadog-agent --help<\/code>.<\/p>\n\n\n\n
\n\n\n\n
macOS<\/h2>\n\n\n\n
Common command:<\/p>\n\n\n
datadog-agent status<\/code><\/span><\/pre>\n\n\n
Common paths:<\/p>\n\n\n
\/usr\/local\/bin\/datadog-agent\n\/opt\/datadog-agent\/bin\/agent\/agent<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s macOS documentation says the Agent is installed under \/opt\/datadog-agent<\/code> by default, and lists commands such as datadog-agent status<\/code>, datadog-agent flare<\/code>, datadog-agent --help<\/code>, and datadog-agent check <CHECK_NAME><\/code>.<\/p>\n\n\n\n
\n\n\n\n
Windows<\/h2>\n\n\n\n
PowerShell:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Command Prompt:<\/p>\n\n\n
\"%ProgramFiles%\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Common path:<\/p>\n\n\n
C<\/span>:\\Program<\/span> Files<\/span>\\Datadog<\/span>\\Datadog<\/span> Agent<\/span>\\bin<\/span>\\agent<\/span>.exe<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Windows docs show the same path and examples for status<\/code>, launch-gui<\/code>, and flare<\/code>.<\/p>\n\n\n\n
\n\n\n\n
3. Configuration file locations<\/h1>\n\n\n\n
Before learning CLI commands, students should know where the Agent reads configuration from.<\/p>\n\n\n\n
Platform<\/th>Main config file<\/th><\/tr><\/thead>
Linux<\/td>\/etc\/datadog-agent\/datadog.yaml<\/code><\/td><\/tr>
macOS<\/td>~\/.datadog-agent\/datadog.yaml<\/code> in the generic config docs; macOS platform docs also describe \/opt\/datadog-agent<\/code> as the default install location<\/td><\/tr>
Windows<\/td>%ProgramData%\\Datadog\\datadog.yaml<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Integration configs live under conf.d<\/code>. For Linux this is \/etc\/datadog-agent\/conf.d\/<\/code>, and for Windows it is %ProgramData%\\Datadog\\conf.d<\/code>. Datadog also notes that each integration usually has a <CHECK_NAME>.d\/conf.yaml<\/code> file, and conf.yaml.example<\/code> can be renamed to conf.yaml<\/code> to enable that check.<\/p>\n\n\n\n
\n\n\n\n
4. Agent service control vs Agent CLI<\/h1>\n\n\n\n
Do not confuse these two:<\/p>\n\n\n\n
Service management<\/h2>\n\n\n\n
Used to start\/stop\/restart the Agent process.<\/p>\n\n\n\n
Examples:<\/p>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n
Restart-Service DatadogAgent<\/code><\/span><\/pre>\n\n\n
Agent CLI<\/h2>\n\n\n\n
Used to inspect, test, troubleshoot, diagnose, or collect support data.<\/p>\n\n\n\n
Examples:<\/p>\n\n\n
sudo datadog-agent status\nsudo datadog-agent configcheck\nsudo datadog-agent check apache\nsudo datadog-agent flare<\/code><\/span><\/pre>\n\n\n
Mental model:<\/p>\n\n\n
systemctl \/ launchctl \/ Windows Service Manager\n    = control the Agent service\n\ndatadog-agent \/ agent.exe\n    = ask the Agent questions or run diagnostics<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
5. Linux service commands<\/h1>\n\n\n\n
Start Agent<\/h2>\n\n\n
sudo systemctl start datadog-agent<\/code><\/span><\/pre>\n\n\n
Use when:<\/p>\n\n\n
Agent is installed but not running.<\/code><\/span><\/pre>\n\n\n
Stop Agent<\/h2>\n\n\n
sudo systemctl stop datadog-agent<\/code><\/span><\/pre>\n\n\n
Use when:<\/p>\n\n\n
You need to temporarily stop metric\/log\/trace collection.<\/code><\/span><\/pre>\n\n\n
Restart Agent<\/h2>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n\n
Use after editing:<\/p>\n\n\n
\/etc\/datadog-agent\/datadog.yaml\n\/etc\/datadog-agent\/conf.d\/<integration<\/span>><\/span>.d\/conf.yaml<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Check service status<\/h2>\n\n\n
sudo systemctl status datadog-agent<\/code><\/span><\/pre>\n\n\n
Use when:<\/p>\n\n\n
You want to confirm the Linux service is running.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Linux docs also note that older upstart-based systems such as CentOS\/RHEL 6 or SUSE 11 use older service-style commands instead of systemctl<\/code>.<\/p>\n\n\n\n
\n\n\n\n
6. macOS service commands<\/h1>\n\n\n\n
Start Agent<\/h2>\n\n\n
launchctl<\/span> start<\/span> com<\/span>.datadoghq<\/span>.agent<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Stop Agent<\/h2>\n\n\n
launchctl<\/span> stop<\/span> com<\/span>.datadoghq<\/span>.agent<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Restart Agent<\/h2>\n\n\n
launchctl<\/span> stop<\/span> com<\/span>.datadoghq<\/span>.agent<\/span>\nlaunchctl<\/span> start<\/span> com<\/span>.datadoghq<\/span>.agent<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Check service status<\/h2>\n\n\n
launchctl<\/span> list<\/span> com<\/span>.datadoghq<\/span>.agent<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s macOS docs list these launchctl<\/code> commands and also mention that the systray app can be used.<\/p>\n\n\n\n
\n\n\n\n
7. Windows service commands<\/h1>\n\n\n\n
Datadog\u2019s Windows docs say the Agent execution is controlled by the Windows Service Control Manager<\/strong>, and the service is named DatadogAgent<\/code>.<\/p>\n\n\n\n
PowerShell<\/h2>\n\n\n
Get-Service DatadogAgent\nStart-Service DatadogAgent\nStop-Service DatadogAgent\nRestart-Service DatadogAgent<\/code><\/span><\/pre>\n\n\n
Command Prompt<\/h2>\n\n\n
sc query DatadogAgent\nnet start DatadogAgent\nnet stop DatadogAgent<\/code><\/span><\/pre>\n\n\n
Datadog Agent CLI service commands<\/h2>\n\n\n\n
Datadog also documents Windows-only Agent CLI service commands:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> start-service\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> restart-service\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> stopservice<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Note the spelling:<\/p>\n\n\n
stopservice<\/code><\/span><\/pre>\n\n\n
not:<\/p>\n\n\n
stop-service<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Windows command list includes restart-service<\/code>, start-service<\/code>, and stopservice<\/code>.<\/p>\n\n\n\n
\n\n\n\n
8. Officially documented Agent CLI subcommands<\/h1>\n\n\n\n
Datadog\u2019s Agent Commands page lists these subcommands:<\/p>\n\n\n
check\nconfig\nconfigcheck\ndiagnose\nflare\nhealth\nhelp\nhostname\nimport<\/span>\njmx\nlaunch-gui\nrestart-service\nstart-service\nstream-logs\nstopservice\nversion<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows docs additionally list:<\/p>\n\n\n
run\nstart\nstatus<\/code><\/span><\/pre>\n\n\n
with start<\/code> marked as being deprecated but still accepted, and run<\/code> preferred.<\/p>\n\n\n\n
\n\n\n\n
9. CLI syntax by platform<\/h1>\n\n\n\n
Linux<\/h2>\n\n\n
sudo datadog-agent <subcommand<\/span>><\/span> [options]<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Example:<\/p>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
For checks, Datadog recommends running as the dd-agent<\/code> user:<\/p>\n\n\n
sudo -u dd-agent -- datadog-agent check <CHECK_NAME<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Agent check troubleshooting docs show sudo -u dd-agent datadog-agent check <CHECK_NAME><\/code> and mention --check-rate<\/code> when rate metrics should be included.<\/p>\n\n\n\n
\n\n\n\n
macOS<\/h2>\n\n\n
datadog-agent <subcommand<\/span>><\/span> [options]<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Example:<\/p>\n\n\n
datadog-agent status<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
Windows PowerShell<\/h2>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\" <command<\/span>><\/span> [options]<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Example:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Windows Command Prompt<\/h2>\n\n\n
\"%ProgramFiles<\/span>%\\Datadog<\/span>\\Datadog<\/span> Agent<\/span>\\bin<\/span>\\agent<\/span>.exe<\/span>\" <command<\/span>> [options]<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Example:<\/p>\n\n\n
\"%ProgramFiles%\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
10. status<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Shows the current status of the running Agent and enabled integrations.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You want to confirm the Agent is healthy.\nYou want to see which checks are running.\nYou want to see integration errors.\nYou want to verify logs\/APM\/process\/network components.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Agent Commands page says status<\/code> displays the status of the Datadog Agent and enabled integrations, and a properly configured integration appears under Running Checks<\/code> with no warnings or errors.<\/p>\n\n\n\n
\n\n\n\n
Linux<\/h2>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
macOS<\/h2>\n\n\n
datadog-agent status<\/code><\/span><\/pre>\n\n\n
Windows PowerShell<\/h2>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows Command Prompt<\/h2>\n\n\n
\"%ProgramFiles%\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Useful options<\/h2>\n\n\n\n
The current Agent source for status<\/code> documents these options:<\/p>\n\n\n\n
Option<\/th>Meaning<\/th><\/tr><\/thead>
status [section]<\/code><\/td>Show only a specific status section<\/td><\/tr>
--list<\/code>, -l<\/code><\/td>List available status sections<\/td><\/tr>
--json<\/code>, -j<\/code><\/td>Print raw JSON<\/td><\/tr>
--pretty-json<\/code>, -p<\/code><\/td>Pretty-print JSON<\/td><\/tr>
--file<\/code>, -o<\/code><\/td>Write status output to file<\/td><\/tr>
--verbose<\/code>, -v<\/code><\/td>Print verbose status<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
The source package implements status [section]<\/code>, says --list<\/code> lists available status sections, and defines flags such as --json<\/code>, --pretty-json<\/code>, --file<\/code>, --verbose<\/code>, and --list<\/code>.<\/p>\n\n\n\n
\n\n\n\n
Examples<\/h2>\n\n\n\n
Show full Agent status<\/h3>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
List status sections<\/h3>\n\n\n
sudo datadog-agent status --list<\/span><\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Show collector section only<\/h3>\n\n\n
sudo datadog-agent status collector<\/code><\/span><\/pre>\n\n\n
Save status to a file<\/h3>\n\n\n
sudo datadog-agent status --file \/tmp\/datadog-agent-status.txt<\/code><\/span><\/pre>\n\n\n
Output JSON<\/h3>\n\n\n
sudo datadog-agent status --json<\/code><\/span><\/pre>\n\n\n
Pretty JSON<\/h3>\n\n\n
sudo datadog-agent status --pretty-json<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
After enabling Apache integration:<\/p>\n\n\n
sudo systemctl restart datadog-agent\nsudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
Look for:<\/p>\n\n\n
Running Checks\n==============\napache<\/code><\/span><\/pre>\n\n\n
If the check appears under errors\/warnings, use:<\/p>\n\n\n
sudo datadog-agent check apache\nsudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
11. check<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Runs one Agent integration check manually.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You configured an integration and want to test it immediately.\nYou want to troubleshoot why a check is not collecting metrics.\nYou want to validate config before waiting for Agent collection interval.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s troubleshooting guide says to use datadog-agent check <CHECK_NAME><\/code> to get more troubleshooting information for an Agent check. It also says to replace <CHECK_NAME><\/code> with the check name, for example activemq<\/code>, ceph<\/code>, or elastic<\/code>.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo -u dd-agent -- datadog-agent check <CHECK_NAME<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent check <CHECK_NAME<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows PowerShell:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\" check <CHECK_NAME<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows Command Prompt:<\/p>\n\n\n
\"%ProgramFiles%\\Datadog\\Datadog Agent\\bin\\agent.exe\" check <CHECK_NAME<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Common option<\/h2>\n\n\n\n
Option<\/th>Purpose<\/th><\/tr><\/thead>
--check-rate<\/code><\/td>Include rate metrics in the check output<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Datadog documents --check-rate<\/code> as an option when rate metrics should be included.<\/p>\n\n\n\n
\n\n\n\n
Examples<\/h2>\n\n\n\n
Test Apache integration<\/h3>\n\n\n
sudo -u dd-agent -- datadog-agent check apache<\/code><\/span><\/pre>\n\n\n
Test systemd integration<\/h3>\n\n\n
sudo -u dd-agent -- datadog-agent check systemd<\/code><\/span><\/pre>\n\n\n
Test process integration<\/h3>\n\n\n
sudo -u dd-agent -- datadog-agent check process<\/code><\/span><\/pre>\n\n\n
Include rate metrics<\/h3>\n\n\n
sudo -u dd-agent -- datadog-agent check apache --check-rate<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
How to know the check name<\/h2>\n\n\n\n
The check name usually matches the integration folder:<\/p>\n\n\n
\/etc\/datadog-agent\/conf.d\/apache.d\/<\/code><\/span><\/pre>\n\n\n
So the check name is:<\/p>\n\n\n
apache<\/code><\/span><\/pre>\n\n\n
Example:<\/p>\n\n\n
sudo -u dd-agent -- datadog-agent check apache<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
You edited:<\/p>\n\n\n
\/etc\/datadog-agent\/conf.d\/apache.d\/conf.yaml<\/code><\/span><\/pre>\n\n\n
Then run:<\/p>\n\n\n
sudo -u dd-agent -- datadog-agent check apache<\/code><\/span><\/pre>\n\n\n
If successful, restart Agent:<\/p>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n\n
Then verify:<\/p>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
12. configcheck<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Prints the configurations loaded and resolved by the running Agent.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You want to confirm which integration config the Agent actually loaded.\nYou want to verify Autodiscovery config.\nYou want to troubleshoot wrong YAML, duplicate config, or<\/span> wrong file path.\nYou want to see final<\/span> resolved config after templates\/secrets\/env vars.<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Agent Commands page describes configcheck<\/code> as printing all loaded and resolved configurations of a running Agent.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
Windows PowerShell:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> configcheck<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Examples<\/h2>\n\n\n\n
Print all loaded configs<\/h3>\n\n\n
sudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
Search for Apache config<\/h3>\n\n\n
sudo datadog-agent configcheck | grep -A 30 apache<\/code><\/span><\/pre>\n\n\n
Save configcheck output<\/h3>\n\n\n
sudo datadog-agent configcheck > \/tmp\/<\/span>datadog-configcheck.txt<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
You added:<\/p>\n\n\n
\/etc\/datadog-agent\/conf.d\/apache.d\/conf.yaml<\/code><\/span><\/pre>\n\n\n
but Apache metrics do not appear. Run:<\/p>\n\n\n
sudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
If Apache is missing, the Agent did not load the config. Check:<\/p>\n\n\n
File<\/span> name<\/span>\nYAML<\/span> indentation<\/span>\nconf<\/span>.d<\/span> path<\/span>\nFile<\/span> permissions<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
13. diagnose<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Runs connectivity and system diagnostics.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
The Agent is installed but data is not reaching Datadog.\nYou suspect proxy, DNS, firewall, TLS, or endpoint connectivity issue.\nYou want a fast local diagnostic before opening a support case<\/span>.<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog lists diagnose<\/code> as the command that executes connectivity diagnosis on the system.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent diagnose<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent diagnose<\/code><\/span><\/pre>\n\n\n
Windows PowerShell:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> diagnose<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Examples<\/h2>\n\n\n\n
Run full diagnosis<\/h3>\n\n\n
sudo datadog-agent diagnose<\/code><\/span><\/pre>\n\n\n
Save output<\/h3>\n\n\n
sudo datadog-agent diagnose > \/tmp\/<\/span>datadog-diagnose.txt<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
If Agent status shows API connectivity errors:<\/p>\n\n\n
sudo datadog-agent status\nsudo datadog-agent diagnose<\/code><\/span><\/pre>\n\n\n
Check:<\/p>\n\n\n
DNS resolution\nProxy<\/span> settings\nTLS errors\nDatadog intake reachability\nSite setting<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
14. flare<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Collects logs, configuration, status, and diagnostic data into a support bundle and can send it to Datadog Support.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
Datadog Support asks for a flare.\nYou need to collect local Agent troubleshooting data.\nYou have persistent Agent issues.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s flare docs say the flare<\/code> command collects data, can use a support case ID, and asks for the email address associated with the case.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent flare<\/code><\/span><\/pre>\n\n\n
With support case ID:<\/p>\n\n\n
sudo datadog-agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent flare\ndatadog-agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows PowerShell:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> flare\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> flare <CASE_ID><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Kubernetes examples<\/h2>\n\n\n\n
Basic Agent pod:<\/p>\n\n\n
kubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -- agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Agent container in multi-container pod:<\/p>\n\n\n
kubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c agent -- agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Process Agent container:<\/p>\n\n\n
kubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c process-agent -- agent flare <CASE_ID<\/span>><\/span> --local<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Trace Agent container:<\/p>\n\n\n
kubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c trace-agent -- agent flare <CASE_ID<\/span>><\/span> --local<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog documents these dedicated-container flare commands and notes that system-probe cannot send a flare, so container logs should be collected instead.<\/p>\n\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
Support asks:<\/p>\n\n\n
Please send an Agent flare for<\/span> case<\/span> 123456.<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Run:<\/p>\n\n\n
sudo datadog-agent flare 123456<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
15. health<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Prints the current Agent health.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You want a quick health check.\nYou want automation to check whether the Agent internals are healthy.\nYou do<\/span> not need the full status output.<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Agent command list describes health<\/code> as printing the current Agent health.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent health<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent health<\/code><\/span><\/pre>\n\n\n
Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> health<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
Use this in a troubleshooting script:<\/p>\n\n\n
sudo datadog-agent health || echo<\/span> \"Agent health check failed\"<\/span><\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
16. hostname<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Prints the hostname used by the Agent.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
Host is missing in Datadog.\nDuplicate hosts appear.\nWrong hostname appears in dashboards.\nYou want to confirm what hostname the Agent reports.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Agent Commands page describes hostname<\/code> as printing the hostname used by the Agent.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent hostname<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent hostname<\/code><\/span><\/pre>\n\n\n
Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> hostname<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
Your Datadog UI shows host:<\/p>\n\n\n
ip-10-0-1-25<\/code><\/span><\/pre>\n\n\n
but you expected:<\/p>\n\n\n
web-prod-01<\/code><\/span><\/pre>\n\n\n
Check locally:<\/p>\n\n\n
sudo datadog-agent hostname<\/code><\/span><\/pre>\n\n\n
Then review:<\/p>\n\n\n
hostname:<\/code><\/span><\/pre>\n\n\n
inside:<\/p>\n\n\n
\/etc\/datadog-agent\/datadog.yaml<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
17. version<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Prints Datadog Agent version information.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You need to confirm Agent version.\nYou are checking compatibility.\nYou are troubleshooting support issues.\nYou want to verify upgrade success.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Agent Commands page lists version<\/code> as printing version information.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
datadog-agent version<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent version<\/code><\/span><\/pre>\n\n\n
Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> version<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
Before and after upgrade:<\/p>\n\n\n
datadog-agent version\nsudo apt-get<\/span> install datadog-agent\ndatadog-agent version<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
18. config<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Runtime configuration management.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You<\/span> want<\/span> to<\/span> inspect<\/span> runtime-configurable<\/span> Agent<\/span> settings<\/span>.\nYou<\/span> want<\/span> to<\/span> temporarily<\/span> change<\/span> a<\/span> runtime<\/span> setting<\/span>.\nYou<\/span> want<\/span> to<\/span> adjust<\/span> log<\/span> level<\/span> without<\/span> permanently<\/span> editing<\/span> datadog<\/span>.yaml<\/span>.<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Agent command list describes config<\/code> as runtime configuration management.<\/p>\n\n\n\n
\n\n\n\n
Common examples<\/h2>\n\n\n\n
List runtime-configurable settings<\/h3>\n\n\n
sudo datadog-agent config list<\/span>-runtime<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Get current log level<\/h3>\n\n\n
sudo datadog-agent config get<\/span> log_level<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Temporarily set debug logging<\/h3>\n\n\n
sudo datadog-agent config set<\/span> log_level debug<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Restore normal logging<\/h3>\n\n\n
sudo datadog-agent config set<\/span> log_level info<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Important warning<\/h2>\n\n\n\n
Runtime config changes are generally for troubleshooting and may not persist forever like editing datadog.yaml<\/code>.<\/p>\n\n\n\n
For permanent config, edit:<\/p>\n\n\n
\/etc\/datadog-agent\/datadog.yaml<\/code><\/span><\/pre>\n\n\n
then restart:<\/p>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
19. stream-logs<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Streams logs being processed by a running Agent.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You enabled log collection but logs are not visible in Datadog.\nYou want to verify the Agent is tailing a file.\nYou want to inspect logs before they are sent upstream.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Agent command list describes stream-logs<\/code> as streaming logs being processed by a running Agent.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo datadog-agent stream-logs<\/code><\/span><\/pre>\n\n\n
macOS:<\/p>\n\n\n
datadog-agent stream-logs<\/code><\/span><\/pre>\n\n\n
Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> stream-logs<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
You configured Apache log collection:<\/p>\n\n\n
logs:\n  - type: file\n    path<\/span>: \/var\/<\/span>log\/apache2\/access.log\n    service<\/span>: apache\n    source<\/span>: apache<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Then run:<\/p>\n\n\n
sudo systemctl restart datadog-agent\nsudo datadog-agent stream-logs<\/code><\/span><\/pre>\n\n\n
Generate test traffic:<\/p>\n\n\n
curl http:\/\/localhost\/<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
If logs stream locally but do not appear in Datadog, suspect:<\/p>\n\n\n
Datadog intake connectivity\nwrong site\nindex\/exclusion filter\nlogs pipeline issue<\/code><\/span><\/pre>\n\n\n
If logs do not stream locally, suspect:<\/p>\n\n\n
wrong file path\nfile permissions\nlogs_enabled not true<\/span>\nbad conf.yaml\nAgent not restarted<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
20. launch-gui<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Starts the Datadog Agent GUI \/ Agent Manager.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You are on Windows or macOS and want GUI-based Agent inspection.\nYou want to view status, configure checks, or inspect Agent state.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s Windows docs describe the configuration GUI as a browser-based configuration application and show launch-gui<\/code> examples.<\/p>\n\n\n\n
\n\n\n\n
Windows PowerShell<\/h2>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> launch-gui<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows Command Prompt<\/h2>\n\n\n
\"%ProgramFiles%\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> launch-gui<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
macOS<\/h2>\n\n\n
datadog-agent launch-gui<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
21. jmx<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
JMX troubleshooting.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You monitor Java applications.\nYou configured JMX-based integrations.\nYou need to troubleshoot JMX bean\/metric collection.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s command list describes jmx<\/code> as JMX troubleshooting.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n
sudo datadog-agent jmx --help<\/code><\/span><\/pre>\n\n\n
Then run the specific subcommand shown by your Agent version.<\/p>\n\n\n\n
\n\n\n\n
Practical use case<\/h2>\n\n\n\n
For Kafka, Cassandra, Tomcat, ActiveMQ, or JVM-based apps:<\/p>\n\n\n
sudo datadog-agent jmx --help\nsudo datadog-agent check kafka<\/code><\/span><\/pre>\n\n\n
Use JMX troubleshooting when:<\/p>\n\n\n
JMX port is wrong.\nAuthentication is wrong.\nBean patterns are wrong.\nMetrics are missing.<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
22. import<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Imports and converts configuration files from previous Agent versions.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You are migrating older Datadog Agent configuration.\nYou need to convert legacy Agent config into newer format.<\/code><\/span><\/pre>\n\n\n
Datadog\u2019s command list describes import<\/code> as importing and converting configuration files from previous versions of the Agent.<\/p>\n\n\n\n
\n\n\n\n
Syntax<\/h2>\n\n\n
datadog-agent import<\/span> --help<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Use this only during migration scenarios. For normal Agent usage, students usually do not need it.<\/p>\n\n\n\n
\n\n\n\n
23. help<\/code><\/h1>\n\n\n\n
Purpose<\/h2>\n\n\n\n
Shows help.<\/p>\n\n\n\n
Use this when:<\/p>\n\n\n
You want to see supported commands.\nYou want exact flags for your installed Agent version.<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
Examples<\/h2>\n\n\n\n
Show global help<\/h3>\n\n\n
datadog-agent --help<\/code><\/span><\/pre>\n\n\n
Show check help<\/h3>\n\n\n
datadog-agent check --help<\/code><\/span><\/pre>\n\n\n
Show status help<\/h3>\n\n\n
datadog-agent status --help<\/code><\/span><\/pre>\n\n\n
Windows<\/h3>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> --help\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> check --help<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog explicitly recommends <AGENT_BINARY> --help<\/code> to see available subcommands and <AGENT_BINARY> check --help<\/code> to inspect the options for a specific subcommand.<\/p>\n\n\n\n
\n\n\n\n
24. Windows-only commands<\/h1>\n\n\n\n
Datadog\u2019s Windows command table lists these Windows service-related commands.<\/p>\n\n\n\n
start-service<\/code><\/h2>\n\n\n\n
Starts the Agent service through Windows Service Control Manager.<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> start-service<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Use when:<\/p>\n\n\n
DatadogAgent service is stopped.<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
restart-service<\/code><\/h2>\n\n\n\n
Restarts the Agent service through Windows Service Control Manager.<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> restart-service<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Use after editing:<\/p>\n\n\n
C<\/span>:\\ProgramData<\/span>\\Datadog<\/span>\\datadog<\/span>.yaml<\/span>\nC<\/span>:\\ProgramData<\/span>\\Datadog<\/span>\\conf<\/span>.d<\/span>\\<integration<\/span>>.d<\/span>\\conf<\/span>.yaml<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
stopservice<\/code><\/h2>\n\n\n\n
Stops the Agent service through Windows Service Control Manager.<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> stopservice<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Use when:<\/p>\n\n\n
You need to stop the Agent temporarily.<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
run<\/code><\/h2>\n\n\n\n
Starts the Agent.<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> run<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Use mostly for manual foreground execution or troubleshooting, not typical production service control.<\/p>\n\n\n\n
\n\n\n\n
start<\/code><\/h2>\n\n\n\n
Being deprecated, but accepted. Use run<\/code> instead.<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> start<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Datadog\u2019s Windows docs say start<\/code> is being deprecated but accepted, and run<\/code> should be used as an alternative.<\/p>\n\n\n\n
\n\n\n\n
25. Debug mode workflow<\/h1>\n\n\n\n
For troubleshooting, a common workflow is:<\/p>\n\n\n
sudo datadog-agent config set<\/span> log_level debug\nsudo systemctl restart datadog-agent\nsudo datadog-agent status\nsudo datadog-agent flare\nsudo datadog-agent config set<\/span> log_level info\nsudo systemctl restart datadog-agent<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
But be careful: debug logs can be noisy.<\/p>\n\n\n\n
Use debug mode when:<\/p>\n\n\n
Agent is not collecting expected data.\nDatadog Support asks for debug-level logs.\nYou need deeper troubleshooting temporarily.<\/code><\/span><\/pre>\n\n\n
Do not leave debug mode enabled in production longer than needed.<\/p>\n\n\n\n
\n\n\n\n
26. Logs location<\/h1>\n\n\n\n
Linux<\/h2>\n\n\n\n
Common Agent log directory:<\/p>\n\n\n
\/var<\/span>\/log\/datadog\/<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Common log file:<\/p>\n\n\n
\/var<\/span>\/log\/datadog\/agent.log<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows<\/h2>\n\n\n\n
Datadog\u2019s Windows docs state Agent logs are located at:<\/p>\n\n\n
C<\/span>:\\ProgramData<\/span>\\Datadog<\/span>\\logs<\/span>\\agent<\/span>.log<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
and note that ProgramData<\/code> is hidden.<\/p>\n\n\n\n
macOS<\/h2>\n\n\n\n
Common log directory:<\/p>\n\n\n
\/var<\/span>\/log\/datadog\/<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
27. Practical lab: troubleshoot an Apache integration<\/h1>\n\n\n\n
Scenario<\/h2>\n\n\n\n
Apache metrics\/logs are not visible in Datadog.<\/p>\n\n\n\n
Step 1: Check Agent service<\/h2>\n\n\n\n
Linux:<\/p>\n\n\n
sudo systemctl status datadog-agent<\/code><\/span><\/pre>\n\n\n
Step 2: Check Agent status<\/h2>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
Look for:<\/p>\n\n\n
Running Checks\napache<\/code><\/span><\/pre>\n\n\n
Step 3: Check loaded configuration<\/h2>\n\n\n
sudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
Search for Apache:<\/p>\n\n\n
sudo datadog-agent configcheck | grep -A 40 apache<\/code><\/span><\/pre>\n\n\n
Step 4: Run Apache check manually<\/h2>\n\n\n
sudo -u dd-agent -- datadog-agent check apache<\/code><\/span><\/pre>\n\n\n
Step 5: Stream logs locally<\/h2>\n\n\n
sudo datadog-agent stream-logs<\/code><\/span><\/pre>\n\n\n
Generate traffic:<\/p>\n\n\n
curl http:\/\/localhost\/<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Step 6: Run diagnosis<\/h2>\n\n\n
sudo datadog-agent diagnose<\/code><\/span><\/pre>\n\n\n
Step 7: Send flare if needed<\/h2>\n\n\n
sudo datadog-agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
28. Practical lab: troubleshoot wrong hostname<\/h1>\n\n\n\n
Scenario<\/h2>\n\n\n\n
Datadog UI shows duplicate or unexpected hostnames.<\/p>\n\n\n\n
Commands<\/h2>\n\n\n
sudo datadog-agent hostname\nsudo datadog-agent status\nsudo datadog-agent configcheck<\/code><\/span><\/pre>\n\n\n
Check config:<\/p>\n\n\n
sudo grep -n \"hostname\"<\/span> \/etc\/datadog-agent\/datadog.yaml<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Fix if needed:<\/p>\n\n\n
hostname<\/span>: web-prod-01<\/code><\/span>Code language:<\/span> HTTP<\/span> (<\/span>http<\/span>)<\/span><\/small><\/pre>\n\n\n
Restart:<\/p>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n\n
Validate:<\/p>\n\n\n
sudo datadog-agent hostname<\/code><\/span><\/pre>\n\n\n
\n\n\n\n
29. Practical lab: troubleshoot logs not appearing<\/h1>\n\n\n\n
Scenario<\/h2>\n\n\n\n
Linux\/Apache logs are configured but not visible in Datadog.<\/p>\n\n\n\n
Step 1: Confirm log collection enabled<\/h2>\n\n\n
sudo grep -n \"logs_enabled\"<\/span> \/etc\/datadog-agent\/datadog.yaml<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Expected:<\/p>\n\n\n
logs_enabled: true<\/span><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Step 2: Check integration log config<\/h2>\n\n\n
sudo cat \/etc\/datadog-agent\/conf.d\/apache.d\/conf.yaml<\/code><\/span><\/pre>\n\n\n
Example:<\/p>\n\n\n
logs:\n  - type: file\n    path<\/span>: \/var\/<\/span>log\/apache2\/access.log\n    source<\/span>: apache\n    service<\/span>: apache<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Step 3: Restart Agent<\/h2>\n\n\n
sudo systemctl restart datadog-agent<\/code><\/span><\/pre>\n\n\n
Step 4: Stream logs<\/h2>\n\n\n
sudo datadog-agent stream-logs<\/code><\/span><\/pre>\n\n\n
Step 5: Check Agent status<\/h2>\n\n\n
sudo datadog-agent status<\/code><\/span><\/pre>\n\n\n
Look for log collection sections.<\/p>\n\n\n\n
\n\n\n\n
30. Practical lab: collect support data<\/h1>\n\n\n\n
Scenario<\/h2>\n\n\n\n
You cannot solve the issue and need Datadog Support.<\/p>\n\n\n\n
Commands<\/h2>\n\n\n
sudo datadog-agent status > \/tmp\/<\/span>dd-status.txt\nsudo datadog-agent configcheck > \/tmp\/<\/span>dd-configcheck.txt\nsudo datadog-agent diagnose > \/tmp\/<\/span>dd-diagnose.txt\nsudo datadog-agent flare <CASE_ID><\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
If Kubernetes:<\/p>\n\n\n
kubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c agent -- agent status\nkubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c agent -- agent configcheck\nkubectl exec -it <AGENT_POD_NAME<\/span>><\/span> -c agent -- agent flare <CASE_ID<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
31. Complete CLI command reference table<\/h1>\n\n\n\n
Command<\/th>Linux\/macOS example<\/th>Windows example<\/th>Use case<\/th><\/tr><\/thead>
status<\/code><\/td>sudo datadog-agent status<\/code><\/td>agent.exe status<\/code><\/td>Show Agent\/integration status<\/td><\/tr>
status --list<\/code><\/td>sudo datadog-agent status --list<\/code><\/td>agent.exe status --list<\/code><\/td>List status sections<\/td><\/tr>
status collector<\/code><\/td>sudo datadog-agent status collector<\/code><\/td>agent.exe status collector<\/code><\/td>Show one status section<\/td><\/tr>
check<\/code><\/td>sudo -u dd-agent -- datadog-agent check apache<\/code><\/td>agent.exe check apache<\/code><\/td>Run one integration check<\/td><\/tr>
check --check-rate<\/code><\/td>datadog-agent check apache --check-rate<\/code><\/td>agent.exe check apache --check-rate<\/code><\/td>Include rate metrics<\/td><\/tr>
configcheck<\/code><\/td>sudo datadog-agent configcheck<\/code><\/td>agent.exe configcheck<\/code><\/td>Show resolved configs<\/td><\/tr>
diagnose<\/code><\/td>sudo datadog-agent diagnose<\/code><\/td>agent.exe diagnose<\/code><\/td>Connectivity\/system diagnostics<\/td><\/tr>
flare<\/code><\/td>sudo datadog-agent flare<\/code><\/td>agent.exe flare<\/code><\/td>Support bundle<\/td><\/tr>
health<\/code><\/td>sudo datadog-agent health<\/code><\/td>agent.exe health<\/code><\/td>Quick Agent health<\/td><\/tr>
hostname<\/code><\/td>sudo datadog-agent hostname<\/code><\/td>agent.exe hostname<\/code><\/td>Show reported hostname<\/td><\/tr>
version<\/code><\/td>datadog-agent version<\/code><\/td>agent.exe version<\/code><\/td>Show Agent version<\/td><\/tr>
config<\/code><\/td>datadog-agent config list-runtime<\/code><\/td>agent.exe config list-runtime<\/code><\/td>Runtime config management<\/td><\/tr>
stream-logs<\/code><\/td>sudo datadog-agent stream-logs<\/code><\/td>agent.exe stream-logs<\/code><\/td>View logs processed by Agent<\/td><\/tr>
launch-gui<\/code><\/td>datadog-agent launch-gui<\/code><\/td>agent.exe launch-gui<\/code><\/td>Open GUI\/Agent Manager<\/td><\/tr>
jmx<\/code><\/td>datadog-agent jmx --help<\/code><\/td>agent.exe jmx --help<\/code><\/td>JMX troubleshooting<\/td><\/tr>
import<\/code><\/td>datadog-agent import --help<\/code><\/td>agent.exe import --help<\/code><\/td>Legacy config migration<\/td><\/tr>
help<\/code><\/td>datadog-agent --help<\/code><\/td>agent.exe --help<\/code><\/td>CLI help<\/td><\/tr>
start-service<\/code><\/td>Windows only<\/td>agent.exe start-service<\/code><\/td>Start Windows service<\/td><\/tr>
restart-service<\/code><\/td>Windows only<\/td>agent.exe restart-service<\/code><\/td>Restart Windows service<\/td><\/tr>
stopservice<\/code><\/td>Windows only<\/td>agent.exe stopservice<\/code><\/td>Stop Windows service<\/td><\/tr>
run<\/code><\/td>Mainly Windows documented<\/td>agent.exe run<\/code><\/td>Run\/start Agent<\/td><\/tr>
start<\/code><\/td>Deprecated Windows alias<\/td>agent.exe start<\/code><\/td>Deprecated; use run<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
32. Student cheat sheet<\/h1>\n\n\n\n
Linux<\/h2>\n\n\n
sudo systemctl status datadog-agent\nsudo systemctl restart datadog-agent\n\nsudo datadog-agent status\nsudo datadog-agent configcheck\nsudo -u dd-agent -- datadog-agent check <CHECK_NAME<\/span>><\/span>\nsudo datadog-agent diagnose\nsudo datadog-agent flare\nsudo datadog-agent health\nsudo datadog-agent hostname\ndatadog-agent version<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
macOS<\/h2>\n\n\n
launchctl<\/span> list<\/span> com<\/span>.datadoghq<\/span>.agent<\/span>\nlaunchctl<\/span> stop<\/span> com<\/span>.datadoghq<\/span>.agent<\/span>\nlaunchctl<\/span> start<\/span> com<\/span>.datadoghq<\/span>.agent<\/span>\n\ndatadog-agent<\/span> status<\/span>\ndatadog-agent<\/span> configcheck<\/span>\ndatadog-agent<\/span> check<\/span> <CHECK_NAME<\/span>>\ndatadog-agent<\/span> diagnose<\/span>\ndatadog-agent<\/span> flare<\/span>\ndatadog-agent<\/span> health<\/span>\ndatadog-agent<\/span> hostname<\/span>\ndatadog-agent<\/span> version<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Windows PowerShell<\/h2>\n\n\n
$Agent = \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span>\n\n& $Agent status\n& $Agent configcheck\n& $Agent check <CHECK_NAME>\n& $Agent diagnose\n& $Agent flare\n& $Agent health\n& $Agent hostname\n& $Agent version\n& $Agent launch-gui\n& $Agent restart-service<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
33. Best command order for troubleshooting<\/h1>\n\n\n\n
Use this order. It saves a lot of time.<\/p>\n\n\n
1. Is the service running?\n2. What does Agent status show?\n3. Is my config loaded?\n4. Does the check work manually?\n5. Are logs being processed?\n6. Can the Agent reach Datadog?\n7. What hostname is being reported?\n8. Collect flare if still unresolved.<\/code><\/span><\/pre>\n\n\n
Linux command flow:<\/p>\n\n\n
sudo systemctl status datadog-agent\nsudo datadog-agent status\nsudo datadog-agent configcheck\nsudo -u dd-agent -- datadog-agent check <CHECK_NAME<\/span>><\/span>\nsudo datadog-agent stream-logs\nsudo datadog-agent diagnose\nsudo datadog-agent hostname\nsudo datadog-agent flare<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
34. Important note about \u201call options\u201d<\/h1>\n\n\n\n
Datadog\u2019s official docs intentionally point users to:<\/p>\n\n\n
datadog-agent --help\ndatadog-agent <subcommand<\/span>><\/span> --help<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
because the exact flags can vary by:<\/p>\n\n\n
Agent version\nOperating system\nAgent 6 vs Agent 7\npackage type\ncontainer vs host install\nenabled components\nexperimental features<\/code><\/span><\/pre>\n\n\n
So the safest teaching rule for students is:<\/p>\n\n\n
datadog-agent --help\ndatadog-agent status --help\ndatadog-agent check --help\ndatadog-agent flare --help\ndatadog-agent config --help<\/code><\/span><\/pre>\n\n\n
Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> --help\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status --help\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> check --help<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
That is not a workaround; it is the officially recommended way to inspect version-specific CLI options.<\/p>\n\n\n\n
\n\n\n\n
35. Final mental model<\/h1>\n\n\n\n
Remember this:<\/p>\n\n\n
status       = What is the Agent doing?\nconfigcheck  = What config did the Agent load?\ncheck        = Can this<\/span> integration run successfully?\ndiagnose     = Can the Agent connect properly?\nflare        = Collect support bundle.\nhealth       = Is the Agent internally healthy?\nhostname     = What host identity is Datadog using?\nstream-logs  = Are logs being processed locally?\nversion      = What Agent version is installed?\nconfig       = Runtime config management.<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
For day-to-day DevOps work, the most important commands are:<\/p>\n\n\n
sudo datadog-agent status\nsudo datadog-agent configcheck\nsudo -u dd-agent -- datadog-agent check <CHECK_NAME<\/span>><\/span>\nsudo datadog-agent diagnose\nsudo datadog-agent flare<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
For Windows:<\/p>\n\n\n
& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> status\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> configcheck\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> check <CHECK_NAME>\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> diagnose\n& \"$env:ProgramFiles\\Datadog\\Datadog Agent\\bin\\agent.exe\"<\/span> flare<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
This is the practical CLI toolkit every Datadog student\/admin should know.<\/p>\n\n\n\n
\n\n\n\n
old content<\/h4>\n\n\n\n
<\/p>\n\n\n\n
Commands<\/th>Descriptions<\/th><\/tr><\/thead>
datadog-agent check           <\/td>Run the specified check<\/td><\/tr>
datadog-agent completion    <\/td>Generate the autocompletion script for the specified shell<\/td><\/tr>
datadog-agent config    <\/td>Print the runtime configuration of a running agent<\/td><\/tr>
datadog-agent configcheck  <\/td>Print all configurations loaded & resolved of a running agent<\/td><\/tr>
datadog-agent diagnose    <\/td> Check availability of cloud provider and container metadata endpoints<\/td><\/tr>
datadog-agent dogstatsd-capture<\/td>Start a dogstatsd UDS traffic capture<\/td><\/tr>
datadog-agent dogstatsd-replay<\/td>Replay dogstatsd traffic<\/td><\/tr>
datadog-agent dogstatsd-stats<\/td>Print basic statistics on the metrics processed by dogstatsd<\/td><\/tr>
datadog-agent flare         <\/td>Collect a flare and send it to Datadog<\/td><\/tr>
datadog-agent health           <\/td>Print the current agent health<\/td><\/tr>
datadog-agent help           <\/td>Help about any command<\/td><\/tr>
datadog-agent hostname        <\/td>Print the hostname used by the Agent<\/td><\/tr>
datadog-agent import           <\/td>Import and convert configuration files from previous versions of the Agent<\/td><\/tr>
datadog-agent integration    <\/td>Datadog integration manager<\/td><\/tr>
datadog-agent jmx            <\/td>Run troubleshooting commands on JMXFetch integrations<\/td><\/tr>
datadog-agent launch-gui     <\/td>starts the Datadog Agent GUI<\/td><\/tr>
datadog-agent run          <\/td>Run the Agent<\/td><\/tr>
datadog-agent secret       <\/td>Print information about decrypted secrets in configuration.<\/td><\/tr>
datadog-agent secret-helper   <\/td>Secret management provider helper<\/td><\/tr>
datadog-agent snmp        <\/td>Snmp tools<\/td><\/tr>
datadog-agent status      <\/td>Print the current status<\/td><\/tr>
datadog-agent stop             <\/td>Stops a running Agent<\/td><\/tr>
datadog-agent stream-logs    <\/td> Stream the logs being processed by a running agent<\/td><\/tr>
datadog-agent tagger-list     <\/td> Print the tagger content of a running agent<\/td><\/tr>
datadog-agent version <\/td> Print the version info<\/td><\/tr>
  workload-list <\/td>Print the workload content of a running agent<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
datadog-agent check     <\/h2>\n\n\n\n
\n\n\n\n
A Datadog Agent check is a plugin that collects data from a specific source and sends it to the Datadog Agent. These checks can be customized and configured to monitor various metrics and events related to your infrastructure and applications.<\/p>\n\n\n\n
\n\n\n\n