conf.d/health_alarm_notify.conf

   1 # Configuration for alarm notifications
   2 #
   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 (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 discord guild (discordapp.com),
  11 # - messages to your telegram chat / group chat (telegram.org)
  12 # - sms messages to your cell phone or any sms enabled device (twilio.com)
  13 # - sms messages to your cell phone or any sms enabled device (messagebird.com)
  14 # - notifications to users on pagerduty.com
  15 #
  16 # The 'to' line given at netdata alarms defines a *role*, so that many
  17 # people can be notified for each role.
  18 #
  19 # This file is a BASH script itself.
  20 #
  21 #
  22 #------------------------------------------------------------------------------
  23 # proxy configuration
  24 #
  25 # If you need to send curl based notifications (pushover, pushbullet, slack,
  26 # discord, telegram) via a proxy, set these to your proxy address:
  27 #export http_proxy="http://10.0.0.1:3128/"
  28 #export https_proxy="http://10.0.0.1:3128/"
  29
  30
  31 #------------------------------------------------------------------------------
  32 # notifications images
  33 #
  34 # Images in notifications need to be downloaded from an Internet facing site.
  35 # To allow notification providers fetch the icons/images, by default we set
  36 # the URL of the global public netdata registry.
  37 # If you have an Internet facing netdata (or you have copied the images/ folder
  38 # of netdata to your web server), set its URL here, to fetch the notification
  39 # images from it.
  40 #images_base_url="http://my.public.netdata.server:19999"
  41
  42
  43 #------------------------------------------------------------------------------
  44 # external commands
  45
  46 # The full path to the sendmail command.
  47 # If empty, the system $PATH will be searched for it.
  48 # If not found, email notifications will be disabled (silently).
  49 sendmail=""
  50
  51 # The full path of the curl command.
  52 # If empty, the system $PATH will be searched for it.
  53 # If not found, most notifications will be silently disabled.
  54 curl=""
  55
  56
  57 #------------------------------------------------------------------------------
  58 # NOTE ABOUT RECIPIENTS
  59 #
  60 # When you define recipients (all types):
  61 #
  62 #  - emails addresses
  63 #  - pushover user tokens
  64 #  - telegram chat ids
  65 #  - slack channels
  66 #  - discord channels
  67 #  - hipchat rooms
  68 #  - sms phone numbers
  69 #  - pagerduty.com (pd) services
  70 #
  71 # You can append |critical to limit the notifications to be sent.
  72 #
  73 # In these examples, the first recipient receives all the alarms
  74 # while the second one receives only the critical ones:
  75 #
  76 #  email      : "user1@example.com user2@example.com|critical"
  77 #  pushover   : "2987343...9437837 8756278...2362736|critical"
  78 #  telegram   : "111827421 112746832|critical"
  79 #  slack      : "alarms disasters|critical"
  80 #  discord    : "alarms disasters|critical"
  81 #  twilio     : "+15555555555 +17777777777|critical"
  82 #  messagebird: "+15555555555 +17777777777|critical"
  83 #  pd         : "<pd_service_key_1> <pd_service_key_2>|critical"
  84 #
  85 # If a recipient is set to empty string, the default recipient of the given
  86 # notification method (email, pushover, telegram, slack, etc) will be used.
  87 # To disable a notification, use the recipient called: disabled
  88 # This works for all notification methods (including the default recipients).
  89
  90
  91 #------------------------------------------------------------------------------
  92 # email global notification options
  93
  94 # multiple recipients can be given like this:
  95 #              "admin1@example.com admin2@example.com ..."
  96
  97 # enable/disable sending emails
  98 SEND_EMAIL="YES"
  99
 100 # if a role recipient is not configured, an email will be send to:
 101 DEFAULT_RECIPIENT_EMAIL="root"
 102 # to receive only critical alarms, set it to "root|critical"
 103
 104
 105 #------------------------------------------------------------------------------
 106 # pushover (pushover.net) global notification options
 107
 108 # multiple recipients can be given like this:
 109 #                  "USERTOKEN1 USERTOKEN2 ..."
 110
 111 # enable/disable sending pushover notifications
 112 SEND_PUSHOVER="YES"
 113
 114 # Login to pushover.net to get your pushover app token.
 115 # You need only one for all your netdata servers (or you can have one for
 116 # each of your netdata - your call).
 117 # Without an app token, netdata cannot send pushover notifications.
 118 PUSHOVER_APP_TOKEN=""
 119
 120 # if a role's recipients are not configured, a notification will be send to
 121 # this pushover user token (empty = do not send a notification for unconfigured
 122 # roles):
 123 DEFAULT_RECIPIENT_PUSHOVER=""
 124
 125
 126 #------------------------------------------------------------------------------
 127 # pushbullet (pushbullet.com) push notification options
 128
 129 # multiple recipients can be given like this:
 130 #                  "user1@email.com user2@mail.com"
 131
 132 # enable/disable sending pushbullet notifications
 133 SEND_PUSHBULLET="YES"
 134
 135 # Signup and Login to pushbullet.com
 136 # To get your Access Token, go to https://www.pushbullet.com/#settings/account
 137 # Create a new access token and paste it below.
 138 # Then just set the recipients' emails.
 139 # Please note that the if the email in the DEFAULT_RECIPIENT_PUSHBULLET does
 140 # not have a pushbullet account, the pushbullet service will send an email
 141 # to that address instead.
 142
 143 # Without an access token, netdata cannot send pushbullet notifications.
 144 PUSHBULLET_ACCESS_TOKEN=""
 145 DEFAULT_RECIPIENT_PUSHBULLET=""
 146
 147
 148 #------------------------------------------------------------------------------
 149 # Twilio (twilio.com) SMS options
 150
 151 # multiple recipients can be given like this:
 152 #                  "+15555555555 +17777777777"
 153
 154 # enable/disable sending twilio SMS
 155 SEND_TWILIO="YES"
 156
 157 # Signup for free trial and select a SMS capable Twilio Number
 158 # To get your Account SID and Token, go to https://www.twilio.com/console
 159 # Place your sid, token and number below.
 160 # Then just set the recipients' phone numbers.
 161 # The trial account is only allowed to use the number specified when set up.
 162
 163 # Without an account sid and token, netdata cannot send Twilio text messages.
 164 TWILIO_ACCOUNT_SID=""
 165 TWILIO_ACCOUNT_TOKEN=""
 166 TWILIO_NUMBER=""
 167 DEFAULT_RECIPIENT_TWILIO=""
 168
 169
 170 #------------------------------------------------------------------------------
 171 # Messagebird (messagebird.com) SMS options
 172
 173 # multiple recipients can be given like this:
 174 #                  "+15555555555 +17777777777"
 175
 176 # enable/disable sending messagebird SMS
 177 SEND_MESSAGEBIRD="YES"
 178
 179 # to get an access key, create a free account at https://www.messagebird.com
 180 # verify and activate the account (no CC info needed)
 181 # login to your account and enter your phonenumber to get some free credits
 182 # to get the API key, click on 'API' in the sidebar, then 'API Access (REST)'
 183 # click 'Add access key' and fill in data (you want a live key to send SMS)
 184
 185 # Without an access key, netdata cannot send Messagebird text messages.
 186 MESSAGEBIRD_ACCESS_KEY=""
 187 MESSAGEBIRD_NUMBER=""
 188 DEFAULT_RECIPIENT_MESSAGEBIRD=""
 189
 190
 191 #------------------------------------------------------------------------------
 192 # telegram (telegram.org) global notification options
 193
 194 # To get your chat ID send the command /my_id to telegram bot @get_id.
 195 # Users also need to open a query with the bot (see below).
 196
 197 # note: multiple recipients can be given like this:
 198 #                  "CHAT_ID_1 CHAT_ID_2 ..."
 199
 200 # enable/disable sending telegram messages
 201 SEND_TELEGRAM="YES"
 202
 203 # Contact the bot @BotFather to create a new bot and receive a bot token.
 204 # Without it, netdata cannot send telegram messages.
 205 TELEGRAM_BOT_TOKEN=""
 206
 207 # If a role's recipients are not configured, a message will be send to
 208 # this chat id (empty = do not send a notification for unconfigured roles):
 209 DEFAULT_RECIPIENT_TELEGRAM=""
 210
 211
 212 #------------------------------------------------------------------------------
 213 # slack (slack.com) global notification options
 214
 215 # multiple recipients can be given like this:
 216 #                  "CHANNEL1 CHANNEL2 ..."
 217
 218 # enable/disable sending slack notifications
 219 SEND_SLACK="YES"
 220
 221 # Login to slack.com and create an incoming webhook. You need only one for all
 222 # your netdata servers (or you can have one for each of your netdata).
 223 # Without it, netdata cannot send slack notifications.
 224 # Get yours from: https://api.slack.com/incoming-webhooks
 225 SLACK_WEBHOOK_URL=""
 226
 227 # if a role's recipients are not configured, a notification will be send to
 228 # this slack channel (empty = do not send a notification for unconfigured
 229 # roles):
 230 DEFAULT_RECIPIENT_SLACK=""
 231
 232
 233 #------------------------------------------------------------------------------
 234 # discord (discordapp.com) global notification options
 235
 236 # multiple recipients can be given like this:
 237 #                  "CHANNEL1 CHANNEL2 ..."
 238
 239 # enable/disable sending discord notifications
 240 SEND_DISCORD="YES"
 241
 242 # Create a webhook by following the official documentation -
 243 # https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
 244 DISCORD_WEBHOOK_URL=""
 245
 246 # if a role's recipients are not configured, a notification will be send to
 247 # this discord channel (empty = do not send a notification for unconfigured
 248 # roles):
 249 DEFAULT_RECIPIENT_DISCORD=""
 250
 251
 252 #------------------------------------------------------------------------------
 253 # hipchat global notification options
 254
 255 # multiple recipients can be given like this:
 256 #                  "ROOM1 ROOM2 ..."
 257
 258 # enable/disable sending hipchat notifications
 259 SEND_HIPCHAT="YES"
 260
 261 # define hipchat server
 262 HIPCHAT_SERVER="api.hipchat.com"
 263
 264 # api.hipchat.com authorization token
 265 # Without this, netdata cannot send hipchat notifications.
 266 HIPCHAT_AUTH_TOKEN=""
 267
 268 # if a role's recipients are not configured, a notification will be send to
 269 # this hipchat room (empty = do not send a notification for unconfigured
 270 # roles):
 271 DEFAULT_RECIPIENT_HIPCHAT=""
 272
 273
 274 #------------------------------------------------------------------------------
 275 # kafka notification options
 276
 277 # enable/disable sending kafka notifications
 278 SEND_KAFKA="YES"
 279
 280 # The URL to POST kafka alarm data to. It should be the full URL.
 281 KAFKA_URL=""
 282
 283 # The IP to be used in the kafka message as the sender.
 284 KAFKA_SENDER_IP=""
 285
 286
 287 #------------------------------------------------------------------------------
 288 # pagerduty.com notification options
 289 #
 290 # pagerduty.com notifications require the pagerduty agent to be installed and
 291 # a "Generic API" pagerduty service.
 292 # https://www.pagerduty.com/docs/guides/agent-install-guide/
 293
 294 # multiple recipients can be given like this:
 295 #              "<pd_service_key_1> <pd_service_key_2> ..."
 296
 297 # enable/disable sending pagerduty notifications
 298 SEND_PD="YES"
 299
 300 # if a role's recipients are not configured, a notification will be sent to
 301 # the "General API" pagerduty.com service that uses this service key.
 302 # (empty = do not send a notification for unconfigured roles):
 303 DEFAULT_RECIPIENT_PD=""
 304
 305
 306 ###############################################################################
 307 # RECIPIENTS PER ROLE
 308
 309 # -----------------------------------------------------------------------------
 310 # generic system alarms
 311 # CPU, disks, network interfaces, entropy, etc
 312
 313 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 314
 315 role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 316
 317 role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 318
 319 role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 320
 321 role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
 322
 323 role_recipients_discord[sysadmin]="${DEFAULT_RECIPIENT_DISCORD}"
 324
 325 role_recipients_hipchat[sysadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
 326
 327 role_recipients_twilio[sysadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 328
 329 role_recipients_messagebird[sysadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 330
 331 role_recipients_pd[sysadmin]="${DEFAULT_RECIPIENT_PD}"
 332
 333 # -----------------------------------------------------------------------------
 334 # DNS related alarms
 335
 336 role_recipients_email[domainadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 337
 338 role_recipients_pushover[domainadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 339
 340 role_recipients_pushbullet[domainadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 341
 342 role_recipients_telegram[domainadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 343
 344 role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
 345
 346 role_recipients_discord[domainadmin]="${DEFAULT_RECIPIENT_DISCORD}"
 347
 348 role_recipients_hipchat[domainadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
 349
 350 role_recipients_twilio[domainadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 351
 352 role_recipients_messagebird[domainadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 353
 354 role_recipients_pd[domainadmin]="${DEFAULT_RECIPIENT_PD}"
 355
 356 # -----------------------------------------------------------------------------
 357 # database servers alarms
 358 # mysql, redis, memcached, postgres, etc
 359
 360 role_recipients_email[dba]="${DEFAULT_RECIPIENT_EMAIL}"
 361
 362 role_recipients_pushover[dba]="${DEFAULT_RECIPIENT_PUSHOVER}"
 363
 364 role_recipients_pushbullet[dba]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 365
 366 role_recipients_telegram[dba]="${DEFAULT_RECIPIENT_TELEGRAM}"
 367
 368 role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
 369
 370 role_recipients_discord[dba]="${DEFAULT_RECIPIENT_DISCORD}"
 371
 372 role_recipients_hipchat[dba]="${DEFAULT_RECIPIENT_HIPCHAT}"
 373
 374 role_recipients_twilio[dba]="${DEFAULT_RECIPIENT_TWILIO}"
 375
 376 role_recipients_messagebird[dba]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 377
 378 role_recipients_pd[dba]="${DEFAULT_RECIPIENT_PD}"
 379
 380 # -----------------------------------------------------------------------------
 381 # web servers alarms
 382 # apache, nginx, lighttpd, etc
 383
 384 role_recipients_email[webmaster]="${DEFAULT_RECIPIENT_EMAIL}"
 385
 386 role_recipients_pushover[webmaster]="${DEFAULT_RECIPIENT_PUSHOVER}"
 387
 388 role_recipients_pushbullet[webmaster]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 389
 390 role_recipients_telegram[webmaster]="${DEFAULT_RECIPIENT_TELEGRAM}"
 391
 392 role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
 393
 394 role_recipients_discord[webmaster]="${DEFAULT_RECIPIENT_DISCORD}"
 395
 396 role_recipients_hipchat[webmaster]="${DEFAULT_RECIPIENT_HIPCHAT}"
 397
 398 role_recipients_twilio[webmaster]="${DEFAULT_RECIPIENT_TWILIO}"
 399
 400 role_recipients_messagebird[webmaster]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 401
 402 role_recipients_pd[webmaster]="${DEFAULT_RECIPIENT_PD}"
 403
 404 # -----------------------------------------------------------------------------
 405 # proxy servers alarms
 406 # squid, etc
 407
 408 role_recipients_email[proxyadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 409
 410 role_recipients_pushover[proxyadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 411
 412 role_recipients_pushbullet[proxyadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 413
 414 role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 415
 416 role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
 417
 418 role_recipients_discord[proxyadmin]="${DEFAULT_RECIPIENT_DISCORD}"
 419
 420 role_recipients_hipchat[proxyadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
 421
 422 role_recipients_twilio[proxyadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 423
 424 role_recipients_messagebird[proxyadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 425
 426 role_recipients_pd[proxyadmin]="${DEFAULT_RECIPIENT_PD}"