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