fixed typos and added more info

diff --git a/conf.d/health_alarm_notify.conf b/conf.d/health_alarm_notify.conf
index 76359759ad61313f302dab820fd523bc5bf2c682..eb019f7bf53fa4f92f64eccc60604de7537f6c7d 100644 (file)
--- a/conf.d/health_alarm_notify.conf
+++ b/conf.d/health_alarm_notify.conf
@@ -1,25 +1,25 @@
 # Configuration for alarm notifications
 #
-# this configuration is used by: alarm-notify.sh
-# changes take effect immendiately (the next alarm will use them).
+# This configuration is used by: alarm-notify.sh
+# changes take effect immediately (the next alarm will use them).
 #
 # alarm-notify.sh can send:
-# - e-mails,
-# - push notifications to your mobile phone,
-# - messages to your slack team
-# - messages to your telegram chat / group chat
+# - e-mails (using the sendmail command),
+# - push notifications to your mobile phone (pushover.net),
+# - messages to your slack team (slack.com),
+# - messages to your telegram chat / group chat (telegram.org)
 #
-# the recipient given in netdata alarms defines a role, so that different
+# The 'to' line given at netdata alarms defines a *role*, so that many
 # people can be notified for each role.
 #
 # This file is a BASH script itself.
-
-
+#
+#
 ###############################################################################
 # proxy configuration
-
-# if you need to send curl based notifications (pushover, slack) via a proxy
-# set these:
+#
+# if you need to send curl based notifications (pushover, slack, telegram)
+# via a proxy, set these to your proxy address:
 #export http_proxy="http://10.0.0.1:3128/"
 #export https_proxy="http://10.0.0.1:3128/"
 
@@ -29,18 +29,19 @@
 
 # The full path to the sendmail command.
 # If empty, the system $PATH will be searched for it.
-# If not found, email notifications will be disabled.
+# If not found, email notifications will be disabled (silently).
 sendmail=""
 
 # The full path of the curl command.
 # If empty, the system $PATH will be searched for it.
-# If not found, pushover, telegram and slack notifications will be disabled.
+# If not found, pushover, telegram and slack notifications will be
+# silently disabled.
 curl=""
 
 
 ###############################################################################
-# RECIPIENT ATTRIBUTES
-
+# NOTE ABOUT RECIPIENTS
+#
 # When you define recipients (all types):
 #
 #  - emails addresses
@@ -52,6 +53,7 @@ curl=""
 #
 # In these examples, the first recipient receives all the alarms
 # while the second one receives only the critical ones:
+#
 #  email   : "user1@example.com user2@example.com|critical"
 #  pushover: "2987343...9437837 8756278...2362736|critical"
 #  telegram: "111827421 112746832|critical"
@@ -62,10 +64,11 @@ curl=""
 # To disable a notification, use the recipient called: disabled
 # This works for all notification methods (including the default recipients).
 
+
 ###############################################################################
-# sending emails
+# email global notification options
 
-# note: multiple recipients can be given like this:
+# multiple recipients can be given like this:
 #              "admin1@example.com admin2@example.com ..."
 
 # enable/disable sending emails
@@ -73,33 +76,35 @@ SEND_EMAIL="YES"
 
 # if a role recipient is not configured, an email will be send to:
 DEFAULT_RECIPIENT_EMAIL="root"
-# to recieve only critical alarms, set it to "root|critical"
+# to receive only critical alarms, set it to "root|critical"
 
 
 ###############################################################################
-# sending pushover notifications (pushover.net)
+# pushover (pushover.net) global notification options
 
-# note: multiple recipients can be given like this:
+# multiple recipients can be given like this:
 #                  "USERTOKEN1 USERTOKEN2 ..."
 
 # enable/disable sending pushover notifications
 SEND_PUSHOVER="YES"
 
-# Login to pushover.net to get your pushover app token
-# You need only one for all your netdata servers.
-# Without it, netdata cannot send pushover notifications.
+# Login to pushover.net to get your pushover app token.
+# You need only one for all your netdata servers (or you can have one for
+# each of your netdata - your call).
+# Without an app token, netdata cannot send pushover notifications.
 PUSHOVER_APP_TOKEN=""
 
 # if a role's recipients are not configured, a notification will be send to
-# this pushover user token:
+# this pushover user token (empty = do not send a notification for unconfigured
+# roles):
 DEFAULT_RECIPIENT_PUSHOVER=""
 
 
 ###############################################################################
-# sending telegram messages (telegram.org)
+# telegram (telegram.org) global notification options
 
 # To get your chat ID send the command /my_id to telegram bot @get_id.
-# Users also need to open a query with the bot.
+# Users also need to open a query with the bot (see below).
 
 # note: multiple recipients can be given like this:
 #                  "CHAT_ID_1 CHAT_ID_1 ..."
@@ -107,31 +112,33 @@ DEFAULT_RECIPIENT_PUSHOVER=""
 # enable/disable sending telegram messages
 SEND_TELEGRAM="YES"
 
-# Contact the bot @BotFather to create a new bot and to receive a bot token.
+# Contact the bot @BotFather to create a new bot and receive a bot token.
 # Without it, netdata cannot send telegram messages.
 TELEGRAM_BOT_TOKEN=""
 
-# If a role's recipients are not configured, a message will be send to this chat id:
+# If a role's recipients are not configured, a message will be send to
+# this chat id (empty = do not send a notification for unconfigured roles):
 DEFAULT_RECIPIENT_TELEGRAM=""
 
 
 ###############################################################################
-# sending slack notifications
+# slack (slack.com) global notification options
 
-# note: multiple recipients can be given like this:
+# multiple recipients can be given like this:
 #                  "CHANNEL1 CHANNEL2 ..."
 
-# enable/disable sending pushover notifications
+# enable/disable sending slack notifications
 SEND_SLACK="YES"
 
-# Login to slack.com and create an incoming webhook.
-# You need only one for all your netdata servers.
+# Login to slack.com and create an incoming webhook. You need only one for all
+# your netdata servers (or you can have one for each of your netdata).
 # Without it, netdata cannot send slack notifications.
 # Get yours from: https://api.slack.com/incoming-webhooks
 SLACK_WEBHOOK_URL=""
 
 # if a role's recipients are not configured, a notification will be send to
-# this slack channel:
+# this slack channel (empty = do not send a notification for unconfigured
+# roles):
 DEFAULT_RECIPIENT_SLACK=""
 
 
@@ -140,7 +147,7 @@ DEFAULT_RECIPIENT_SLACK=""
 
 # -----------------------------------------------------------------------------
 # generic system alarms
-# CPU, disks, entropy, etc
+# CPU, disks, network interfaces, entropy, etc
 
 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"