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