1 # Configuration for alarm notifications
3 # This configuration is used by: alarm-notify.sh
4 # changes take effect immediately (the next alarm will use them).
6 # alarm-notify.sh can send:
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 # - sms messages to your cell phone or any sms enabled device (twilio.com)
13 # The 'to' line given at netdata alarms defines a *role*, so that many
14 # people can be notified for each role.
16 # This file is a BASH script itself.
19 #------------------------------------------------------------------------------
22 # If you need to send curl based notifications (pushover, pushbullet, slack,
23 # telegram) via a proxy, set these to your proxy address:
24 #export http_proxy="http://10.0.0.1:3128/"
25 #export https_proxy="http://10.0.0.1:3128/"
28 #------------------------------------------------------------------------------
29 # notifications images
31 # Images in notifications need to be downloaded from an Internet facing site.
32 # To allow notification providers fetch the icons/images, by default we set
33 # the URL of the global public netdata registry.
34 # If you have an Internet facing netdata (or you have copied the images/ folder
35 # of netdata to your web server), set its URL here, to fetch the notification
37 #images_base_url="http://my.public.netdata.server:19999"
40 #------------------------------------------------------------------------------
43 # The full path to the sendmail command.
44 # If empty, the system $PATH will be searched for it.
45 # If not found, email notifications will be disabled (silently).
48 # The full path of the curl command.
49 # If empty, the system $PATH will be searched for it.
50 # If not found, pushover, telegram and slack notifications will be
55 #------------------------------------------------------------------------------
56 # NOTE ABOUT RECIPIENTS
58 # When you define recipients (all types):
61 # - pushover user tokens
66 # You can append |critical to limit the notifications to be sent.
68 # In these examples, the first recipient receives all the alarms
69 # while the second one receives only the critical ones:
71 # email : "user1@example.com user2@example.com|critical"
72 # pushover: "2987343...9437837 8756278...2362736|critical"
73 # telegram: "111827421 112746832|critical"
74 # slack : "alarms disasters|critical"
75 # twilio : "+15555555555 +17777777777|critical"
77 # If a recipient is set to empty string, the default recipient of the given
78 # notification method (email, pushover, telegram, slack) will be used.
79 # To disable a notification, use the recipient called: disabled
80 # This works for all notification methods (including the default recipients).
83 #------------------------------------------------------------------------------
84 # email global notification options
86 # multiple recipients can be given like this:
87 # "admin1@example.com admin2@example.com ..."
89 # enable/disable sending emails
92 # if a role recipient is not configured, an email will be send to:
93 DEFAULT_RECIPIENT_EMAIL="root"
94 # to receive only critical alarms, set it to "root|critical"
97 #------------------------------------------------------------------------------
98 # pushover (pushover.net) global notification options
100 # multiple recipients can be given like this:
101 # "USERTOKEN1 USERTOKEN2 ..."
103 # enable/disable sending pushover notifications
106 # Login to pushover.net to get your pushover app token.
107 # You need only one for all your netdata servers (or you can have one for
108 # each of your netdata - your call).
109 # Without an app token, netdata cannot send pushover notifications.
110 PUSHOVER_APP_TOKEN=""
112 # if a role's recipients are not configured, a notification will be send to
113 # this pushover user token (empty = do not send a notification for unconfigured
115 DEFAULT_RECIPIENT_PUSHOVER=""
118 #------------------------------------------------------------------------------
119 # pushbullet (pushbullet.com) push notification options
121 # multiple recipients can be given like this:
122 # "user1@email.com user2@mail.com"
124 # enable/disable sending pushbullet notifications
125 SEND_PUSHBULLET="YES"
127 # Signup and Login to pushbullet.com
128 # To get your Access Token, go to https://www.pushbullet.com/#settings/account
129 # Create a new access token and paste it below.
130 # Then just set the recipients' emails.
131 # Please note that the if the email in the DEFAULT_RECIPIENT_PUSHBULLET does
132 # not have a pushbullet account, the pushbullet service will send an email
133 # to that address instead.
135 # Without an access token, netdata cannot send pushbullet notifications.
136 PUSHBULLET_ACCESS_TOKEN=""
137 DEFAULT_RECIPIENT_PUSHBULLET=""
139 #------------------------------------------------------------------------------
140 # Twilio (twilio.com) SMS options
142 # multiple recipients can be given like this:
143 # "+15555555555 +17777777777"
145 # enable/disable sending twilio SMS
148 # Signup for free trial and select a SMS capable Twilio Number
149 # To get your Account SID and Token, go to https://www.twilio.com/console
150 # Place your sid, token and number below.
151 # Then just set the recipients' phone numbers.
152 # The trial account is only allowed to use the number specified when set up.
154 # Without an account sid and token, netdata cannot send Twilio text messages.
155 TWILIO_ACCOUNT_SID=""
156 TWILIO_ACCOUNT_TOKEN=""
158 DEFAULT_RECIPIENT_TWILIO=""
160 #------------------------------------------------------------------------------
161 # telegram (telegram.org) global notification options
163 # To get your chat ID send the command /my_id to telegram bot @get_id.
164 # Users also need to open a query with the bot (see below).
166 # note: multiple recipients can be given like this:
167 # "CHAT_ID_1 CHAT_ID_2 ..."
169 # enable/disable sending telegram messages
172 # Contact the bot @BotFather to create a new bot and receive a bot token.
173 # Without it, netdata cannot send telegram messages.
174 TELEGRAM_BOT_TOKEN=""
176 # If a role's recipients are not configured, a message will be send to
177 # this chat id (empty = do not send a notification for unconfigured roles):
178 DEFAULT_RECIPIENT_TELEGRAM=""
181 #------------------------------------------------------------------------------
182 # slack (slack.com) global notification options
184 # multiple recipients can be given like this:
185 # "CHANNEL1 CHANNEL2 ..."
187 # enable/disable sending slack notifications
190 # Login to slack.com and create an incoming webhook. You need only one for all
191 # your netdata servers (or you can have one for each of your netdata).
192 # Without it, netdata cannot send slack notifications.
193 # Get yours from: https://api.slack.com/incoming-webhooks
196 # if a role's recipients are not configured, a notification will be send to
197 # this slack channel (empty = do not send a notification for unconfigured
199 DEFAULT_RECIPIENT_SLACK=""
202 #------------------------------------------------------------------------------
203 # kafka notification options
205 # enable/disable sending kafka notifications
208 # The URL to POST kafka alarm data to. It should be the full URL.
211 # The IP to be used in the kafka message as the sender.
215 #------------------------------------------------------------------------------
216 # pagerduty.com notification options
218 # pagerduty.com notifications require the pagerduty agent to be installed and
219 # a "Generic API" pagerduty service.
220 # https://www.pagerduty.com/docs/guides/agent-install-guide/
222 # enable/disable sending pagerduty notifications
225 # The service key for your "General API" pagerduty service.
229 ###############################################################################
230 # RECIPIENTS PER ROLE
232 # -----------------------------------------------------------------------------
233 # generic system alarms
234 # CPU, disks, network interfaces, entropy, etc
236 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
238 role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
240 role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
242 role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
244 role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
246 role_recipients_twilio[sysadmin]="${DEFAULT_RECIPIENT_TWILIO}"
248 # -----------------------------------------------------------------------------
251 role_recipients_email[domainadmin]="${DEFAULT_RECIPIENT_EMAIL}"
253 role_recipients_pushover[domainadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
255 role_recipients_pushbullet[domainadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
257 role_recipients_telegram[domainadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
259 role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
261 role_recipients_twilio[domainadmin]="${DEFAULT_RECIPIENT_TWILIO}"
263 # -----------------------------------------------------------------------------
264 # database servers alarms
265 # mysql, redis, memcached, etc
267 role_recipients_email[dba]="${DEFAULT_RECIPIENT_EMAIL}"
269 role_recipients_pushover[dba]="${DEFAULT_RECIPIENT_PUSHOVER}"
271 role_recipients_pushbullet[dba]="${DEFAULT_RECIPIENT_PUSHBULLET}"
273 role_recipients_telegram[dba]="${DEFAULT_RECIPIENT_TELEGRAM}"
275 role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
277 role_recipients_twilio[dba]="${DEFAULT_RECIPIENT_TWILIO}"
279 # -----------------------------------------------------------------------------
283 role_recipients_email[webmaster]="${DEFAULT_RECIPIENT_EMAIL}"
285 role_recipients_pushover[webmaster]="${DEFAULT_RECIPIENT_PUSHOVER}"
287 role_recipients_pushbullet[webmaster]="${DEFAULT_RECIPIENT_PUSHBULLET}"
289 role_recipients_telegram[webmaster]="${DEFAULT_RECIPIENT_TELEGRAM}"
291 role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
293 role_recipients_twilio[webmaster]="${DEFAULT_RECIPIENT_TWILIO}"
295 # -----------------------------------------------------------------------------
296 # proxy servers alarms
299 role_recipients_email[proxyadmin]="${DEFAULT_RECIPIENT_EMAIL}"
301 role_recipients_pushover[proxyadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
303 role_recipients_pushbullet[proxyadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
305 role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
307 role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
309 role_recipients_twilio[proxyadmin]="${DEFAULT_RECIPIENT_TWILIO}"