DOCS-2530 Lint Integrations section (part 5) (DataDog#10805)

kkourtchikov · Dec 10, 2021 · 849a80f · 849a80f
1 parent 8d700c2
commit 849a80f
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 51 deletions.
diff --git a/glusterfs/README.md b/glusterfs/README.md
@@ -78,12 +78,11 @@ partial -->
         source: glusterfs
     ```
 
-
   Change the `path` parameter value based on your environment. See the [sample conf.yaml][4] for all available configuration options.
 
   3. [Restart the Agent][6].
 
-  See [Datadog's documentation][7] for additional information on how to configure the Agent for log collection in Kubernetes environments.
+For information on configuring the Agent for log collection in Kubernetes environments, see [Kubernetes Log Collection][7].
 
 ### Validation
 

diff --git a/go-metro/README.md b/go-metro/README.md
@@ -2,17 +2,17 @@
 
 ## Overview
 
-The TCP RTT check reports on roundtrip times between the host the agent is running on and any host it is communicating with. This check is passive and will only report RTT times for packets being sent and received from outside the check. The check itself will not send any packets.
+The TCP RTT check reports on roundtrip times between the host the Agent is running on and any host it is communicating with. This check is passive and only reports RTT times for packets being sent and received from outside the check. The check itself does not send any packets.
 
-This check is only shipped in the 64-bit DEB and RPM Datadog Agent v5 packages. The check is currently _not_ available with Datadog Agent v6.
+This check is only shipped in the 64-bit DEB and RPM Datadog Agent v5 packages. The check is _not_ available with Datadog Agent v6.
 
 ## Setup
 
 Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][1] for guidance on applying these instructions.
 
 ### Installation
 
-The TCP RTT check-also known as [go-metro][2]-is packaged with the Agent, but requires additional system libraries. The check uses timestamps provided by the PCAP library to compute the time between any outgoing packet and the corresponding TCP acknowledgement. As such, PCAP must be installed and configured.
+The TCP RTT check-also known as [go-metro][2]-is packaged with the Agent, but requires additional system libraries. The check uses timestamps provided by the PCAP library to compute the time between any outgoing packet and the corresponding TCP acknowledgment. As such, PCAP must be installed and configured.
 
 Debian-based systems should use one of the following:
 
@@ -37,7 +37,7 @@ sudo setcap cap_net_raw+ep /opt/datadog-agent/bin/go-metro
 ### Configuration
 
 Edit the `go-metro.yaml` file in your agent's `conf.d` directory. See the [sample go-metro.yaml][3] for all available configuration options.
-The following is an example file that will show the TCP RTT times for app.datadoghq.com and 192.168.0.22:
+The following is an example file that shows the TCP RTT times for app.datadoghq.com and 192.168.0.22:
 
 ```yaml
 init_config:
@@ -58,7 +58,7 @@ instances:
       - app.datadoghq.com
 ```
 
-*NOTE*: for go-metro to run unprivileged, you will have to set CAP_NET_RAW capabilities on the binary:
+**Note**: For go-metro to run unprivileged, you need to set `CAP_NET_RAW` capabilities on the binary:
 ```
 # Install required libraries
 $ sudo apt-get install libcap  # debian
@@ -70,17 +70,11 @@ $ sudo yum install compat-libcap1  # redhat alternative
 $ sudo setcap cap_net_raw+ep /opt/datadog-agent/bin/go-metro
 ```
 
-Because of different package names for different distros, if the instructions above
-don't work for you, please issue an `apt-cache search libcap` or `yum search libcap` and you
-should get a shortlist of packages that might provide the binary. Feel free to reach out
-should you require assistance.
+Because of different package names for different distributions, if the instructions above don't work for you, issue an `apt-cache search libcap` or `yum search libcap` for a shortlist of packages that provide the binary. Contact [Datadog support][6], if you need assistance.
 
-Also, please note that go-metro logs to its own file - found in `/var/log/datadog/go-metro.log`.
-Additionally, go-metro runs standalone so it will *NOT* currently appear on the Agent's info page.
+**Note**: go-metro logs to its own file - found in `/var/log/datadog/go-metro.log`. Additionally, go-metro runs standalone so it does not appear on the Agent's info page.
 
-Finally, because the go-metro binary is only bundled with the 64-bit RPM and DEB distributions of the
-Datadog Agent, it is only available in those packaged versions (i.e. go-metro is currently
-unavailable with the source install or the 32-bit packages).
+Finally, because the go-metro binary is only bundled with the 64-bit RPM and DEB distributions of the Datadog Agent, it is only available in those packaged versions, that is go-metro is unavailable with the source install or 32-bit packages.
 
 ### Validation
 

diff --git a/go_expvar/README.md b/go_expvar/README.md
@@ -18,7 +18,7 @@ The Go Expvar check is packaged with the Agent, so [install the Agent][3] anywhe
 
 #### Prepare the service
 
-If your Go service doesn't use the [expvar package][4] already, import it (`import "expvar"`). If you don't want to instrument your own metrics with expvar - i.e. you only want to collect your service's memory metrics - import the package using the blank identifier (`import _ "expvar"`). If your service doesn't already listen for HTTP requests (with the http package), [make it listen][5] locally just for the Datadog Agent.
+If your Go service doesn't use the [expvar package][4] already, import it (`import "expvar"`). If you don't want to instrument your own metrics with expvar - that is you only want to collect your service's memory metrics - import the package using the blank identifier (`import _ "expvar"`). If your service doesn't already listen for HTTP requests (with the http package), [make it listen][5] locally just for the Datadog Agent.
 
 <!-- xxx tabs xxx -->
 <!-- xxx tab "Host" xxx -->

diff --git a/gunicorn/README.md b/gunicorn/README.md
@@ -6,7 +6,7 @@
 
 The Datadog Agent collects one main metric about Gunicorn: the number of worker processes running. It also sends one service check: whether or not Gunicorn is running.
 
-Gunicorn itself can provide further metrics via DogStatsD, including those for:
+Gunicorn itself can provide further metrics using DogStatsD, including:
 
 - Total request rate
 - Request rate by status code (2xx, 3xx, 4xx, 5xx)
@@ -19,7 +19,7 @@ Gunicorn itself can provide further metrics via DogStatsD, including those for:
 
 The Datadog Agent's Gunicorn check is included in the [Datadog Agent][2] package, so you don't need to install anything else on your Gunicorn servers.
 
-The Gunicorn check requires your Gunicorn app's Python environment to have the [`setproctitle`][3] package; without it, the Datadog Agent will always report that it cannot find a `gunicorn` master process (and hence, cannot find workers, either). Install the `setproctitle` package in your app's Python environment if you want to collect the `gunicorn.workers` metric.
+The Gunicorn check requires your Gunicorn app's Python environment to have the [`setproctitle`][3] package; without it, the Datadog Agent reports that it cannot find a `gunicorn` master process (and hence, cannot find workers, either). Install the `setproctitle` package in your app's Python environment if you want to collect the `gunicorn.workers` metric.
 
 ### Configuration
 
@@ -65,9 +65,11 @@ _Available for Agent versions >6.0_
    logs_enabled: true
    ```
 
-2. Use the following command to configure the path of the access log file as explained in the [Gunicorn Documentation][9]: `--access-logfile <MY_FILE_PATH>`
+2. Use the following command to configure the path of the [access log][9] file:
+    `--access-logfile <MY_FILE_PATH>`
 
-3. Use the following command to configure the path of the error log file as explained in the [Gunicorn Documentation][10]: `--error-logfile FILE, --log-file <MY_FILE_PATH>`
+3. Use the following command to configure the path of the [error log][10] file:
+    `--error-logfile FILE, --log-file <MY_FILE_PATH>`
 
 4. Add this configuration block to your `gunicorn.d/conf.yaml` file to start collecting your Gunicorn logs:
 

diff --git a/haproxy/README.md b/haproxy/README.md
@@ -34,7 +34,7 @@ The recommended way to set up this integration is by enabling the Prometheus end
 
 **Note**: This configuration strategy is provided as a reference for legacy users. If you are setting up the integration for the first time, consider using the Prometheus-based strategy described in the previous section.
 
-The Agent collects metrics via a stats endpoint:
+The Agent collects metrics using a stats endpoint:
 
 1. Configure one in your `haproxy.conf`:
 
@@ -154,7 +154,7 @@ LABEL "com.datadoghq.ad.instances"='[{"url": "https://%%host%%/admin?stats"}]'
 {{< /site-region >}}
 partial -->
 
-Collecting logs is disabled by default in the Datadog Agent. To enable it, see the [Docker log collection documentation][10].
+Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Docker Log Collection][10].
 
 Then, set [Log Integrations][11] as Docker labels:
 
