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, pushover, telegram and slack notifications will be
  53 # 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 #  - 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, pd) 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 # Twilio (twilio.com) SMS options
 146
 147 # multiple recipients can be given like this:
 148 #                  "+15555555555 +17777777777"
 149
 150 # enable/disable sending twilio SMS
 151 SEND_TWILIO="YES"
 152
 153 # Signup for free trial and select a SMS capable Twilio Number
 154 # To get your Account SID and Token, go to https://www.twilio.com/console
 155 # Place your sid, token and number below.
 156 # Then just set the recipients' phone numbers.
 157 # The trial account is only allowed to use the number specified when set up.
 158
 159 # Without an account sid and token, netdata cannot send Twilio text messages.
 160 TWILIO_ACCOUNT_SID=""
 161 TWILIO_ACCOUNT_TOKEN=""
 162 TWILIO_NUMBER=""
 163 DEFAULT_RECIPIENT_TWILIO=""
 164
 165 #------------------------------------------------------------------------------
 166 # Messagebird (messagebird.com) SMS options
 167
 168 # multiple recipients can be given like this:
 169 #                  "+15555555555 +17777777777"
 170
 171 # enable/disable sending messagebird SMS
 172 SEND_MESSAGEBIRD="YES"
 173
 174 # to get an access key, create a free account at https://www.messagebird.com
 175 # verify and activate the account (no CC info needed)
 176 # login to your account and enter your phonenumber to get some free credits
 177 # to get the API key, click on 'API' in the sidebar, then 'API Access (REST)'
 178 # click 'Add access key' and fill in data (you want a live key to send SMS)
 179
 180 # Without an access key, netdata cannot send Messagebird text messages.
 181 MESSAGEBIRD_ACCESS_KEY=""
 182 MESSAGEBIRD_NUMBER=""
 183 DEFAULT_RECIPIENT_MESSAGEBIRD=""
 184
 185 #------------------------------------------------------------------------------
 186 # telegram (telegram.org) global notification options
 187
 188 # To get your chat ID send the command /my_id to telegram bot @get_id.
 189 # Users also need to open a query with the bot (see below).
 190
 191 # note: multiple recipients can be given like this:
 192 #                  "CHAT_ID_1 CHAT_ID_2 ..."
 193
 194 # enable/disable sending telegram messages
 195 SEND_TELEGRAM="YES"
 196
 197 # Contact the bot @BotFather to create a new bot and receive a bot token.
 198 # Without it, netdata cannot send telegram messages.
 199 TELEGRAM_BOT_TOKEN=""
 200
 201 # If a role's recipients are not configured, a message will be send to
 202 # this chat id (empty = do not send a notification for unconfigured roles):
 203 DEFAULT_RECIPIENT_TELEGRAM=""
 204
 205
 206 #------------------------------------------------------------------------------
 207 # slack (slack.com) global notification options
 208
 209 # multiple recipients can be given like this:
 210 #                  "CHANNEL1 CHANNEL2 ..."
 211
 212 # enable/disable sending slack notifications
 213 SEND_SLACK="YES"
 214
 215 # Login to slack.com and create an incoming webhook. You need only one for all
 216 # your netdata servers (or you can have one for each of your netdata).
 217 # Without it, netdata cannot send slack notifications.
 218 # Get yours from: https://api.slack.com/incoming-webhooks
 219 SLACK_WEBHOOK_URL=""
 220
 221 # if a role's recipients are not configured, a notification will be send to
 222 # this slack channel (empty = do not send a notification for unconfigured
 223 # roles):
 224 DEFAULT_RECIPIENT_SLACK=""
 225
 226
 227 #------------------------------------------------------------------------------
 228 # kafka notification options
 229
 230 # enable/disable sending kafka notifications
 231 SEND_KAFKA="YES"
 232
 233 # The URL to POST kafka alarm data to. It should be the full URL.
 234 KAFKA_URL=""
 235
 236 # The IP to be used in the kafka message as the sender.
 237 KAFKA_SENDER_IP=""
 238
 239
 240 #------------------------------------------------------------------------------
 241 # pagerduty.com notification options
 242 #
 243 # pagerduty.com notifications require the pagerduty agent to be installed and
 244 # a "Generic API" pagerduty service.
 245 # https://www.pagerduty.com/docs/guides/agent-install-guide/
 246
 247 # multiple recipients can be given like this:
 248 #              "<pd_service_key_1> <pd_service_key_2> ..."
 249
 250 # enable/disable sending pagerduty notifications
 251 SEND_PD="YES"
 252
 253 # if a role's recipients are not configured, a notification will be sent to
 254 # the "General API" pagerduty.com service that uses this service key.
 255 # (empty = do not send a notification for unconfigured roles):
 256 DEFAULT_RECIPIENT_PD=""
 257
 258
 259 ###############################################################################
 260 # RECIPIENTS PER ROLE
 261
 262 # -----------------------------------------------------------------------------
 263 # generic system alarms
 264 # CPU, disks, network interfaces, entropy, etc
 265
 266 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 267
 268 role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 269
 270 role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 271
 272 role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 273
 274 role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
 275
 276 role_recipients_twilio[sysadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 277
 278 role_recipients_messagebird[sysadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 279
 280 role_recipients_pd[sysadmin]="${DEFAULT_RECIPIENT_PD}"
 281
 282 # -----------------------------------------------------------------------------
 283 # DNS related alarms
 284
 285 role_recipients_email[domainadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 286
 287 role_recipients_pushover[domainadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 288
 289 role_recipients_pushbullet[domainadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 290
 291 role_recipients_telegram[domainadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 292
 293 role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
 294
 295 role_recipients_twilio[domainadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 296
 297 role_recipients_messagebird[domainadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 298
 299 role_recipients_pd[domainadmin]="${DEFAULT_RECIPIENT_PD}"
 300
 301 # -----------------------------------------------------------------------------
 302 # database servers alarms
 303 # mysql, redis, memcached, etc
 304
 305 role_recipients_email[dba]="${DEFAULT_RECIPIENT_EMAIL}"
 306
 307 role_recipients_pushover[dba]="${DEFAULT_RECIPIENT_PUSHOVER}"
 308
 309 role_recipients_pushbullet[dba]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 310
 311 role_recipients_telegram[dba]="${DEFAULT_RECIPIENT_TELEGRAM}"
 312
 313 role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
 314
 315 role_recipients_twilio[dba]="${DEFAULT_RECIPIENT_TWILIO}"
 316
 317 role_recipients_messagebird[dba]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 318
 319 role_recipients_pd[dba]="${DEFAULT_RECIPIENT_PD}"
 320
 321 # -----------------------------------------------------------------------------
 322 # web servers alarms
 323 # apache, nginx, etc
 324
 325 role_recipients_email[webmaster]="${DEFAULT_RECIPIENT_EMAIL}"
 326
 327 role_recipients_pushover[webmaster]="${DEFAULT_RECIPIENT_PUSHOVER}"
 328
 329 role_recipients_pushbullet[webmaster]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 330
 331 role_recipients_telegram[webmaster]="${DEFAULT_RECIPIENT_TELEGRAM}"
 332
 333 role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
 334
 335 role_recipients_twilio[webmaster]="${DEFAULT_RECIPIENT_TWILIO}"
 336
 337 role_recipients_messagebird[webmaster]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 338
 339 role_recipients_pd[webmaster]="${DEFAULT_RECIPIENT_PD}"
 340
 341 # -----------------------------------------------------------------------------
 342 # proxy servers alarms
 343 # apache, nginx, etc
 344
 345 role_recipients_email[proxyadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 346
 347 role_recipients_pushover[proxyadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 348
 349 role_recipients_pushbullet[proxyadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
 350
 351 role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 352
 353 role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
 354
 355 role_recipients_twilio[proxyadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 356
 357 role_recipients_messagebird[proxyadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
 358
 359 role_recipients_pd[proxyadmin]="${DEFAULT_RECIPIENT_PD}"