Skip to content

Commit

Permalink
Update README links (DataDog#10529)
Browse files Browse the repository at this point in the history 
* Update README links

* Update README to correct link to install agent

* Update README'

* Apply suggestions from code review

Co-authored-by: Julien Lebot <[email protected]>

* Fix gunicorn link

* Reformat all links

Co-authored-by: Julien Lebot <[email protected]>
  • Loading branch information
@yzhan289 @julien-lebot
yzhan289 and julien-lebot authored Nov 8, 2021
1 parent 5740da0 commit b3c1f97
Show file tree
Hide file tree
Showing 49 changed files with 480 additions and 456 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ An up-to-date list of all developers authorized to sign releases can be found [h
[5]: https://github.com/DataDog/integrations-extras
[6]: https://docs.datadoghq.com/developers/integrations/
[7]: https://github.com/DataDog/datadog-agent
[8]: https://docs.datadoghq.com/agent/
[8]: https://app.datadoghq.com/account/settings#agent
[9]: https://docs.pytest.org/en/latest/
[10]: https://packaging.python.org/tutorials/distributing-packages/
[11]: https://docs.datadoghq.com
Expand Down
35 changes: 18 additions & 17 deletions aerospike/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you use an older Aerospike server version, it is still possible to monitor it

### Installation

The Aerospike check is included in the Datadog Agent package.
The Aerospike check is included in the [Datadog Agent][2] package.
No additional installation is needed on your server.

### Configuration
Expand All @@ -27,9 +27,9 @@ No additional installation is needed on your server.
##### Metric collection
To configure this check for an Agent running on a host:

1. Edit the `aerospike.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your aerospike performance data. See the [sample aerospike.d/conf.yaml][2] for all available configuration options.
1. Edit the `aerospike.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your aerospike performance data. See the [sample aerospike.d/conf.yaml][3] for all available configuration options.

2. [Restart the Agent][3].
2. [Restart the Agent][4].

##### Log collection

Expand All @@ -49,17 +49,17 @@ To configure this check for an Agent running on a host:
source: aerospike
```

Change the `path` parameter value and configure them for your environment. See the [sample aerospike.d/conf.yaml][2] for all available configuration options.
Change the `path` parameter value and configure them for your environment. See the [sample aerospike.d/conf.yaml][3] for all available configuration options.

3. [Restart the Agent][3].
3. [Restart the Agent][4].

<!-- xxz tab xxx -->
<!-- xxx tab "Containerized" xxx -->


#### Containerized

For containerized environments, see the [Autodiscovery Integration Templates][4] for guidance on applying the parameters below.
For containerized environments, see the [Autodiscovery Integration Templates][5] for guidance on applying the parameters below.

##### Metric collection

Expand All @@ -73,7 +73,7 @@ For containerized environments, see the [Autodiscovery Integration Templates][4]

_Available for Agent versions >6.0_

Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][5].
Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][6].

| Parameter | Value |
| -------------- | --------------------------------------------------- |
Expand All @@ -84,13 +84,13 @@ Collecting logs is disabled by default in the Datadog Agent. To enable it, see [

### Validation

[Run the Agent's status subcommand][6] and look for `aerospike` under the Checks section.
[Run the Agent's status subcommand][7] and look for `aerospike` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][7] for a list of metrics provided by this integration.
See [metadata.csv][8] for a list of metrics provided by this integration.

### Service Checks

Expand All @@ -103,13 +103,14 @@ Aerospike does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][8].
Need help? Contact [Datadog support][9].

[1]: https://download.aerospike.com/download/client/python/notes.html#5.0.0
[2]: https://github.com/DataDog/integrations-core/blob/master/aerospike/datadog_checks/aerospike/data/conf.yaml.example
[3]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[4]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[5]: https://docs.datadoghq.com/agent/kubernetes/log/
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-core/blob/master/aerospike/metadata.csv
[8]: https://docs.datadoghq.com/help/
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://github.com/DataDog/integrations-core/blob/master/aerospike/datadog_checks/aerospike/data/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[5]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[6]: https://docs.datadoghq.com/agent/kubernetes/log/
[7]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[8]: https://github.com/DataDog/integrations-core/blob/master/aerospike/metadata.csv
[9]: https://docs.datadoghq.com/help/
2 changes: 1 addition & 1 deletion ambari/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Need help? Contact [Datadog support][10].


[1]: https://ambari.apache.org
[2]: https://docs.datadoghq.com/agent/
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://github.com/DataDog/integrations-core/blob/master/ambari/datadog_checks/ambari/data/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[5]: https://docs.datadoghq.com/agent/kubernetes/integrations/
Expand Down
89 changes: 45 additions & 44 deletions apache/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The Apache check tracks requests per second, bytes served, number of worker thre

### Installation

The Apache check is packaged with the Agent. To start gathering your Apache metrics and logs, you need to:
The Apache check is packaged with the [Datadog Agent][2]. To start gathering your Apache metrics and logs, you need to:

1. [Install the Agent][2] on your Apache servers.
1. [Install the Agent][3] on your Apache servers.

2. Install `mod_status` on your Apache servers and enable `ExtendedStatus`.

Expand All @@ -27,7 +27,7 @@ To configure this check for an Agent running on a host:

##### Metric collection

1. Edit the `apache.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][3] to start collecting your Apache metrics. See the [sample apache.d/conf.yaml][4] for all available configuration options.
1. Edit the `apache.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][4] to start collecting your Apache metrics. See the [sample apache.d/conf.yaml][5] for all available configuration options.

```yaml
init_config:
Expand All @@ -39,7 +39,7 @@ To configure this check for an Agent running on a host:
- apache_status_url: http://localhost/server-status?auto
```
2. [Restart the Agent][5].
2. [Restart the Agent][6].
##### Log collection
Expand Down Expand Up @@ -68,9 +68,9 @@ _Available for Agent versions >6.0_
sourcecategory: http_web_error
```

See the [sample apache.d/conf.yaml][4] for all available configuration options.
See the [sample apache.d/conf.yaml][5] for all available configuration options.

3. [Restart the Agent][5].
3. [Restart the Agent][6].

<!-- xxz tab xxx -->
<!-- xxx tab "Docker" xxx -->
Expand All @@ -81,7 +81,7 @@ To configure this check for an Agent running on a container:

##### Metric collection

Set [Autodiscovery Integrations Templates][6] as Docker labels on your application container:
Set [Autodiscovery Integrations Templates][7] as Docker labels on your application container:

```yaml
LABEL "com.datadoghq.ad.check_names"='["apache"]'
Expand All @@ -92,9 +92,9 @@ LABEL "com.datadoghq.ad.instances"='[{"apache_status_url": "http://%%host%%/serv
##### Log collection


Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Docker Log Collection][7].
Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Docker Log Collection][8].

Then, set [Log Integrations][8] as Docker labels:
Then, set [Log Integrations][9] as Docker labels:

```yaml
LABEL "com.datadoghq.ad.logs"='[{"source": "apache", "service": "<SERVICE_NAME>"}]'
Expand All @@ -109,7 +109,7 @@ To configure this check for an Agent running on Kubernetes:

##### Metric collection

Set [Autodiscovery Integrations Templates][9] as pod annotations on your application container. Aside from this, templates can also be configured with [a file, a configmap, or a key-value store][10].
Set [Autodiscovery Integrations Templates][10] as pod annotations on your application container. Aside from this, templates can also be configured with [a file, a configmap, or a key-value store][11].

```yaml
apiVersion: v1
Expand All @@ -133,9 +133,9 @@ spec:
##### Log collection


Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][11].
Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection][12].

Then, set [Log Integrations][8] as pod annotations. This can also be configured with [a file, a configmap, or a key-value store][12].
Then, set [Log Integrations][9] as pod annotations. This can also be configured with [a file, a configmap, or a key-value store][13].

```yaml
apiVersion: v1
Expand All @@ -159,7 +159,7 @@ To configure this check for an Agent running on ECS:

##### Metric collection

Set [Autodiscovery Integrations Templates][6] as Docker labels on your application container:
Set [Autodiscovery Integrations Templates][7] as Docker labels on your application container:

```json
{
Expand All @@ -178,9 +178,9 @@ Set [Autodiscovery Integrations Templates][6] as Docker labels on your applicati
##### Log collection


Collecting logs is disabled by default in the Datadog Agent. To enable it, see [ECS Log Collection][13].
Collecting logs is disabled by default in the Datadog Agent. To enable it, see [ECS Log Collection][14].

Then, set [Log Integrations][8] as Docker labels:
Then, set [Log Integrations][9] as Docker labels:

```json
{
Expand All @@ -199,57 +199,58 @@ Then, set [Log Integrations][8] as Docker labels:

### Validation

[Run the Agent's status subcommand][14] and look for `apache` under the Checks section.
[Run the Agent's status subcommand][15] and look for `apache` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][15] for a list of metrics provided by this check.
See [metadata.csv][16] for a list of metrics provided by this check.

### Events

The Apache check does not include any events.

### Service Checks

See [service_checks.json][16] for a list of service checks provided by this integration.
See [service_checks.json][17] for a list of service checks provided by this integration.

## Troubleshooting

### Apache status URL

If you are having issues with your Apache integration, it is mostly like due to the Agent not being able to access your Apache status URL. Try running curl for the `apache_status_url` listed in [your `apache.d/conf.yaml` file][4] (include your login credentials if applicable).
If you are having issues with your Apache integration, it is mostly like due to the Agent not being able to access your Apache status URL. Try running curl for the `apache_status_url` listed in [your `apache.d/conf.yaml` file][5] (include your login credentials if applicable).

- [Apache SSL certificate issues][17]
- [Apache SSL certificate issues][18]

## Further Reading

Additional helpful documentation, links, and articles:

- [Deploying and configuring Datadog with CloudFormation][18]
- [Monitoring Apache web server performance][19]
- [How to collect Apache performance metrics][20]
- [How to monitor Apache web server with Datadog][21]
- [Deploying and configuring Datadog with CloudFormation][19]
- [Monitoring Apache web server performance][20]
- [How to collect Apache performance metrics][21]
- [How to monitor Apache web server with Datadog][22]

[1]: https://raw.githubusercontent.com/DataDog/integrations-core/master/apache/images/apache_dashboard.png
[2]: https://docs.datadoghq.com/agent/
[3]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[4]: https://github.com/DataDog/integrations-core/blob/master/apache/datadog_checks/apache/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/agent/docker/integrations/?tab=docker
[7]: https://docs.datadoghq.com/agent/docker/log/?tab=containerinstallation#installation
[8]: https://docs.datadoghq.com/agent/docker/log/?tab=containerinstallation#log-integrations
[9]: https://docs.datadoghq.com/agent/kubernetes/integrations/?tab=kubernetes
[10]: https://docs.datadoghq.com/agent/kubernetes/integrations/?tab=kubernetes#configuration
[11]: https://docs.datadoghq.com/agent/kubernetes/log/?tab=containerinstallation#setup
[12]: https://docs.datadoghq.com/agent/kubernetes/log/?tab=daemonset#configuration
[13]: https://docs.datadoghq.com/agent/amazon_ecs/logs/?tab=linux
[14]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[15]: https://github.com/DataDog/integrations-core/blob/master/apache/metadata.csv
[16]: https://github.com/DataDog/integrations-core/blob/master/apache/assets/service_checks.json
[17]: https://docs.datadoghq.com/integrations/faq/apache-ssl-certificate-issues/
[18]: https://www.datadoghq.com/blog/deploying-datadog-with-cloudformation
[19]: https://www.datadoghq.com/blog/monitoring-apache-web-server-performance
[20]: https://www.datadoghq.com/blog/collect-apache-performance-metrics
[21]: https://www.datadoghq.com/blog/monitor-apache-web-server-datadog
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.datadoghq.com/agent/
[4]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[5]: https://github.com/DataDog/integrations-core/blob/master/apache/datadog_checks/apache/data/conf.yaml.example
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[7]: https://docs.datadoghq.com/agent/docker/integrations/?tab=docker
[8]: https://docs.datadoghq.com/agent/docker/log/?tab=containerinstallation#installation
[9]: https://docs.datadoghq.com/agent/docker/log/?tab=containerinstallation#log-integrations
[10]: https://docs.datadoghq.com/agent/kubernetes/integrations/?tab=kubernetes
[11]: https://docs.datadoghq.com/agent/kubernetes/integrations/?tab=kubernetes#configuration
[12]: https://docs.datadoghq.com/agent/kubernetes/log/?tab=containerinstallation#setup
[13]: https://docs.datadoghq.com/agent/kubernetes/log/?tab=daemonset#configuration
[14]: https://docs.datadoghq.com/agent/amazon_ecs/logs/?tab=linux
[15]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[16]: https://github.com/DataDog/integrations-core/blob/master/apache/metadata.csv
[17]: https://github.com/DataDog/integrations-core/blob/master/apache/assets/service_checks.json
[18]: https://docs.datadoghq.com/integrations/faq/apache-ssl-certificate-issues/
[19]: https://www.datadoghq.com/blog/deploying-datadog-with-cloudformation
[20]: https://www.datadoghq.com/blog/monitoring-apache-web-server-performance
[21]: https://www.datadoghq.com/blog/collect-apache-performance-metrics
[22]: https://www.datadoghq.com/blog/monitor-apache-web-server-datadog
27 changes: 14 additions & 13 deletions avi_vantage/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,43 @@ Follow the instructions below to install and configure this check for an Agent r

### Installation

The Avi Vantage check is included in the [Datadog Agent][2] package.
The Avi Vantage check is included in the [Datadog Agent][3] package.
No additional installation is needed on your server.

### Configuration

1. Edit the `avi_vantage.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your avi_vantage performance data. See the [sample avi_vantage.d/conf.yaml][3] for all available configuration options.
1. Edit the `avi_vantage.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your avi_vantage performance data. See the [sample avi_vantage.d/conf.yaml][4] for all available configuration options.

2. [Restart the Agent][4].
2. [Restart the Agent][5].

### Validation

[Run the Agent's status subcommand][5] and look for `avi_vantage` under the Checks section.
[Run the Agent's status subcommand][6] and look for `avi_vantage` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][6] for a list of metrics provided by this check.
See [metadata.csv][7] for a list of metrics provided by this check.

### Service Checks

See [service_checks.json][7] for a list of service checks provided by this integration.
See [service_checks.json][8] for a list of service checks provided by this integration.

### Events

Avi Vantage does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][8].
Need help? Contact [Datadog support][9].

[1]: https://avinetworks.com/why-avi/multi-cloud-load-balancing/
[2]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[3]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[6]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/metadata.csv
[7]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/assets/service_checks.json
[8]: https://docs.datadoghq.com/help/
[3]: https://app.datadoghq.com/account/settings#agent
[4]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/metadata.csv
[8]: https://github.com/DataDog/integrations-core/blob/master/avi_vantage/assets/service_checks.json
[9]: https://docs.datadoghq.com/help/
2 changes: 1 addition & 1 deletion azure_iot_edge/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Need help? Contact [Datadog support][10].
- [Monitor Azure IoT Edge with Datadog][11]

[1]: https://azure.microsoft.com/en-us/services/iot-edge/
[2]: https://docs.datadoghq.com/agent/
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.microsoft.com/en-us/azure/iot-edge/how-to-deploy-modules-portal
[4]: https://github.com/DataDog/integrations-core/blob/master/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/docker/integrations/
Expand Down
2 changes: 1 addition & 1 deletion cilium/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Need help? Contact [Datadog support][11].

[1]: https://cilium.io
[2]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[3]: https://docs.datadoghq.com/agent/
[3]: https://app.datadoghq.com/account/settings#agent
[4]: https://github.com/DataDog/integrations-core/blob/master/cilium/datadog_checks/cilium/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/agent/kubernetes/?tab=daemonset#installation
Expand Down
Loading

0 comments on commit b3c1f97

Please sign in to comment.