@@ -202,7 +202,7 @@ partial -->
 
 _Available for Agent versions >6.0_
 
-Collecting logs is disabled by default in the Datadog Agent. To enable it, see the [Kubernetes log collection documentation][14].
+Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][14].
 
 Then, set [Log Integrations][11] as pod annotations. This can also be configured with [a file, a configmap, or a key-value store][15].
 
@@ -253,7 +253,7 @@ partial -->
 
 _Available for Agent versions >6.0_
 
-Collecting logs is disabled by default in the Datadog Agent. To enable it, see the [ECS log collection documentation][16].
+Collecting logs is disabled by default in the Datadog Agent. To enable it, see [ECS Log Collection][16].
 
 Then, set [Log Integrations][11] as Docker labels:
 

diff --git a/harbor/README.md b/harbor/README.md
@@ -80,7 +80,7 @@ partial -->
 
 _Available for Agent versions >6.0_
 
-Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes log collection documentation][7].
+Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][7].
 
 | Parameter      | Value                                               |
 | -------------- | --------------------------------------------------- |

diff --git a/hazelcast/README.md b/hazelcast/README.md
@@ -28,7 +28,7 @@ To configure this check for an Agent running on a host:
 
    This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page.
    You can specify the metrics you are interested in by editing the configuration below.
-   To learn how to customize the metrics to collect, visit the [JMX Checks documentation][4] for more detailed instructions.
+   To learn how to customize the metrics to collect, see the [JMX Checks documentation][4] for more detailed instructions.
    If you need to monitor more metrics, contact [Datadog support][5].
 
 2. [Restart the Agent][6].

