Skip to content

Commit c107ed4

Browse files
technovangelisttechnovangelist
authored
Merge pull request DataDog#803 from DataDog/mattw/insertexamplelinks
standardize links to example conf and check files for local integrations
2 parents a970e93 + 2be86e7 commit c107ed4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+176
-180
lines changed

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ The installation section should cover anything that needs to be installed on the
104104

105105
The configuration section should cover anything that you can configure in the Datadog interface or the agent configuration files. In almost every case this section should be included since there is almost always something to configure. To be a complete integration, either an installation section or a configuration section must be included.
106106

107+
At the end of the configuration section include a link to the example configuration files. This should be done by adding `<%= insert_example_links%>`. This method takes a few optional parameters: `conf` is the name of the example YAML file, minus the extension; `check` is the name of the check file, minus the .py extension; setting either `check` or `conf` to `"none"` will hide that line; `include_intro` set to false will show only the list minus the sentence at the top; normally the integration title in the links will come from the pages frontmatter, but setting `integration` will override that, `yaml_extension` will change the extension from example to something else (like "default").
108+
109+
107110
### Validation
108111
**Required**
109112

‎content/integrations/activemq.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Get metrics from ActiveMQ in real time to
9999
else echo -e "\e[031mAgent is not running\e[0m"; fi
100100
{:.language-shell}
101101

102+
<%= insert_example_links(check: "none")%>
103+
102104
## Metrics
103105

104106
<%= get_metrics_from_git()%>

‎content/integrations/apache.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ Get metrics from Apache in real time; graph them and correlate them with other r
1414
* Correlate the performance of Apache with the rest of your applications
1515

1616

17-
From the open-source Agent:
18-
19-
* [Apache YAML example][1]
20-
* [Apache checks.d][2]
21-
2217
# Installation
2318

2419
Make sure that [`mod_status`][3] is installed on your Apache server with `ExtendedStatus` set to `on`
@@ -44,6 +39,8 @@ Make sure that [`mod_status`][3] is installed on your Apache server with `Extend
4439

4540
sudo datadog-agent restart
4641

42+
<%= insert_example_links %>
43+
4744
# Validation
4845

4946
To ensure the integration is installed correctly, run the agent info command.

‎content/integrations/btrfs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Capture Btrfs metrics into Datadog to:
1111
* Visualize your file system performance.
1212
* Correlate the performance of Btrfs file system with the rest of your applications.
1313

14+
<%= insert_example_links%>
15+
1416
## Metrics
1517

1618
<%= get_metrics_from_git() %>

‎content/integrations/cacti.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,8 @@ Connect Cacti to Datadog to:
1212
* Visualize Cacti metrics in Datadog.
1313
* Correlate metrics captured by Cacti with the rest of your applications.
1414

15-
From the open-source Agent:
15+
<%= insert_example_links%>
1616

17-
* [ Cacti YAML example][1]
18-
* [ Cacti checks.d][2]
19-
20-
[1]: https://github.com/DataDog/dd-agent/blob/master/conf.d/cacti.yaml.example
21-
[2]: https://github.com/DataDog/dd-agent/blob/master/checks.d/cacti.py
2217

2318

2419

‎content/integrations/cassandra.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Learn more about how to monitor Cassandra performance metrics thanks to [our ser
1212

1313
For information on JMX Checks, please see <a href="http://docs.datadoghq.com/integrations/java/">here</a>.
1414

15+
<%= insert_example_links(check: "none")%>
16+
1517
## Metrics
1618

1719
<%= get_metrics_from_git() %>

‎content/integrations/ceph.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ newhlevel: true
88
# Overview
99

1010
Enable the Datadog-Ceph integration to:
11+
1112
* Track disk usage across storage pools
1213
* Receive service checks in case of issues
1314
* Monitor I/O performance metrics
1415

16+
1517
# Installation
1618

1719
The integration is meant to be enabled on each Ceph monitor host.
@@ -22,7 +24,7 @@ Adjust the configuration file to match your environment. By default the check wi
2224

2325
Any extra tags specific to the cluster can be specified under `tags`, as usual.
2426

25-
* [Ceph YAML example][1]
27+
<%= insert_example_links%>
2628

2729
# Validation
2830

@@ -39,5 +41,3 @@ Execute the info command `/etc/init.d/datadog-agent info` and verify that the in
3941
- Collected 19 metrics, 0 events & 2 service checks
4042

4143

42-
43-
[1]: https://github.com/DataDog/dd-agent/blob/master/conf.d/ceph.yaml.example

‎content/integrations/consul.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,7 @@ Connect Consul to Datadog in order to:
1313
* Correlate the performance of Consul with the rest of your applications
1414
* Monitor the health of your Consul cluster
1515

16-
17-
18-
From the open-source Agent:
19-
20-
* [Consul YAML Example][1]
21-
* [Consul checks.d][2]
16+
<%= insert_example_links%>
2217

2318

2419
# Metrics
@@ -30,5 +25,3 @@ Finally, we perform a service check `consul.check` that will report on the state
3025

3126
The other consul metrics collected are not service bound but node bound, and only `consul.peers` is tagged with `mode:leader` or `mode:follower`.
3227

33-
[1]: https://github.com/DataDog/dd-agent/blob/master/conf.d/consul.yaml.example
34-
[2]: https://github.com/DataDog/dd-agent/blob/master/checks.d/consul.py

‎content/integrations/couchbase.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@ doclevel: basic
66
git_integration_title: couchbase
77
---
88

9+
### Overview
910

1011
Get metrics from Couchbase in real time to
1112

1213
* Visualize key Couchbase metrics
1314
* Correlate Couchbase performance with the rest of your applications
1415

15-
## Metrics
16+
<%= insert_example_links%>
17+
18+
### Metrics
1619

1720
<%= get_metrics_from_git() %>

‎content/integrations/couchdb.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,7 @@ Capture CouchDB data in Datadog to:
1212
* Visualize key CouchDB metrics.
1313
* Correlate CouchDB performance with the rest of your applications.
1414

15-
From the open-source Agent:
16-
17-
* [ CouchDB YAML example][1]
18-
* [ CouchDB checks.d][2]
19-
20-
21-
[1]: https://github.com/DataDog/dd-agent/blob/master/conf.d/couch.yaml.example
22-
[2]: https://github.com/DataDog/dd-agent/blob/master/checks.d/couch.py
15+
<%= insert_example_links(conf: "couch", check: "couch")%>
2316

2417

2518
## Metrics

0 commit comments

Comments
 (0)