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 #
  12 # The 'to' line given at netdata alarms defines a *role*, so that many
  13 # people can be notified for each role.
  14 #
  15 # This file is a BASH script itself.
  16 #
  17 #
  18 ###############################################################################
  19 # proxy configuration
  20 #
  21 # If you need to send curl based notifications (pushover, slack, telegram)
  22 # via a proxy, set these to your proxy address:
  23 #export http_proxy="http://10.0.0.1:3128/"
  24 #export https_proxy="http://10.0.0.1:3128/"
  25
  26
  27 ###############################################################################
  28 # notifications images
  29 #
  30 # Images in notifications need to be downloaded from an Internet facing site.
  31 # To allow notification providers fetch the icons/images, by default we set
  32 # the URL of the global public netdata registry.
  33 # If you have an Internet facing netdata (or you have copied the images/ folder
  34 # of netdata to your web server), set its URL here, to fetch the notification
  35 # images from it.
  36 #images_base_url="http://my.public.netdata.server:19999"
  37
  38
  39 ###############################################################################
  40 # external commands
  41
  42 # The full path to the sendmail command.
  43 # If empty, the system $PATH will be searched for it.
  44 # If not found, email notifications will be disabled (silently).
  45 sendmail=""
  46
  47 # The full path of the curl command.
  48 # If empty, the system $PATH will be searched for it.
  49 # If not found, pushover, telegram and slack notifications will be
  50 # silently disabled.
  51 curl=""
  52
  53
  54 ###############################################################################
  55 # NOTE ABOUT RECIPIENTS
  56 #
  57 # When you define recipients (all types):
  58 #
  59 #  - emails addresses
  60 #  - pushover user tokens
  61 #  - telegram chat ids
  62 #  - slack channels
  63 #
  64 # You can append |critical to limit the notifications to be sent.
  65 #
  66 # In these examples, the first recipient receives all the alarms
  67 # while the second one receives only the critical ones:
  68 #
  69 #  email   : "user1@example.com user2@example.com|critical"
  70 #  pushover: "2987343...9437837 8756278...2362736|critical"
  71 #  telegram: "111827421 112746832|critical"
  72 #  slack   : "alarms disasters|critical"
  73 #
  74 # If a recipient is set to empty string, the default recipient of the given
  75 # notification method (email, pushover, telegram, slack) will be used.
  76 # To disable a notification, use the recipient called: disabled
  77 # This works for all notification methods (including the default recipients).
  78
  79
  80 ###############################################################################
  81 # email global notification options
  82
  83 # multiple recipients can be given like this:
  84 #              "admin1@example.com admin2@example.com ..."
  85
  86 # enable/disable sending emails
  87 SEND_EMAIL="YES"
  88
  89 # if a role recipient is not configured, an email will be send to:
  90 DEFAULT_RECIPIENT_EMAIL="root"
  91 # to receive only critical alarms, set it to "root|critical"
  92
  93
  94 ###############################################################################
  95 # pushover (pushover.net) global notification options
  96
  97 # multiple recipients can be given like this:
  98 #                  "USERTOKEN1 USERTOKEN2 ..."
  99
 100 # enable/disable sending pushover notifications
 101 SEND_PUSHOVER="YES"
 102
 103 # Login to pushover.net to get your pushover app token.
 104 # You need only one for all your netdata servers (or you can have one for
 105 # each of your netdata - your call).
 106 # Without an app token, netdata cannot send pushover notifications.
 107 PUSHOVER_APP_TOKEN=""
 108
 109 # if a role's recipients are not configured, a notification will be send to
 110 # this pushover user token (empty = do not send a notification for unconfigured
 111 # roles):
 112 DEFAULT_RECIPIENT_PUSHOVER=""
 113
 114
 115 ###############################################################################
 116 # telegram (telegram.org) global notification options
 117
 118 # To get your chat ID send the command /my_id to telegram bot @get_id.
 119 # Users also need to open a query with the bot (see below).
 120
 121 # note: multiple recipients can be given like this:
 122 #                  "CHAT_ID_1 CHAT_ID_2 ..."
 123
 124 # enable/disable sending telegram messages
 125 SEND_TELEGRAM="YES"
 126
 127 # Contact the bot @BotFather to create a new bot and receive a bot token.
 128 # Without it, netdata cannot send telegram messages.
 129 TELEGRAM_BOT_TOKEN=""
 130
 131 # If a role's recipients are not configured, a message will be send to
 132 # this chat id (empty = do not send a notification for unconfigured roles):
 133 DEFAULT_RECIPIENT_TELEGRAM=""
 134
 135
 136 ###############################################################################
 137 # slack (slack.com) global notification options
 138
 139 # multiple recipients can be given like this:
 140 #                  "CHANNEL1 CHANNEL2 ..."
 141
 142 # enable/disable sending slack notifications
 143 SEND_SLACK="YES"
 144
 145 # Login to slack.com and create an incoming webhook. You need only one for all
 146 # your netdata servers (or you can have one for each of your netdata).
 147 # Without it, netdata cannot send slack notifications.
 148 # Get yours from: https://api.slack.com/incoming-webhooks
 149 SLACK_WEBHOOK_URL=""
 150
 151 # if a role's recipients are not configured, a notification will be send to
 152 # this slack channel (empty = do not send a notification for unconfigured
 153 # roles):
 154 DEFAULT_RECIPIENT_SLACK=""
 155
 156
 157 ###############################################################################
 158 # RECIPIENTS PER ROLE
 159
 160 # -----------------------------------------------------------------------------
 161 # generic system alarms
 162 # CPU, disks, network interfaces, entropy, etc
 163
 164 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 165
 166 role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 167
 168 role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 169
 170 role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
 171
 172
 173 # -----------------------------------------------------------------------------
 174 # DNS related alarms
 175
 176 role_recipients_email[domainadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 177
 178 role_recipients_pushover[domainadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 179
 180 role_recipients_telegram[domainadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 181
 182 role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
 183
 184
 185 # -----------------------------------------------------------------------------
 186 # database servers alarms
 187 # mysql, redis, memcached, etc
 188
 189 role_recipients_email[dba]="${DEFAULT_RECIPIENT_EMAIL}"
 190
 191 role_recipients_pushover[dba]="${DEFAULT_RECIPIENT_PUSHOVER}"
 192
 193 role_recipients_telegram[dba]="${DEFAULT_RECIPIENT_TELEGRAM}"
 194
 195 role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
 196
 197
 198 # -----------------------------------------------------------------------------
 199 # web servers alarms
 200 # apache, nginx, etc
 201
 202 role_recipients_email[webmaster]="${DEFAULT_RECIPIENT_EMAIL}"
 203
 204 role_recipients_pushover[webmaster]="${DEFAULT_RECIPIENT_PUSHOVER}"
 205
 206 role_recipients_telegram[webmaster]="${DEFAULT_RECIPIENT_TELEGRAM}"
 207
 208 role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
 209
 210
 211 # -----------------------------------------------------------------------------
 212 # proxy servers alarms
 213 # apache, nginx, etc
 214
 215 role_recipients_email[proxyadmin]="${DEFAULT_RECIPIENT_EMAIL}"
 216
 217 role_recipients_pushover[proxyadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
 218
 219 role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 220
 221 role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
 222