diff --git a/hive/README.md b/hive/README.md
@@ -44,14 +44,14 @@ The Hive check is included in the [Datadog Agent][2] package. No additional inst
 
 To configure this check for an Agent running on a host:
 
-Follow now the instructions below to configure this check for an Agent running on a host. For containerized environments, see the [Containerized](#containerized) section.
+Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the [Containerized](#containerized) section.
 
 ##### Metric collection
 
 1. Edit the `hive.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your hive performance data. See the [sample hive.d/conf.yaml][4] for all available configuration options.
 
     This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page. You can specify the metrics you are interested in by editing the configuration below.
-    To learn how to customize the metrics to collect, visit the [JMX Checks documentation][5] for more detailed instructions. If you need to monitor more metrics, contact [Datadog support][6].
+    To learn how to customize the metrics to collect, see the [JMX Checks documentation][5] for more detailed instructions. If you need to monitor more metrics, contact [Datadog support][6].
 
 2. [Restart the Agent][7].
 
@@ -110,7 +110,7 @@ partial -->
 
 _Available for Agent versions >6.0_
 
-Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes log collection documentation][10].
+Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][10].
 
 | Parameter      | Value                                                                                                                                                             |
 | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/hivemq/README.md b/hivemq/README.md
@@ -29,7 +29,7 @@ To configure this check for an Agent running on a host:
 
    This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page.
    You can specify the metrics you are interested in by editing the configuration below.
-   To learn how to customize the metrics to collect visit the [JMX Checks documentation][4] for more detailed instructions.
+   To learn how to customize the metrics to collect see the [JMX Checks documentation][4] for more detailed instructions.
    If you need to monitor more metrics, contact [Datadog support][5].
 
 2. [Restart the Agent][6]