Skip to content

Commit

Permalink
adding link to agent directory KB (#1941)
Browse files Browse the repository at this point in the history
  • Loading branch information
Gus authored Jul 26, 2018
1 parent d0da1ef commit 41b009e
Show file tree
Hide file tree
Showing 88 changed files with 179 additions and 91 deletions.
3 changes: 2 additions & 1 deletion active_directory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Agent's Active Directory check is included in the [Datadog Agent][4] package

### Configuration

1. Edit the `active_directory.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Active Directory performance data.
1. Edit the `active_directory.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][9] to start collecting your Active Directory performance data.

#### Metric collection

Expand Down Expand Up @@ -73,3 +73,4 @@ Need help? Contact [Datadog Support][5].
[5]: https://docs.datadoghq.com/help/
[7]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[8]: https://www.rubydoc.info/gems/activedirectory/0.9.3
[9]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion activemq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The check collects metrics via JMX, so you need a JVM on each node so the Agent
### Configuration

1. **Make sure that [JMX Remote is enabled][103] on your ActiveMQ server.**
2. Configure the agent to connect to ActiveMQ. Edit `activemq.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory. See the [sample activemq.d/conf.yaml][104] for all available configuration options.
2. Configure the agent to connect to ActiveMQ. Edit `activemq.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][111]. See the [sample activemq.d/conf.yaml][104] for all available configuration options.

```yaml
instances:
Expand Down Expand Up @@ -118,3 +118,4 @@ Need help? Contact [Datadog Support][107].
[108]: https://www.datadoghq.com/blog/monitor-activemq-metrics-performance/
[109]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[110]: https://raw.githubusercontent.com/DataDog/dd-agent/5.10.1/conf.d/activemq.yaml.example
[111]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion activemq_xml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Activemq XML check is included in the [Datadog Agent][1] package, so you don

### Configuration

1. Edit the `activemq_xml.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory, to point to your server and port, set the masters to monitor.
1. Edit the `activemq_xml.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][9], to point to your server and port, set the masters to monitor.

See the [sample activemq_xml.d/conf.yaml][2] for all available configuration options.

Expand Down Expand Up @@ -50,3 +50,4 @@ Need help? Contact [Datadog Support][5].
[6]: https://www.datadoghq.com/blog/monitor-activemq-metrics-performance/
[7]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[8]: https://github.com/DataDog/integrations-core/blob/master/docs/index.md
[9]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion agent_metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Agent Metrics check is included in the [Datadog Agent][1] package, so you do

### Configuration

1. Edit the `agent_metrics.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory, to point to your server and port, set the masters to monitor.
1. Edit the `agent_metrics.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][8], to point to your server and port, set the masters to monitor.

See the [sample agent_metrics.d/conf.yaml][2] for all available configuration options.

Expand Down Expand Up @@ -45,3 +45,4 @@ Need help? Contact [Datadog Support][5].
[4]: https://github.com/DataDog/integrations-core/blob/master/agent_metrics/metadata.csv
[5]: https://docs.datadoghq.com/help/
[7]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[8]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion apache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Apache check is packaged with the Agent. To start gathering your Apache metr

### Configuration

1. Edit the `apache.d/conf.yaml` file in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Apache [metrics](#metric-collection) and [logs](#log-collection).
1. Edit the `apache.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][13] to start collecting your Apache [metrics](#metric-collection) and [logs](#log-collection).
See the [sample apache.d/conf.yaml][2] for all available configuration options.

2. [Restart the Agent][3]
Expand Down Expand Up @@ -116,3 +116,4 @@ Returns CRITICAL if the Agent cannot connect to the configured `apache_status_ur
[10]: https://www.datadoghq.com/blog/collect-apache-performance-metrics/
[11]: https://www.datadoghq.com/blog/monitor-apache-web-server-datadog/
[12]: https://raw.githubusercontent.com/DataDog/integrations-core/master/apache/images/apache_dashboard.png
[13]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion aspdotnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The ASP.NET check is included in the [Datadog Agent][1] package, so you don't ne

### Configuration

1. Edit the `aspdotnet.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your ASP.NET performance data.
1. Edit the `aspdotnet.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][6] to start collecting your ASP.NET performance data.

See the [sample aspdotnet.d/conf.yaml][3] for all available configuration options.

Expand Down Expand Up @@ -42,3 +42,4 @@ Need help? Contact [Datadog Support][5].
[3]: https://github.com/DataDog/integrations-core/blob/master/aspdotnet/datadog_checks/aspdotnet/data/conf.yaml.example
[4]: https://app.datadoghq.com/event/stream
[5]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[6]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
5 changes: 3 additions & 2 deletions btrfs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Btrfs check is included in the [Datadog Agent][4] package, so you don't need

### Configuration

1. Configure the Agent according to your needs, edit the `btrfs.d/conf.yaml` file in the `conf.d/` folder at the root of your Agent's configuration directory.
1. Configure the Agent according to your needs, edit the `btrfs.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][9].
See the [sample btrfs.d/conf.yaml][2] for all available configuration options.

