Skip to content

Commit cbadfd1

Browse files
clarified cluster agent check docs (#18493)
* clarified cluster agent check docs * change tense Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> --------- Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
1 parent 6b8a2a7 commit cbadfd1

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

datadog_cluster_agent/README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,47 @@ Follow the instructions below to install and configure this check for an Agent r
1010

1111
### Installation
1212

13-
The Datadog-Cluster-Agent check is included in the [Datadog Agent][2] package.
13+
The Datadog Cluster Agent check is included in the [Datadog Agent][2] package.
1414
No additional installation is needed on your server.
1515

1616
### Configuration
17+
The Datadog Cluster Agent check uses [Autodiscovery][3] to automatically configure itself in most scenarios. The check runs in the Datadog Agent pod on the same node as the Cluster Agent pod. It will not run in the Cluster Agent itself.
1718

18-
1. Edit the `datadog_cluster_agent.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your datadog_cluster_agent performance data. See the [sample datadog_cluster_agent.d/conf.yaml][3] for all available configuration options.
19+
If you need to further configure the check:
1920

20-
2. [Restart the Agent][4].
21+
1. Edit the `datadog_cluster_agent.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your datadog_cluster_agent performance data. See the [sample datadog_cluster_agent.d/conf.yaml][4] for all available configuration options.
22+
23+
2. [Restart the Agent][5].
2124

2225
### Validation
2326

24-
[Run the Agent's status subcommand][5] and look for `datadog_cluster_agent` under the Checks section.
27+
[Run the Agent's status subcommand][6] and look for `datadog_cluster_agent` under the Checks section.
2528

2629
## Data Collected
2730

2831
### Metrics
2932

30-
See [metadata.csv][6] for a list of metrics provided by this check.
33+
See [metadata.csv][7] for a list of metrics provided by this check.
3134

3235
### Events
3336

3437
The Datadog-Cluster-Agent integration does not include any events.
3538

3639
### Service Checks
3740

38-
See [service_checks.json][7] for a list of service checks provided by this integration.
41+
See [service_checks.json][8] for a list of service checks provided by this integration.
3942

4043
## Troubleshooting
4144

42-
Need help? Contact [Datadog support][8].
45+
Need help? Contact [Datadog support][9].
4346

4447

4548
[1]: https://docs.datadoghq.com/agent/cluster_agent/
4649
[2]: https://docs.datadoghq.com/agent/kubernetes/integrations/
47-
[3]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example
48-
[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
49-
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
50-
[6]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/metadata.csv
51-
[7]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/assets/service_checks.json
52-
[8]: https://docs.datadoghq.com/help/
50+
[3]: https://docs.datadoghq.com/getting_started/containers/autodiscovery/
51+
[4]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example
52+
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
53+
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
54+
[7]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/metadata.csv
55+
[8]: https://github.com/DataDog/integrations-core/blob/master/datadog_cluster_agent/assets/service_checks.json
56+
[9]: https://docs.datadoghq.com/help/

0 commit comments

Comments
 (0)