From 6dbc752c0d51ef97697898fbff9ecb8f9905e4ec Mon Sep 17 00:00:00 2001 From: Feroz Salam Date: Sun, 26 Sep 2021 07:16:21 +0100 Subject: [PATCH 1/2] Tidy Exotel alerter docs --- docs/source/ruletypes.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/source/ruletypes.rst b/docs/source/ruletypes.rst index f78679a7..1f1fb883 100644 --- a/docs/source/ruletypes.rst +++ b/docs/source/ruletypes.rst @@ -1986,32 +1986,33 @@ Example assets_dir, email_image_keys, email_image_values:: Exotel ~~~~~~ -Developers in India can use Exotel alerter, it will trigger an incident to a mobile phone as sms from your exophone. Alert name along with the message body will be sent as an sms. +Developers in India can use the Exotel alerter, which can send an alert to a mobile phone as an SMS from your ExoPhone. The SMS will contain both the alert name and the specified message body. The alerter requires the following option: -``exotel_account_sid``: This is sid of your Exotel account. +``exotel_account_sid``: The SID of your Exotel account. -``exotel_auth_token``: Auth token assosiated with your Exotel account. +``exotel_auth_token``: The auth token associated with your Exotel account. -If you don't know how to find your accound sid and auth token, refer - https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-exotel-token-and-exotel-sid +Instructions for finding the SID and auth token associated with your account can be found `on the Exotel website +`_. -``exotel_to_number``: The phone number where you would like send the notification. +``exotel_to_number``: The phone number to which you would like to send the alert. -``exotel_from_number``: Your exophone number from which message will be sent. +``exotel_from_number``: The ExoPhone number from which the alert will be sent. The alerter has one optional argument: -``exotel_message_body``: Message you want to send in the sms, is you don't specify this argument only the rule name is sent +``exotel_message_body``: The contents of the SMS. If you don't specify this argument, only the rule name is sent. Example usage:: alert: - "exotel" - exotel_account_sid: "Exotel Account sid" + exotel_account_sid: "Exotel Account SID" exotel_auth_token: "Exotel Auth token" - exotel_to_number: "Exotel to Number" - exotel_from_number: "Exotel from Numbeer" + exotel_to_number: "Exotel to number" + exotel_from_number: "Exotel from number" Gitter ~~~~~~ From 10f8cb9a6d8627967f3b6d26792eeb2babe12f8c Mon Sep 17 00:00:00 2001 From: Feroz Salam Date: Sun, 26 Sep 2021 07:20:46 +0100 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 152b64a8..bdb84ac6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ - [OpsGenie] Clarify documentation for URL endpoint to use in European region - [#475](https://github.com/jertel/elastalert2/pull/475) - @nsano-rururu - [Docs] The documentation has been updated as the name of Amazon Elasticsearch Service has changed to Amazon OpenSearch Service. - [#478](https://github.com/jertel/elastalert2/pull/478) - @nsano-rururu - [Tests] Improve test coverage of tencentsms.py - [#479](https://github.com/jertel/elastalert2/pull/479) - @liuxingjun +- [Docs] Tidy Exotel documentation - [#488](https://github.com/jertel/elastalert2/pull/488) - @ferozsalam # 2.2.1