2. [Restart the Agent][3]
Expand Down Expand Up @@ -44,4 +44,5 @@ Need help? Contact [Datadog Support][6].
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/btrfs/metadata.csv
[6]: https://docs.datadoghq.com/help/
[8]: https://raw.githubusercontent.com/DataDog/integrations-core/master/btrfs/images/btrfs_metric.png
[8]: https://raw.githubusercontent.com/DataDog/integrations-core/master/btrfs/images/btrfs_metric.png
[9]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This check has a limit of 350 metrics per instance. The number of returned metri

### Configuration

Edit the `cassandra.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Cassandra [metrics](#metric-collection) and [logs](#log-collection).
Edit the `cassandra.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][1012] to start collecting your Cassandra [metrics](#metric-collection) and [logs](#log-collection).
See the [sample cassandra.d/conf.yaml][103] for all available configuration options.

#### Metric Collection
Expand Down Expand Up @@ -91,3 +91,4 @@ Need help? Contact [Datadog Support][107].
[109]: https://www.datadoghq.com/blog/how-to-collect-cassandra-metrics/
[1010]: https://www.datadoghq.com/blog/monitoring-cassandra-with-datadog/
[1011]: https://raw.githubusercontent.com/DataDog/integrations-core/master/cassandra/images/cassandra_dashboard.png
[1012]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion cassandra_nodetool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Cassandra Nodetool check is included in the [Datadog Agent][2] package, so y

### Configuration

Edit the file `cassandra_nodetool.d/conf.yaml` in the `conf.d/` folder at the root of your Agent's configuration directory.
Edit the file `cassandra_nodetool.d/conf.yaml` in the `conf.d/` folder at the root of your [Agent's configuration directory][11].
See the [sample cassandra_nodetool.d/conf.yaml][3] for all available configuration options:

```yaml
Expand Down Expand Up @@ -79,3 +79,4 @@ Need help? Contact [Datadog Support][6].
[8]: https://www.datadoghq.com/blog/how-to-collect-cassandra-metrics/
[9]: https://www.datadoghq.com/blog/monitoring-cassandra-with-datadog/
[10]: https://raw.githubusercontent.com/DataDog/integrations-core/master/cassandra_nodetool/images/cassandra_dashboard.png
[11]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion ceph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Ceph check is included in the [Datadog Agent][1] package, so you don't need

### Configuration

Edit the file `ceph.d/conf.yaml` in the `conf.d/` folder at the root of your Agent's configuration directory.
Edit the file `ceph.d/conf.yaml` in the `conf.d/` folder at the root of your [Agent's configuration directory][8].
See the [sample ceph.d/conf.yaml][2] for all available configuration options:

```yaml
Expand Down Expand Up @@ -105,3 +105,4 @@ Need help? Contact [Datadog Support][5].
[5]: https://docs.datadoghq.com/help/
[6]: https://www.datadoghq.com/blog/monitor-ceph-datadog/
[7]: https://raw.githubusercontent.com/DataDog/integrations-core/master/ceph/images/ceph_dashboard.png
[8]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion cisco_aci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Cisco ACI check is packaged with the Agent, so simply [install the Agent][1]

### Configuration

1. Edit the `cisco_aci.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory.
1. Edit the `cisco_aci.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][7].
See the [sample cisco_aci.d/conf.yaml][2] for all available configuration options:

```yaml
Expand Down Expand Up @@ -64,3 +64,4 @@ Need help? Contact [Datadog Support][6].
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/cisco_aci/metadata.csv
[6]: https://docs.datadoghq.com/help/
[7]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion consul/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Datadog Agent's Consul check is included in the [Datadog Agent][4] package,

### Configuration

Edit the `consul.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Consul [metrics](#metric-collection) and [logs](#log-collection).
Edit the `consul.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][13] to start collecting your Consul [metrics](#metric-collection) and [logs](#log-collection).
See the [sample consul.d/conf.yaml][2] for all available configuration options.

#### Metric Collection
Expand Down Expand Up @@ -170,3 +170,4 @@ Need help? Contact [Datadog Support][9].
[10]: https://www.datadoghq.com/blog/monitor-consul-health-and-performance-with-datadog
[11]: https://engineering.datadoghq.com/consul-at-datadog/
[12]: https://raw.githubusercontent.com/DataDog/integrations-core/master/consul/images/consul-dash.png
[13]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion couch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The CouchDB check is included in the [Datadog Agent][1] package, so you don't ne

### Configuration

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

```yaml
Expand Down Expand Up @@ -71,3 +71,4 @@ Need help? Contact [Datadog Support][6].
[6]: https://docs.datadoghq.com/help/
[7]: https://www.datadoghq.com/blog/monitoring-couchdb-with-datadog/
[8]: https://raw.githubusercontent.com/DataDog/integrations-core/master/couch/images/couchdb_dashboard.png
[9]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion couchbase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The Couchbase check is included in the [Datadog Agent][2] package, so you don't

### Configuration

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

```
Expand Down Expand Up @@ -82,3 +82,4 @@ Need help? Contact [Datadog Support][7].
[6]: https://github.com/DataDog/integrations-core/blob/master/couchbase/metadata.csv
[7]: https://docs.datadoghq.com/help/
[9]: https://www.datadoghq.com/blog/monitoring-couchbase-performance-datadog/
[10]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion directory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The directory check is included in the [Datadog Agent][1] package, so you don't

### Configuration

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

```yaml
Expand Down Expand Up @@ -58,3 +58,4 @@ Need help? Contact [Datadog Support][6].
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/directory/metadata.csv
[6]: https://docs.datadoghq.com/help/
[7]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion disk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The disk check is included in the [Datadog Agent][1] package, so you don't need
### Configuration

The disk check is enabled by default, and the Agent collects metrics on all local partitions.
If you want to configure the check with custom options, Edit the `disk.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory. See the [sample disk.d/conf.yaml][2] for all available configuration options.
If you want to configure the check with custom options, Edit the `disk.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][6]. See the [sample disk.d/conf.yaml][2] for all available configuration options.

### Validation

Expand All @@ -37,3 +37,4 @@ Need help? Contact [Datadog Support][5].
[3]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[4]: https://github.com/DataDog/integrations-core/blob/master/disk/metadata.csv
[5]: https://docs.datadoghq.com/help/
[6]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion dns_check/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Though many metrics-oriented checks are best run on the same host(s) as the moni

### Configuration

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

```yaml
Expand Down Expand Up @@ -67,3 +67,4 @@ Need help? Contact [Datadog Support][6].
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/dns_check/metadata.csv
[6]: https://docs.datadoghq.com/help/
[7]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion dotnetclr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Dotnetclr check is included in the [Datadog Agent][1] package, so you don't

## Configuration

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

2. [Restart the Agent][5]
Expand All @@ -29,3 +29,4 @@ Need help? Contact [Datadog Support][3].
[2]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[3]: https://docs.datadoghq.com/help/
[5]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[6]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion ecs_fargate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The ECS Fargate check is packaged with the Agent, [run the Agent][1] with your c

### Configuration

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

2. [Restart the Agent][5]
Expand Down Expand Up @@ -52,3 +52,4 @@ Need help? Contact [Datadog Support][3].
[4]: https://www.datadoghq.com/blog/monitor-aws-fargate/
[5]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[6]: https://github.com/DataDog/integrations-core/blob/master/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.example
[7]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
3 changes: 2 additions & 1 deletion elastic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Elasticsearch check is included in the [Datadog Agent][1] package, so you do

### Configuration

1. Edit the `elastic.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Elasticsearch [metrics](#metric-collection) and [logs](#log-collection).
1. Edit the `elastic.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][11] to start collecting your Elasticsearch [metrics](#metric-collection) and [logs](#log-collection).
See the [sample elastic.d/conf.yaml][2] for all available configuration options.

2. [Restart the Agent][3]
Expand Down Expand Up @@ -120,3 +120,4 @@ To get a better idea of how (or why) to integrate your Elasticsearch cluster wit
[8]: https://docs.datadoghq.com/integrations/faq/why-isn-t-elasticsearch-sending-all-my-metrics/
[9]: https://www.datadoghq.com/blog/monitor-elasticsearch-performance-metrics/
[10]: https://raw.githubusercontent.com/DataDog/integrations-core/master/elastic/images/elasticsearch-dash.png
[11]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
Loading

0 comments on commit 41b009e

Please sign in to comment.