Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix hyperlinks in Datadog documentation #380

Merged
merged 2 commits into from
Jul 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
- [Docs] Added Chatwork proxy settings to documentation - [#360](https://github.com/jertel/elastalert2/pull/360) - @nsano-rururu
- Add settings to schema.yaml(Chatwork proxy, Dingtalk proxy) - [#361](https://github.com/jertel/elastalert2/pull/361) - @nsano-rururu
- [Docs] Tidy Twilio alerter documentation - [#363](https://github.com/jertel/elastalert2/pull/363) - @ferozsalam
- [Docs] Tidy Datadog alerter documentation - [#380](https://github.com/jertel/elastalert2/pull/380) - @ferozsalam
- [Tests] Improve opsgenie test code coverage - [#364](https://github.com/jertel/elastalert2/pull/364) - @nsano-rururu
- [Docs] Update mentions of JIRA to Jira - [#365](https://github.com/jertel/elastalert2/pull/365) - @ferozsalam

Expand Down
10 changes: 7 additions & 3 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1774,14 +1774,14 @@ Example usage using new-style format::
Datadog
~~~~~~~

This alert will create a [Datadog Event](https://docs.datadoghq.com/events/). Events are limited to 4000 characters. If an event is sent that contains
This alert will create a `Datadog Event`_. Events are limited to 4000 characters. If an event is sent that contains
a message that is longer than 4000 characters, only his first 4000 characters will be displayed.

This alert requires two additional options:

``datadog_api_key``: [Datadog API key](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys)
``datadog_api_key``: `Datadog API key`_

``datadog_app_key``: [Datadog application key](https://docs.datadoghq."com/account_management/api-app-keys/#application-keys)
``datadog_app_key``: `Datadog application key`_

Example usage::

Expand All @@ -1790,6 +1790,10 @@ Example usage::
datadog_api_key: "Datadog API Key"
datadog_app_key: "Datadog APP Key"

.. _`Datadog Event`: https://docs.datadoghq.com/events/
.. _`Datadog API key`: https://docs.datadoghq.com/account_management/api-app-keys/#api-keys
.. _`Datadog application key`: https://docs.datadoghq.com/account_management/api-app-keys/#application-keys

Debug
~~~~~

Expand Down