Adding upstream version 1.39.0.upstream/1.39.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 47 insertions, 32 deletions

diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md
index 014301985..6b96c0d96 100644
--- a/health/notifications/messagebird/README.md
+++ b/health/notifications/messagebird/README.md
@@ -1,50 +1,65 @@
-<!--
-title: "Messagebird"
-sidebar_label: "Messagebird"
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md"
-learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Setup/Notification/Agent"
-learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
--->
+# MessageBird Agent alert notifications
 
-# Messagebird
+Learn how to send notifications to MessageBird using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
 
-The messagebird notifications will look like this on your Android device:
+> ### Note
+>
+> This file assumes you have read the [Introduction to Agent alert notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md), detailing how the Netdata Agent's alert notification method works.
 
-![image](https://cloud.githubusercontent.com/assets/17090999/20034652/620b6100-a39b-11e6-96af-4f83b8e830e2.png)
+This is what you will get:
+
+![image](https://user-images.githubusercontent.com/70198089/229841323-6c4b1956-dd91-423e-abaf-2799000f72a8.png)
+
+## Prerequisites
 
 You will need:
 
-1.  Signup and Login to messagebird.com
-2.  Pick an SMS capable number after sign up to get some free credits
-3.  Go to <https://www.messagebird.com/app/settings/developers/access>
-4.  Create a new access key under 'API ACCESS (REST)' (you will want a live key)
-5.  Fill in MESSAGEBIRD_ACCESS_KEY="XXXXXXXX" MESSAGEBIRD_NUMBER="+XXXXXXXXXXX"
-6.  Add the recipient phone numbers to DEFAULT_RECIPIENT_MESSAGEBIRD="+XXXXXXXXXXX"
+- an access key under 'API ACCESS (REST)' (you will want a live key), you can read more [here](https://developers.messagebird.com/quickstarts/sms/test-credits-api-keys/)
+- terminal access to the Agent you wish to configure
+
+## Configure Netdata to send alert notifications to MessageBird
+
+> ### Info
+>
+> This file mentions editing configuration files.  
+>
+> - To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.  
+> Note that to run the script you need to be inside your Netdata config directory.
+>
+> It is recommended to use this way for configuring Netdata.
+
+Edit `health_alarm_notify.conf`, changes to this file do not require restarting Netdata:
+
+1. Set `SEND_MESSAGEBIRD` to `YES`.
+2. Set `MESSAGEBIRD_ACCESS_KEY` to your API access key.
+3. Set `MESSAGEBIRD_NUMBER` to the MessageBird number you want to use for the alert.
+4. Set `DEFAULT_RECIPIENT_MESSAGEBIRD` to the number you want the alert notification to be sent as an SMS.  
+  You can define multiple recipients like this: `+15555555555 +17777777777`.  
+  All roles will default to this variable if left unconfigured.
 
-Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
+You can then have different recipients per **role**, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file:
 
+```conf
+role_recipients_messagebird[sysadmin]="+15555555555"
+role_recipients_messagebird[domainadmin]="+15555555556"
+role_recipients_messagebird[dba]="+15555555557"
+role_recipients_messagebird[webmaster]="+15555555558"
+role_recipients_messagebird[proxyadmin]="+15555555559"
+role_recipients_messagebird[sitemgr]="+15555555550"
 ```
+
+An example of a working configuration would be:
+
+```conf
 #------------------------------------------------------------------------------
 # Messagebird (messagebird.com) SMS options
 
-# multiple recipients can be given like this:
-#                  "+15555555555 +17777777777"
-
-# enable/disable sending messagebird SMS
 SEND_MESSAGEBIRD="YES"
-
-# to get an access key, create a free account at https://www.messagebird.com
-# verify and activate the account (no CC info needed)
-# login to your account and enter your phonenumber to get some free credits
-# to get the API key, click on 'API' in the sidebar, then 'API Access (REST)' 
-# click 'Add access key' and fill in data (you want a live key to send SMS)
-
-# Without an access key, Netdata cannot send Messagebird text messages.
 MESSAGEBIRD_ACCESS_KEY="XXXXXXXX"
 MESSAGEBIRD_NUMBER="XXXXXXX"
-DEFAULT_RECIPIENT_MESSAGEBIRD="XXXXXXX"
+DEFAULT_RECIPIENT_MESSAGEBIRD="+15555555555"
 ```
 
+## Test the notification method
 
+To test this alert notification method refer to the ["Testing Alert Notifications"](https://github.com/netdata/netdata/blob/master/health/notifications/README.md#testing-alert-notifications) section of the Agent alert notifications page.