Skip to content

Commit

Permalink
Link formating update (#3022)
Browse files Browse the repository at this point in the history
  • Loading branch information
@gzussa
Gus authored and gzussa committed Jan 25, 2019
1 parent 0622cd5 commit b66de4d
Show file tree
Hide file tree
Showing 241 changed files with 4,704 additions and 3,807 deletions.
653 changes: 383 additions & 270 deletions AGENT_CHANGELOG.md
View file

Large diffs are not rendered by default.

27 changes: 14 additions & 13 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ To propose improvements, feel free to submit a PR.

## Submitting issues

* If you think you've found an issue, please search the [Troubleshooting][troubleshooting]
section of our [Knowledge base][kb] to see if it's known.
* If you can't find anything useful, please contact our [support][support] and
[send them your logs][flare].
* If you think you've found an issue, please search the [Troubleshooting][1]
section of our [Knowledge base][2] to see if it's known.
* If you can't find anything useful, please contact our [support][3] and
[send them your logs][4].
* Finally, you can open a Github issue.

## Pull Requests
Expand All @@ -33,10 +33,10 @@ when submitting your PR:
* `changelog/Security` in case of vulnerabilities.
* `changelog/no-changelog` in case this PR should not appear in the changelog at all.

See [here](https://keepachangelog.com/en/1.0.0/) for more details about changelogs.
See [here][5] for more details about changelogs.

Your pull request must pass all CI tests before we will merge it. If you're seeing
an error and don't think it's your fault, it may not be! [Join us on Slack][slack]
an error and don't think it's your fault, it may not be! [Join us on Slack][6]
or send us an email, and together we'll get it sorted out.

### Keep it small, focused
Expand Down Expand Up @@ -76,11 +76,12 @@ happier!

## Integrations Extras

For new integrations, please open a pull request in the [integrations-extras][extras] repo.
For new integrations, please open a pull request in the [integrations-extras][7] repo.

[troubleshooting]: https://datadog.zendesk.com/hc/en-us/sections/200766955-Troubleshooting
[kb]: https://datadog.zendesk.com/hc/en-us
[support]: https://docs.datadoghq.com/help/
[flare]: https://docs.datadoghq.com/agent/troubleshooting/#send-a-flare
[extras]: https://github.com/DataDog/integrations-extras
[slack]: https://datadoghq.slack.com
[1]: https://datadog.zendesk.com/hc/en-us/sections/200766955-Troubleshooting
[2]: https://datadog.zendesk.com/hc/en-us
[3]: https://docs.datadoghq.com/help
[4]: https://docs.datadoghq.com/agent/troubleshooting/#send-a-flare
[5]: https://keepachangelog.com/en/1.0.0
[6]: https://datadoghq.slack.com
[7]: https://github.com/DataDog/integrations-extras
56 changes: 29 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Datadog Agent Integrations - Core

[![Build status][1]][2]
[![Build status][3]][4]
[![Coverage status][17]][18]
[![Documentation Status][19]][20]
[![Build status][2]][4]
[![Coverage status][3]][18]
[![Documentation Status][4]][20]

This repository contains the Agent Integrations (also known as checks) that Datadog
officially develops and supports. To add a new integration, please see the [Integrations Extras][5]
repository and the [accompanying documentation][6].

The [Datadog Agent][7] packages are equipped with all the Integrations from this
repository, so to get started using them, you can simply [install the Agent][8]
for your operating system. The [AGENT_CHANGELOG](AGENT_CHANGELOG.md) file shows
for your operating system. The [AGENT_CHANGELOG][9] file shows
which Integrations have been updated in each Agent version.

## Integrations as Python wheels
Expand All @@ -37,7 +37,7 @@ to idiomatic Python package delivery.

Working with integrations is easy, the main page of the [development docs][6]
contains all the info you need to get your dev environment up and running in minutes
to run, test and build a Check. More advanced API documentation can be found [here][20]
to run, test and build a Check. More advanced API documentation can be found [here][10]

## Reporting Issues

Expand All @@ -51,48 +51,50 @@ For those whom it may concern, the following is a list of GPG public key
fingerprints known to correspond to developers who, at the time of writing (Nov
20 2018), can trigger a build by signing a commit:

* [Christine Chen](https://api.github.com/users/ChristineTChen/gpg_keys)
* [Christine Chen][14]
* `57CE 2495 EA48 D456 B9C4 BA4F 66E8 2239 9141 D9D3`
* `36C0 82E7 38C7 B4A1 E169 11C0 D633 59C4 875A 1A9A`
* [Dave Coleman](https://api.github.com/users/dcoleman17/gpg_keys)
* [Dave Coleman][15]
* `8278 C406 C1BB F1F2 DFBB 5AD6 0AE7 E246 4F8F D375`
* `98A5 37CD CCA2 8DFF B35B 0551 5D50 0742 90F6 422F`
* [Hippolyte Henry](https://api.github.com/users/zippolyte/gpg_keys)
* [Hippolyte Henry][16]
* `87D5 2666 ECBF 2459 9D5A 594F F7AC E411 B85D 518C`
* `31EE F81D 7F71 6E35 83F2 4095 55D1 30B4 49D2 BD26`
* [Ofek Lev](https://api.github.com/users/ofek/gpg_keys)
* [Ofek Lev][17]
* `C295 CF63 B355 DFEB 3316 02F7 F426 A944 35BE 6F99`
* `D009 8861 8057 D2F4 D855 5A62 B472 442C B7D3 AF42`
* [Greg Meyer](https://api.github.com/users/gmmeyer/gpg_keys)
* [Greg Meyer][18]
* `989A 83AA 3C99 E86D DB9E EE69 598E 38E0 370E B759`
* `E145 39B1 BE48 615B FFE5 E7D2 4EA8 2631 E127 97FC`
* [Nicholas Muesch](https://api.github.com/users/nmuesch/gpg_keys)
* [Nicholas Muesch][19]
* `6E09 1A53 0468 B148 54BB 6CCE 831C 23C4 9BBE 61F8`
* `BACE F480 6D0B 4FBE D227 DC3B C0E2 8E5E 241E D25A`
* [Massimiliano Pippi](https://api.github.com/users/masci/gpg_keys)
* [Massimiliano Pippi][20]
* `BE9C 5131 8EED C03F E901 F256 C2C8 965F 07D0 A23D`
* `69CA DE35 4030 5312 54AF 170C 50A7 66D9 4DFC 27CC`
* [Greg Zussa](https://api.github.com/users/gzussa/gpg_keys)
* [Greg Zussa][21]
* `D24D 57CE 96BD F8C2 9BB0 BEAB C783 0ECB 08F8 8C74`
* `3936 7937 7466 5878 C67A 50E9 3C67 09D5 583F B57C`


[1]: https://api.travis-ci.com/DataDog/integrations-core.svg?branch=master
[2]: https://travis-ci.com/DataDog/integrations-core
[3]: https://ci.appveyor.com/api/projects/status/8w4s2bilp48n43gw?svg=true
[4]: https://ci.appveyor.com/project/Datadog/integrations-core
[2]: https://ci.appveyor.com/api/projects/status/8w4s2bilp48n43gw?svg=true
[3]: https://codecov.io/github/DataDog/integrations-core/coverage.svg?branch=master
[4]: https://readthedocs.org/projects/datadog-checks-base/badge/?version=latest
[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/
[9]: https://docs.pytest.org/en/latest/
[10]: https://packaging.python.org/tutorials/distributing-packages/
[8]: https://docs.datadoghq.com/agent
[9]: AGENT_CHANGELOG.md
[10]: https://datadog-checks-base.readthedocs.io/en/latest/?badge=latest
[11]: https://docs.datadoghq.com
[12]: https://help.datadoghq.com/hc/en-us
[13]: https://docs.datadoghq.com/help/
[15]: https://github.com/DataDog/integrations-core/blob/6.2.1/requirements-integration-core.txt
[16]: https://github.com/DataDog/integrations-core/blob/ea2dfbf1e8859333af4c8db50553eb72a3b466f9/requirements-agent-release.txt
[17]: https://codecov.io/github/DataDog/integrations-core/coverage.svg?branch=master
[18]: https://codecov.io/github/DataDog/integrations-core?branch=master
[19]: https://readthedocs.org/projects/datadog-checks-base/badge/?version=latest
[20]: https://datadog-checks-base.readthedocs.io/en/latest/?badge=latest

[13]: https://docs.datadoghq.com/help
[14]: https://api.github.com/users/ChristineTChen/gpg_keys
[15]: https://api.github.com/users/dcoleman17/gpg_keys
[16]: https://api.github.com/users/zippolyte/gpg_keys
[17]: https://api.github.com/users/ofek/gpg_keys
[18]: https://api.github.com/users/gmmeyer/gpg_keys
[19]: https://api.github.com/users/nmuesch/gpg_keys
[20]: https://api.github.com/users/masci/gpg_keys
[21]: https://api.github.com/users/gzussa/gpg_keys
10 changes: 6 additions & 4 deletions active_directory/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,25 @@

## 1.2.0 / 2018-10-12

* [Added] Pin pywin32 dependency. See [#2322](https://github.com/DataDog/integrations-core/pull/2322).
* [Added] Pin pywin32 dependency. See [#2322][1].

## 1.1.1 / 2018-09-04

* [Fixed] Add data files to the wheel package. See [#1727](https://github.com/DataDog/integrations-core/pull/1727).
* [Fixed] Add data files to the wheel package. See [#1727][2].

## 1.1.0 / 2018-05-11

* [FIX] Remove entry_points in setup.py
* [DOCUMENTATION] Fix broken link to sample configuration file
* [FIX] Moved conf.yaml to root of folder to ensure it is consistent and shipped with the wheel
* [FIX] Remove non-existent counters
* [SANITY] Clean-up import for `PDHBaseCheck` from `datadog-checks-base` wheel. [#1183][]
* [SANITY] Clean-up import for `PDHBaseCheck` from `datadog-checks-base` wheel. [#1183][3]

## 1.0.0 / 2017-12-15

* [FEATURE] adds Active Directory integration.

<!--- The following link definition list is generated by PimpMyChangelog --->
[#1183]: https://github.com/DataDog/integrations-core/issues/1183
[1]: https://github.com/DataDog/integrations-core/pull/2322
[2]: https://github.com/DataDog/integrations-core/pull/1727
[3]: https://github.com/DataDog/integrations-core/issues/1183
38 changes: 19 additions & 19 deletions active_directory/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Get metrics and logs from Microsoft Active Directory to visualize and monitor it

### Installation

The Agent's Active Directory check is included in the [Datadog Agent][4] package, so you don't need to install anything else on your servers.
The Agent's Active Directory check is included in the [Datadog Agent][1] package, so you don't need to install anything else on your servers.

### Configuration

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.
1. Edit the `active_directory.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][2] to start collecting your Active Directory performance data.

#### Metric collection

The default setup should already collect metrics for the localhost.
See the [sample active_directory.d/conf.yaml][1] for all available configuration options.
See the [sample active_directory.d/conf.yaml][3] for all available configuration options.

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

#### Log Collection

Expand All @@ -42,20 +42,20 @@ See the [sample active_directory.d/conf.yaml][1] for all available configuration
```

Change the `path` and `service` parameter values and configure them for your environment.
See the [sample active_directory.d/conf.yaml][1] for all available configuration options.
See the [sample active_directory.d/conf.yaml][3] for all available configuration options.

3. This integration is intended for the [Active Directory Module for Ruby][8]. If you are not using the Ruby module, change the below source value to `active_directory` and configure the `path` for your environment.
3. This integration is intended for the [Active Directory Module for Ruby][5]. If you are not using the Ruby module, change the below source value to `active_directory` and configure the `path` for your environment.

4. [Restart the Agent][7].
4. [Restart the Agent][4].

### Validation

[Run the Agent's `info` subcommand][2] and look for `active_directory` under the Checks section.
[Run the Agent's `info` subcommand][6] and look for `active_directory` under the Checks section.

## Data Collected

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

### Events
The Active Directory check does not include any events.
Expand All @@ -64,13 +64,13 @@ The Active Directory check does not include any events.
The Active Directory check does not include any service checks.

## Troubleshooting
Need help? Contact [Datadog support][5].

[1]: https://github.com/DataDog/integrations-core/blob/master/active_directory/datadog_checks/active_directory/data/conf.yaml.example
[2]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[3]: https://github.com/DataDog/integrations-core/blob/master/active_directory/metadata.csv
[4]: https://app.datadoghq.com/account/settings#agent
[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
Need help? Contact [Datadog support][8].

[1]: https://app.datadoghq.com/account/settings#agent
[2]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
[3]: https://github.com/DataDog/integrations-core/blob/master/active_directory/datadog_checks/active_directory/data/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[5]: https://www.rubydoc.info/gems/activedirectory/0.9.3
[6]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-core/blob/master/active_directory/metadata.csv
[8]: https://docs.datadoghq.com/help
10 changes: 6 additions & 4 deletions activemq/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@

## 1.1.0 / 2018-10-12

* [Added] [jmx] add rmi registry ssl config option. See [#2371](https://github.com/DataDog/integrations-core/pull/2371).
* [Added] [jmx] add rmi registry ssl config option. See [#2371][1].

## 1.0.2 / 2018-09-04

* [Fixed] Add data files to the wheel package. See [#1727](https://github.com/DataDog/integrations-core/pull/1727).
* [Fixed] Add data files to the wheel package. See [#1727][2].

## 1.0.1 / 2017-11-21

* [IMPROVEMENT] Added `metrics.yaml` file. See [#863][]
* [IMPROVEMENT] Added `metrics.yaml` file. See [#863][3]

## 1.0.0 / 2017-03-22

* [FEATURE] adds activemq integration.

<!--- The following link definition list is generated by PimpMyChangelog --->
[#863]: https://github.com/DataDog/integrations-core/issues/863
[1]: https://github.com/DataDog/integrations-core/pull/2371
[2]: https://github.com/DataDog/integrations-core/pull/1727
[3]: https://github.com/DataDog/integrations-core/issues/863
50 changes: 25 additions & 25 deletions activemq/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

The ActiveMQ check collects metrics for brokers and queues, producers and consumers, and more.

**Note**: If you are running a ActiveMQ version older than 5.8.0, see the [Agent 5.10.x released sample files][110].
**Note**: If you are running a ActiveMQ version older than 5.8.0, see the [Agent 5.10.x released sample files][1].

## Setup
### Installation

The Agent's ActiveMQ check is included in the [Datadog Agent][101] package, so you don't need to install anything else on your ActiveMQ nodes.
The Agent's ActiveMQ check is included in the [Datadog Agent][2] package, so you don't need to install anything else on your ActiveMQ nodes.

The check collects metrics via JMX, so you need a JVM on each node so the Agent can fork [jmxfetch][102]. We recommend using an Oracle-provided JVM.
The check collects metrics via JMX, so you need a JVM on each node so the Agent can fork [jmxfetch][3]. We recommend using an Oracle-provided JVM.

### 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`, 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.
1. **Make sure that [JMX Remote is enabled][4] on your ActiveMQ server.**
2. Configure the agent to connect to ActiveMQ. Edit `activemq.d/conf.yaml`, in the `conf.d/` folder at the root of your [Agent's configuration directory][5]. See the [sample activemq.d/conf.yaml][6] for all available configuration options.

```yaml
instances:
Expand Down Expand Up @@ -83,15 +83,15 @@ The check collects metrics via JMX, so you need a JVM on each node so the Agent
metric_type: gauge
```
3. [Restart the agent][109]
3. [Restart the agent][7]
### Validation
[Run the Agent's `status` subcommand][105] and look for `activemq` under the Checks section.
[Run the Agent's `status` subcommand][8] and look for `activemq` under the Checks section.

## Data Collected
### Metrics
See [metadata.csv][112] for a list of metrics provided by this integration.
See [metadata.csv][9] for a list of metrics provided by this integration.

### Events
The ActiveMQ check does not include any events.
Expand All @@ -101,24 +101,24 @@ The ActiveMQ check does not include any events.
Returns `CRITICAL` if the Agent is unable to connect to and collect metrics from the monitored ActiveMQ instance. Returns `OK` otherwise.

## Troubleshooting
Need help? Contact [Datadog support][107].
Need help? Contact [Datadog support][10].

## Further Reading
Additional helpful documentation, links, and articles:

* [ActiveMQ architecture and key metrics][113]
* [Monitor ActiveMQ metrics and performance][108]


[101]: https://app.datadoghq.com/account/settings#agent
[102]: https://github.com/DataDog/jmxfetch
[103]: https://activemq.apache.org/jmx.html
[104]: https://github.com/DataDog/integrations-core/blob/master/activemq/datadog_checks/activemq/data/conf.yaml.example
[105]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[107]: https://docs.datadoghq.com/help/
[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
[112]: https://github.com/DataDog/integrations-core/blob/master/activemq/metadata.csv
[113]: https://www.datadoghq.com/blog/activemq-architecture-and-metrics/
* [ActiveMQ architecture and key metrics][11]
* [Monitor ActiveMQ metrics and performance][12]


[1]: https://raw.githubusercontent.com/DataDog/dd-agent/5.10.1/conf.d/activemq.yaml.example
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://github.com/DataDog/jmxfetch
[4]: https://activemq.apache.org/jmx.html
[5]: https://docs.datadoghq.com/agent/faq/agent-configuration-files/#agent-configuration-directory
[6]: https://github.com/DataDog/integrations-core/blob/master/activemq/datadog_checks/activemq/data/conf.yaml.example
[7]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[8]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[9]: https://github.com/DataDog/integrations-core/blob/master/activemq/metadata.csv
[10]: https://docs.datadoghq.com/help
[11]: https://www.datadoghq.com/blog/activemq-architecture-and-metrics
[12]: https://www.datadoghq.com/blog/monitor-activemq-metrics-performance
6 changes: 4 additions & 2 deletions activemq_xml/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

## 1.1.0 / 2018-11-30

* [Added] Add Python3 Support. See [#2583](https://github.com/DataDog/integrations-core/pull/2583).
* [Added] Add Python3 Support. See [#2583][1].

## 1.0.1 / 2018-09-04

* [Fixed] Add data files to the wheel package. See [#1727](https://github.com/DataDog/integrations-core/pull/1727).
* [Fixed] Add data files to the wheel package. See [#1727][2].

## 1.0.0 / 2017-03-22

* [FEATURE] adds activemq_xml integration.
[1]: https://github.com/DataDog/integrations-core/pull/2583
[2]: https://github.com/DataDog/integrations-core/pull/1727
Loading

0 comments on commit b66de4d

Please sign in to comment.