From baa92c37ab0bd33858a35e0447882c1a7ae965fa Mon Sep 17 00:00:00 2001 From: Feroz Salam Date: Sat, 24 Jul 2021 08:06:34 +0100 Subject: [PATCH 1/2] Tidy Twilio documentation --- docs/source/ruletypes.rst | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/source/ruletypes.rst b/docs/source/ruletypes.rst index bf0fee52..73161a53 100644 --- a/docs/source/ruletypes.rst +++ b/docs/source/ruletypes.rst @@ -2859,28 +2859,32 @@ Example usage:: Twilio ~~~~~~ -Twilio alerter will trigger an incident to a mobile phone as an sms from your twilio phone number. The sms will contain the alert name. You may use either twilio SMS or twilio copilot -to send the message, controlled by the ``twilio_use_copilot`` option. +The Twilio alerter will send an alert to a mobile phone as an SMS from your Twilio +phone number. The SMS will contain the alert name. You may use either Twilio SMS +or Twilio Copilot to send the message, controlled by the ``twilio_use_copilot`` +option. -Note that when twilio copilot *is* used the ``twilio_message_service_sid`` option is required. Likewise, when *not* using twilio copilot, the ``twilio_from_number`` option is required. +Note that when Twilio Copilot *is* used the ``twilio_message_service_sid`` +option is required. Likewise, when *not* using Twilio Copilot, the +``twilio_from_number`` option is required. The alerter requires the following options: -``twilio_account_sid``: This is sid of your twilio account. +``twilio_account_sid``: The SID of your Twilio account. -``twilio_auth_token``: Auth token assosiated with your twilio account. +``twilio_auth_token``: Auth token associated with your Twilio account. -``twilio_to_number``: The phone number where you would like send the notification. +``twilio_to_number``: The phone number where you would like to send the alert. Either one of - * ``twilio_from_number``: Your twilio phone number from which message will be sent. - * ``twilio_message_service_sid``: The SID of your twilio message service. + * ``twilio_from_number``: The Twilio phone number from which the alert will be sent. + * ``twilio_message_service_sid``: The SID of your Twilio message service. Optional: -``twilio_use_copilot``: Whether or not to use twilio copilot, False by default. +``twilio_use_copilot``: Whether or not to use Twilio Copilot, False by default. -Example With Copilot usage:: +Example with Copilot usage:: alert: - "twilio" @@ -2890,7 +2894,7 @@ Example With Copilot usage:: twilio_account_sid: "ABCDEFGHIJKLMNOPQRSTUVWXYZ01234567" twilio_message_service_sid: "ABCDEFGHIJKLMNOPQRSTUVWXYZ01234567" -Example With SMS usage:: +Example with SMS usage:: alert: - "twilio" From 8b43b8e1cb7072be962d1534a46661608849f933 Mon Sep 17 00:00:00 2001 From: Feroz Salam Date: Sat, 24 Jul 2021 08:30:22 +0100 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4c54aa5..6eb4717e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ - [Tests] Add test code. Changed ubuntu version of Dockerfile-test from latest to 21.10. - [#354](https://github.com/jertel/elastalert2/pull/354) - @nsano-rururu - Remove Python 2.x compatibility code - [#354](https://github.com/jertel/elastalert2/pull/354) - @nsano-rururu - [Docs] Added Chatwork proxy settings to documentation - [#360](https://github.com/jertel/elastalert2/pull/360) - @nsano-rururu +- [Docs] Tidy Twilio alerter documentation - [#363](https://github.com/jertel/elastalert2/pull/363) - @ferozsalam - Add settings to schema.yaml(Chatwork proxy, Dingtalk proxy) - [#361](https://github.com/jertel/elastalert2/pull/361) - @nsano-rururu # 2.1.2