AGENT - GSWTA #32705
Open
AGENT - GSWTA #32705
+90
−107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Preview links (active after the
|
joepeeples
reviewed
Nov 13, 2025
Contributor
joepeeples
left a comment
joepeeples
left a comment
There was a problem hiding this comment.
Looks good, added some editorial suggestions and tweaks. Let me know when you're ready for another round and approval, thanks!
Comment on lines
+20
to
+24
| - [Introduction to the Agent](#the-datadog-agent) | ||
| - [Installing the Agent](#installing-the-agent) | ||
| - [Data collected by the Agent](#data-collected-by-the-agent) | ||
| - [Advanced configurations and features](#advanced-configurations-and-features) | ||
| - [Troubleshooting the Agent](#troubleshooting) |
Contributor
There was a problem hiding this comment.
To reduce repetition of "the Agent":
Suggested change
| - [Introduction to the Agent](#the-datadog-agent) | |
| - [Installing the Agent](#installing-the-agent) | |
| - [Data collected by the Agent](#data-collected-by-the-agent) | |
| - [Advanced configurations and features](#advanced-configurations-and-features) | |
| - [Troubleshooting the Agent](#troubleshooting) | |
| - [Introduction to the Agent](#the-datadog-agent) | |
| - [Installation](#installing-the-agent) | |
| - [Data collected by the Agent](#data-collected-by-the-agent) | |
| - [Advanced configurations and features](#advanced-configurations-and-features) | |
| - [Troubleshooting](#troubleshooting) |
| - [Troubleshooting the Agent](#troubleshooting) | ||
|
|
||
|
|
||
| ## What is the Datadog Agent |
Contributor
There was a problem hiding this comment.
Feels weird not to end with a question mark:
Suggested change
| ## What is the Datadog Agent | |
| ## What is the Datadog Agent? |
|
|
||
| ## What is the Datadog Agent | ||
|
|
||
| The Datadog Agent is a software that runs on your hosts. It collects events and metrics from hosts and sends them to Datadog, where you can analyze your monitoring and performance data. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Datadog Agent is a software that runs on your hosts. It collects events and metrics from hosts and sends them to Datadog, where you can analyze your monitoring and performance data. | |
| The Datadog Agent is software that runs on your hosts. It collects events and metrics from hosts and sends them to Datadog, where you can analyze your monitoring and performance data. |
Comment on lines
+32
to
+34
| - Your local hosts (Windows, MacOS), | ||
| - A containerized environments (Docker, Kubernetes), | ||
| - In on-premises data centers. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Your local hosts (Windows, MacOS), | |
| - A containerized environments (Docker, Kubernetes), | |
| - In on-premises data centers. | |
| - Local hosts (Windows, macOS) | |
| - Containerized environments (Docker, Kubernetes) | |
| - On-premises data centers |
| The Datadog Agent is software that runs on your hosts. It collects events and metrics from hosts and sends them to Datadog, where you can analyze your monitoring and performance data. It can run on your local hosts (Windows, MacOS), containerized environments (Docker, Kubernetes), and in on-premises data centers. You can install and configure it using configuration management tools (Chef, Puppet, Ansible). | ||
| You can also install and configure the Agent using configuration management tools like Chef, Puppet, or Ansible. | ||
|
|
||
| The Agent is able to collect 75 to 100 system-level metrics every 15 to 20 seconds. With additional configuration, the Agent can send live data, logs, and traces from running processes to the Datadog Platform. The Datadog Agent is open source and its source code is available on GitHub at [DataDog/datadog-agent][1]. |
Contributor
There was a problem hiding this comment.
I know you didn't work on this part, but there's a few things worth changing here for editorial style:
Suggested change
| The Agent is able to collect 75 to 100 system-level metrics every 15 to 20 seconds. With additional configuration, the Agent can send live data, logs, and traces from running processes to the Datadog Platform. The Datadog Agent is open source and its source code is available on GitHub at [DataDog/datadog-agent][1]. | |
| The Agent can collect 75-100 system-level metrics every 15-20 seconds. With additional configuration, it can send live data, logs, and traces from running processes to Datadog. The Datadog Agent is open source, and its source code is available on GitHub at [DataDog/datadog-agent][1]. |
| - your [Datadog API key][16], which is used to associate your Agent's data with your organization, and | ||
| - the Datadog site ({{< region-param key="dd_site" code="true" >}}). | ||
| - **Integrations detection**: | ||
| - **Host**: [Integrations][9] are identified through the Agent configuration file |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Host**: [Integrations][9] are identified through the Agent configuration file | |
| - **Host**: [Integrations][9] are identified through the Agent configuration file. |
|
|
||
| {{% collapse-content title="Finding metrics in the Datadog UI" level="h4" expanded=false id="id-for-anchoring" %}} | ||
|
|
||
| In the Datadog UI, go to the [Metrics Summary page][22] and search for the metric `datadog.agent.started` or the metric `datadog.agent.running`. If these metrics are not visible right away, it may take a few minutes for the Agent to send the data to the Datadog Platform. |
Contributor
There was a problem hiding this comment.
This section starts a little abruptly and could use an intro. Something like:
Suggested change
| In the Datadog UI, go to the [Metrics Summary page][22] and search for the metric `datadog.agent.started` or the metric `datadog.agent.running`. If these metrics are not visible right away, it may take a few minutes for the Agent to send the data to the Datadog Platform. | |
| You can confirm the Agent is running correctly by checking its default metrics in the Datadog UI. Go to the [Metrics Summary page][22] and search for the metric `datadog.agent.started` or the metric `datadog.agent.running`. If these metrics are not visible right away, it may take a few minutes for the Agent to send the data to Datadog. |
|
|
||
| In the Datadog UI, go to the [Metrics Summary page][22] and search for the metric `datadog.agent.started` or the metric `datadog.agent.running`. If these metrics are not visible right away, it may take a few minutes for the Agent to send the data to the Datadog Platform. | ||
|
|
||
| Click on either of the metrics and a Metric panel opens up. This panel shows additional metadata about where these metrics are collected from and any associated tags. Because so far in this walkthrough no tags are configured on this host, you should see only the default tags that Datadog assigns to the metrics including `version` and `host`. See the following section on Agent Configuration Files to learn more about how to add tags. |
Contributor
There was a problem hiding this comment.
This isn't really a walkthrough anymore, so need to adjust that. A few editorial tweaks too:
Suggested change
| Click on either of the metrics and a Metric panel opens up. This panel shows additional metadata about where these metrics are collected from and any associated tags. Because so far in this walkthrough no tags are configured on this host, you should see only the default tags that Datadog assigns to the metrics including `version` and `host`. See the following section on Agent Configuration Files to learn more about how to add tags. | |
| Click on either of the metrics and a Metric panel opens. This panel shows additional metadata about where these metrics are collected and any associated tags. If no tags are configured on a host, you should see only the default tags that Datadog assigns to the metrics including `version` and `host`. See the section above on setting tags through the Agent configuration files to learn more about how to add tags. |
For this last sentence a direct link to the section would be ideal, but unfortunately I don't think that's possible with expandable sections. This might be a decent alternative.
|
|
||
| {{% collapse-content title="Agent overhead" level="h4" expanded=false id="id-for-anchoring" %}} | ||
|
|
||
| The amount of space and resources the Agent takes up depends on the configuration and what data the Agent is configured to send. At the onset, you can expect around 0.08% CPU used on average with a disk space of roughly 880MB to 1.3GB. |
Contributor
There was a problem hiding this comment.
Suggested change
| The amount of space and resources the Agent takes up depends on the configuration and what data the Agent is configured to send. At the onset, you can expect around 0.08% CPU used on average with a disk space of roughly 880MB to 1.3GB. | |
| The amount of space and resources the Agent takes up depends on the configuration and what data the Agent is sending. At the onset, you can expect around 0.08% CPU used on average with a disk space of roughly 880MB to 1.3GB. |
|
|
||
| {{% collapse-content title="Additional configuration options" level="h4" expanded=false id="id-for-anchoring" %}} | ||
|
|
||
| The collection of [logs][27], [traces][28], and [processes][29] data can be enabled through the Agent configuration file. These are not features that are enabled by default. For example, in the configuration file, the `logs_enabled` parameter is set to false. |
Contributor
There was a problem hiding this comment.
Suggested change
| The collection of [logs][27], [traces][28], and [processes][29] data can be enabled through the Agent configuration file. These are not features that are enabled by default. For example, in the configuration file, the `logs_enabled` parameter is set to false. | |
| The collection of [logs][27], [traces][28], and [processes][29] data can be enabled through the Agent configuration file. These features are not enabled by default. For example, in the configuration file, the `logs_enabled` parameter is set to false. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
This PR updates the Getting Started with the Agent documentation.
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes