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