Basic Agent Usage

To get started using the Agent, select your platform.

integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration
integration

Managing the Agent

You can manage your Agent installation using the Datadog Agent Manager GUI or from the command line.

Datadog Agent Manager GUI

The Agent GUI is not supported on 32-bit Windows platforms.

Use the Datadog Agent Manager GUI to:

  • View the status information for your Agent
  • View all running checks
  • View the Agent log
  • Edit the Agent configuration file (datadog.yaml)
  • Add or edit Agent checks
  • Send flares

The Datadog Agent Manager GUI is enabled by default on Windows and macOS, and runs on port 5002. Use the datadog-agent launch-gui command to open the GUI in your default web browser.

You can change the GUI’s default port in your datadog.yaml configuration file. To disable the GUI, set the port’s value to -1. On Linux, the GUI is disabled by default.

GUI requirements:

  • Cookies must be enabled in your browser. The GUI generates and saves a token in your browser, which is used for authenticating all communications with the GUI server.
  • To start the GUI, the user must have the required permissions. If you are able to open datadog.yaml, you are able to use the GUI.
  • For security reasons, the GUI can only be accessed from the local network interface (localhost/127.0.0.1), therefore you must be on the host where the Agent is running. You can’t run the Agent on a VM or a container and access it from the host machine.

Command-line interface

From Agent 6 and later, the Agent command-line interface is based on subcommands. For a full list of Agent subcommands, see Agent Commands.

Getting further with the Datadog Agent

Update the Agent

To manually update the Datadog Agent core between two minor versions on a given host, run the corresponding installation command for your platform.

Note: If you want to manually update one specific Agent integration, see the Integration Management guide.

Configuration files

See the Agent configuration files documentation.

Datadog site

Edit the Agent’s main configuration file, datadog.yaml, to set the site parameter (defaults to datadoghq.com).

site: 

Note: See the Getting Started with Datadog Sites documentation for further details on the site parameter.

Log location

See the Agent log files documentation.

Agent overhead

An example of the Datadog Agent resource consumption is below. Tests were made on an Amazon EC2 machine c5.xlarge instance (4 VCPU/ 8GB RAM) and comparable performance was seen for ARM64-based instances with similar resourcing. The vanilla datadog-agent was running with a process check to monitor the Agent itself. Enabling more integrations may increase Agent resource consumption. Enabling JMX Checks forces the Agent to use more memory depending on the number of beans exposed by the monitored JVMs. Enabling the trace and process Agents increases the resource consumption as well.

  • Agent Test version: 7.34.0
  • CPU: ~ 0.08% of the CPU used on average
  • Memory: ~ 130MB of RAM used (RSS memory)
  • Network bandwidth: ~ 140 B/s ▼ | 800 B/s ▲
  • Disk:
    • Linux 830MB to 880MB depending on the distribution
    • Windows: 870MB

Log Collection:

The results below are obtained from a collection of 110KB of logs per seconds from a file with the HTTP forwarder enabled. It shows the evolution of resource usage for the different compression levels available.

  • Agent Test version: 6.15.0
  • CPU: ~ 1.5% of the CPU used on average
  • Memory: ~ 95MB of RAM used.
  • Network bandwidth: ~ 14 KB/s ▲
  • Agent Test version: 6.15.0
  • CPU: ~ 1% of the CPU used on average
  • Memory: ~ 95MB of RAM used.
  • Network bandwidth: ~ 20 KB/s ▲
  • Agent Test version: 6.15.0
  • CPU: ~ 0.7% of the CPU used on average
  • Memory: ~ 90MB of RAM used (RSS memory)
  • Network bandwidth: ~ 200 KB/s ▲

Further Reading

PREVIEWING: rtrieu/product-analytics-ui-changes