fixed typos and added more info
Costa Tsaousis (ktsaou) committed
Sep 28, 2016 at 22:54 UTC
7425e47e964a278477f53f77f977c2e12dcf5624
1 file changed
+43
-36
conf.d/health_alarm_notify.conf
+43
-36
@@ -1,25 +1,25 @@
1
# Configuration for alarm notifications
2
#
3
-# this configuration is used by: alarm-notify.sh
4
-# changes take effect immendiately (the next alarm will use them).
3
+# This configuration is used by: alarm-notify.sh
4
+# changes take effect immediately (the next alarm will use them).
5
#
6
# alarm-notify.sh can send:
7
-# - e-mails,
8
-# - push notifications to your mobile phone,
9
-# - messages to your slack team
10
-# - messages to your telegram chat / group chat
7
+# - e-mails (using the sendmail command),
8
+# - push notifications to your mobile phone (pushover.net),
9
+# - messages to your slack team (slack.com),
10
+# - messages to your telegram chat / group chat (telegram.org)
11
#
12
-# the recipient given in netdata alarms defines a role, so that different
12
+# The 'to' line given at netdata alarms defines a *role*, so that many
13
# people can be notified for each role.
14
#
15
# This file is a BASH script itself.
16
-
17
-
16
+#
17
+#
18
###############################################################################
19
# proxy configuration
20
-
21
-# if you need to send curl based notifications (pushover, slack) via a proxy
22
-# set these:
20
+#
21
+# if you need to send curl based notifications (pushover, slack, telegram)
22
+# via a proxy, set these to your proxy address:
23
#export http_proxy="http://10.0.0.1:3128/"
24
#export https_proxy="http://10.0.0.1:3128/"
25
@@ -29,18 +29,19 @@
29
30
# The full path to the sendmail command.
31
# If empty, the system $PATH will be searched for it.
32
-# If not found, email notifications will be disabled.
32
+# If not found, email notifications will be disabled (silently).
33
sendmail=""
34
35
# The full path of the curl command.
36
# If empty, the system $PATH will be searched for it.
37
-# If not found, pushover, telegram and slack notifications will be disabled.
37
+# If not found, pushover, telegram and slack notifications will be
38
+# silently disabled.
39
curl=""
40
41
42
###############################################################################
42
-# RECIPIENT ATTRIBUTES
43
-
43
+# NOTE ABOUT RECIPIENTS
44
+#
45
# When you define recipients (all types):
46
#
47
# - emails addresses
@@ -52,6 +53,7 @@ curl=""
53
#
54
# In these examples, the first recipient receives all the alarms
55
# while the second one receives only the critical ones:
56
+#
57
# email : "user1@example.com user2@example.com|critical"
58
# pushover: "2987343...9437837 8756278...2362736|critical"
59
# telegram: "111827421 112746832|critical"
@@ -62,10 +64,11 @@ curl=""
64
# To disable a notification, use the recipient called: disabled
65
# This works for all notification methods (including the default recipients).
66
67
+
68
###############################################################################
66
-# sending emails
69
+# email global notification options
70
68
-# note: multiple recipients can be given like this:
71
+# multiple recipients can be given like this:
72
# "admin1@example.com admin2@example.com ..."
73
74
# enable/disable sending emails
@@ -73,33 +76,35 @@ SEND_EMAIL="YES"
76
77
# if a role recipient is not configured, an email will be send to:
78
DEFAULT_RECIPIENT_EMAIL="root"
76
-# to recieve only critical alarms, set it to "root|critical"
79
+# to receive only critical alarms, set it to "root|critical"
80
81
82
###############################################################################
80
-# sending pushover notifications (pushover.net)
83
+# pushover (pushover.net) global notification options
84
82
-# note: multiple recipients can be given like this:
85
+# multiple recipients can be given like this:
86
# "USERTOKEN1 USERTOKEN2 ..."
87
88
# enable/disable sending pushover notifications
89
SEND_PUSHOVER="YES"
90
88
-# Login to pushover.net to get your pushover app token
89
-# You need only one for all your netdata servers.
90
-# Without it, netdata cannot send pushover notifications.
91
+# Login to pushover.net to get your pushover app token.
92
+# You need only one for all your netdata servers (or you can have one for
93
+# each of your netdata - your call).
94
+# Without an app token, netdata cannot send pushover notifications.
95
PUSHOVER_APP_TOKEN=""
96
97
# if a role's recipients are not configured, a notification will be send to
94
-# this pushover user token:
98
+# this pushover user token (empty = do not send a notification for unconfigured
99
+# roles):
100
DEFAULT_RECIPIENT_PUSHOVER=""
101
102
103
###############################################################################
99
-# sending telegram messages (telegram.org)
104
+# telegram (telegram.org) global notification options
105
106
# To get your chat ID send the command /my_id to telegram bot @get_id.
102
-# Users also need to open a query with the bot.
107
+# Users also need to open a query with the bot (see below).
108
109
# note: multiple recipients can be given like this:
110
# "CHAT_ID_1 CHAT_ID_1 ..."
@@ -107,31 +112,33 @@ DEFAULT_RECIPIENT_PUSHOVER=""
112
# enable/disable sending telegram messages
113
SEND_TELEGRAM="YES"
114
110
-# Contact the bot @BotFather to create a new bot and to receive a bot token.
115
+# Contact the bot @BotFather to create a new bot and receive a bot token.
116
# Without it, netdata cannot send telegram messages.
117
TELEGRAM_BOT_TOKEN=""
118
114
-# If a role's recipients are not configured, a message will be send to this chat id:
119
+# If a role's recipients are not configured, a message will be send to
120
+# this chat id (empty = do not send a notification for unconfigured roles):
121
DEFAULT_RECIPIENT_TELEGRAM=""
122
123
124
###############################################################################
119
-# sending slack notifications
125
+# slack (slack.com) global notification options
126
121
-# note: multiple recipients can be given like this:
127
+# multiple recipients can be given like this:
128
# "CHANNEL1 CHANNEL2 ..."
129
124
-# enable/disable sending pushover notifications
130
+# enable/disable sending slack notifications
131
SEND_SLACK="YES"
132
127
-# Login to slack.com and create an incoming webhook.
128
-# You need only one for all your netdata servers.
133
+# Login to slack.com and create an incoming webhook. You need only one for all
134
+# your netdata servers (or you can have one for each of your netdata).
135
# Without it, netdata cannot send slack notifications.
136
# Get yours from: https://api.slack.com/incoming-webhooks
137
SLACK_WEBHOOK_URL=""
138
139
# if a role's recipients are not configured, a notification will be send to
134
-# this slack channel:
140
+# this slack channel (empty = do not send a notification for unconfigured
141
+# roles):
142
DEFAULT_RECIPIENT_SLACK=""
143
144
@@ -140,7 +147,7 @@ DEFAULT_RECIPIENT_SLACK=""
147
148
# -----------------------------------------------------------------------------
149
# generic system alarms
143
-# CPU, disks, entropy, etc
150
+# CPU, disks, network interfaces, entropy, etc
151
152
role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
153