health_alarm_notify.conf 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083
  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 alerta server (alerta.io),
  11. # - messages to your flock team (flock.com),
  12. # - messages to your discord guild (discordapp.com),
  13. # - messages to your telegram chat / group chat (telegram.org)
  14. # - sms messages to your cell phone or any sms enabled device (twilio.com)
  15. # - sms messages to your cell phone or any sms enabled device (messagebird.com)
  16. # - sms messages to your cell phone or any sms enabled device (smstools3)
  17. # - notifications to users on pagerduty.com
  18. # - push notifications to iOS devices (via prowlapp.com)
  19. # - notifications to Amazon SNS topics (aws.amazon.com)
  20. # - messages to your irc channel on your selected network
  21. # - messages to a local or remote syslog daemon
  22. # - message to Microsoft Team (through webhook)
  23. # - message to Rocket.Chat (through webhook)
  24. #
  25. # The 'to' line given at netdata alarms defines a *role*, so that many
  26. # people can be notified for each role.
  27. #
  28. # This file is a BASH script itself.
  29. #
  30. #
  31. #------------------------------------------------------------------------------
  32. # proxy configuration
  33. #
  34. # If you need to send curl based notifications (pushover, pushbullet, slack, alerta,
  35. # flock, discord, telegram) via a proxy, set these to your proxy address:
  36. #export http_proxy="http://10.0.0.1:3128/"
  37. #export https_proxy="http://10.0.0.1:3128/"
  38. #------------------------------------------------------------------------------
  39. # notifications images
  40. #
  41. # Images in notifications need to be downloaded from an Internet facing site.
  42. # To allow notification providers fetch the icons/images, by default we set
  43. # the URL of the global public netdata registry.
  44. # If you have an Internet facing netdata (or you have copied the images/ folder
  45. # of netdata to your web server), set its URL here, to fetch the notification
  46. # images from it.
  47. #images_base_url="http://my.public.netdata.server:19999"
  48. #------------------------------------------------------------------------------
  49. # date handling
  50. #
  51. # You can configure netdata alerts to send dates in any format you want.
  52. # This uses standard `date` command format strings. See `man date` for
  53. # more info on what you can put in here. Note that this has to start with a '+', otherwise it won't work.
  54. #
  55. # For ISO 8601 dates, use '+%FT%T%z'
  56. # For RFC 5322 dates, use '+%a, %d %b %Y %H:%M:%S %z'
  57. # For RFC 3339 dates, use '+%F %T%:z'
  58. # For RFC 1123 dates, use '+%a, %d %b %Y %H:%M:%S %Z'
  59. # For RFC 1036 dates, use '+%A, %d-%b-%y %H:%M:%S %Z'
  60. # For a reasonably local date and time (in that order), use '+%x %X'
  61. # For the old default behavior (compatible with ANSI C's asctime() function), leave this empty.
  62. date_format=''
  63. #------------------------------------------------------------------------------
  64. # hostname handling
  65. #
  66. # By default, Netdata will use the simple hostname for the system (the
  67. # hostname with everything after the first `.` removed) when displaying
  68. # the hostname in alert notifications. If you prefer, you can uncomment
  69. # the line below to have Netdata instead use the host's fully qualified
  70. # domain name.
  71. #
  72. # This does not report correct FQDN's for slave systems for which this
  73. # sytem is a master.
  74. #
  75. # Additionally, if the system host name is overridden in /etc/netdata.conf
  76. # with the `hostname` option, that name will be used unconditionally
  77. # instead of this.
  78. #use_fqdn='YES'
  79. #------------------------------------------------------------------------------
  80. # external commands
  81. # The full path to the sendmail command.
  82. # If empty, the system $PATH will be searched for it.
  83. # If not found, email notifications will be disabled (silently).
  84. sendmail=""
  85. # The full path of the curl command.
  86. # If empty, the system $PATH will be searched for it.
  87. # If not found, most notifications will be silently disabled.
  88. curl=""
  89. # The full path of the nc command.
  90. # If empty, the system $PATH will be searched for it.
  91. # If not found, irc notifications will be silently disabled.
  92. nc=""
  93. # The full path of the logger command.
  94. # If empty, the system $PATH will be searched for it.
  95. # If not found, syslog notifications will be silently disabled.
  96. logger=""
  97. # The full path of the aws command.
  98. # If empty, the system $PATH will be searched for it.
  99. # If not found, Amazon SNS notifications will be silently disabled.
  100. aws=""
  101. # The full path of the sendsms command (smstools3).
  102. # If empty, the system $PATH will be searched for it.
  103. # If not found, SMS notifications will be silently disabled.
  104. sendsms=""
  105. #------------------------------------------------------------------------------
  106. # extra options for external commands
  107. #
  108. # In some cases, you may need to change what options get passed to an
  109. # external command. Such cases are covered here.
  110. # Extra options to pass to curl. In most cases, you shouldn't need to add anything
  111. # to this. If you're having issues with HTTPS connections, you might try adding
  112. # '--insecure' here, but be warned that it will make it much easier for
  113. # third-parties to block notification delivery, and may allow disclosure
  114. # of potentially sensitive information.
  115. #curl_options="--insecure"
  116. # Extra options to pass to logger. You shouldn't have to specify anything
  117. # here in most cases.
  118. #logger_options=""
  119. #------------------------------------------------------------------------------
  120. # extra options
  121. # By default don't do anything if this is CLEAR, but it was not WARNING or CRITICAL.
  122. # You can send it always if your system makes deduplication for alarms.
  123. #clear_alarm_always='YES'
  124. #
  125. #------------------------------------------------------------------------------
  126. # NOTE ABOUT RECIPIENTS
  127. #
  128. # When you define recipients (all types):
  129. #
  130. # - emails addresses
  131. # - pushover user tokens
  132. # - telegram chat ids
  133. # - slack channels
  134. # - alerta environment
  135. # - flock rooms
  136. # - discord channels
  137. # - hipchat rooms
  138. # - sms phone numbers
  139. # - pagerduty.com (pd) services
  140. # - irc channels
  141. #
  142. # You can append |critical to limit the notifications to be sent.
  143. #
  144. # In these examples, the first recipient receives all the alarms
  145. # while the second one receives only the critical ones:
  146. #
  147. # email : "user1@example.com user2@example.com|critical"
  148. # pushover : "2987343...9437837 8756278...2362736|critical"
  149. # telegram : "111827421 112746832|critical"
  150. # slack : "alarms disasters|critical"
  151. # alerta : "alarms disasters|critical"
  152. # flock : "alarms disasters|critical"
  153. # discord : "alarms disasters|critical"
  154. # twilio : "+15555555555 +17777777777|critical"
  155. # messagebird: "+15555555555 +17777777777|critical"
  156. # kavenegar : "09155555555 09177777777|critical"
  157. # pd : "<pd_service_key_1> <pd_service_key_2>|critical"
  158. # irc : "<irc_channel_1> <irc_channel_2>|critical"
  159. #
  160. # If a recipient is set to empty string, the default recipient of the given
  161. # notification method (email, pushover, telegram, slack, alerta, etc) will be used.
  162. # To disable a notification, use the recipient called: disabled
  163. # This works for all notification methods (including the default recipients).
  164. #------------------------------------------------------------------------------
  165. # email global notification options
  166. # multiple recipients can be given like this:
  167. # "admin1@example.com admin2@example.com ..."
  168. # the email address sending email notifications
  169. # the default is the system user netdata runs as (usually: netdata)
  170. # The following formats are supported:
  171. # EMAIL_SENDER="user@domain"
  172. # EMAIL_SENDER="User Name <user@domain>"
  173. # EMAIL_SENDER="'User Name' <user@domain>"
  174. # EMAIL_SENDER="\"User Name\" <user@domain>"
  175. EMAIL_SENDER=""
  176. # enable/disable sending emails
  177. SEND_EMAIL="YES"
  178. # if a role recipient is not configured, an email will be send to:
  179. DEFAULT_RECIPIENT_EMAIL="root"
  180. # to receive only critical alarms, set it to "root|critical"
  181. # Optionally specify the encoding to list in the Content-Type header.
  182. # This doesn't change what encoding the e-mail is sent with, just what
  183. # the headers say it was encoded as.
  184. # This shouldn't need to be changed as it will almost always be
  185. # autodetected from the environment.
  186. #EMAIL_CHARSET="UTF-8"
  187. # You can also have netdata add headers to the message that will
  188. # cause most e-mail clients to treat all notifications for a given
  189. # chart+alarm+host combination as a single thread. This can help
  190. # simplify tracking of alarms, as it provides an easy wway for scripts
  191. # to corelate messages and also will cause most clients to group all the
  192. # messages together. This is enabled by default, uncomment the line
  193. # below if you want to disable it.
  194. #EMAIL_THREADING="NO"
  195. #------------------------------------------------------------------------------
  196. # pushover (pushover.net) global notification options
  197. # multiple recipients can be given like this:
  198. # "USERTOKEN1 USERTOKEN2 ..."
  199. # enable/disable sending pushover notifications
  200. SEND_PUSHOVER="YES"
  201. # Login to pushover.net to get your pushover app token.
  202. # You need only one for all your netdata servers (or you can have one for
  203. # each of your netdata - your call).
  204. # Without an app token, netdata cannot send pushover notifications.
  205. PUSHOVER_APP_TOKEN=""
  206. # if a role's recipients are not configured, a notification will be send to
  207. # this pushover user token (empty = do not send a notification for unconfigured
  208. # roles):
  209. DEFAULT_RECIPIENT_PUSHOVER=""
  210. #------------------------------------------------------------------------------
  211. # pushbullet (pushbullet.com) push notification options
  212. # multiple recipients can be given like this:
  213. # "user1@email.com user2@mail.com"
  214. # enable/disable sending pushbullet notifications
  215. SEND_PUSHBULLET="YES"
  216. # Signup and Login to pushbullet.com
  217. # To get your Access Token, go to https://www.pushbullet.com/#settings/account
  218. # Create a new access token and paste it below.
  219. # Then just set the recipients' emails.
  220. # Please note that the if the email in the DEFAULT_RECIPIENT_PUSHBULLET does
  221. # not have a pushbullet account, the pushbullet service will send an email
  222. # to that address instead.
  223. # Without an access token, netdata cannot send pushbullet notifications.
  224. PUSHBULLET_ACCESS_TOKEN=""
  225. DEFAULT_RECIPIENT_PUSHBULLET=""
  226. # Device iden of the sending device. Optional.
  227. PUSHBULLET_SOURCE_DEVICE=""
  228. #------------------------------------------------------------------------------
  229. # Twilio (twilio.com) SMS options
  230. # multiple recipients can be given like this:
  231. # "+15555555555 +17777777777"
  232. # enable/disable sending twilio SMS
  233. SEND_TWILIO="YES"
  234. # Signup for free trial and select a SMS capable Twilio Number
  235. # To get your Account SID and Token, go to https://www.twilio.com/console
  236. # Place your sid, token and number below.
  237. # Then just set the recipients' phone numbers.
  238. # The trial account is only allowed to use the number specified when set up.
  239. # Without an account sid and token, netdata cannot send Twilio text messages.
  240. TWILIO_ACCOUNT_SID=""
  241. TWILIO_ACCOUNT_TOKEN=""
  242. TWILIO_NUMBER=""
  243. DEFAULT_RECIPIENT_TWILIO=""
  244. #------------------------------------------------------------------------------
  245. # Messagebird (messagebird.com) SMS options
  246. # multiple recipients can be given like this:
  247. # "+15555555555 +17777777777"
  248. # enable/disable sending messagebird SMS
  249. SEND_MESSAGEBIRD="YES"
  250. # to get an access key, create a free account at https://www.messagebird.com
  251. # verify and activate the account (no CC info needed)
  252. # login to your account and enter your phonenumber to get some free credits
  253. # to get the API key, click on 'API' in the sidebar, then 'API Access (REST)'
  254. # click 'Add access key' and fill in data (you want a live key to send SMS)
  255. # Without an access key, netdata cannot send Messagebird text messages.
  256. MESSAGEBIRD_ACCESS_KEY=""
  257. MESSAGEBIRD_NUMBER=""
  258. DEFAULT_RECIPIENT_MESSAGEBIRD=""
  259. #------------------------------------------------------------------------------
  260. # Kavenegar (Kavenegar.com) SMS options
  261. # multiple recipients can be given like this:
  262. # "09155555555 09177777777"
  263. # enable/disable sending kavenegar SMS
  264. SEND_KAVENEGAR="YES"
  265. # to get an access key, after selecting and purchasing your desired service
  266. # at http://kavenegar.com/pricing.html
  267. # login to your account, go to your dashboard and my account are
  268. # https://panel.kavenegar.com/Client/setting/account from API Key
  269. # copy your api key. You can generate new API Key too.
  270. # You can find and select kevenegar sender number from this place.
  271. # Without an API key, netdata cannot send KAVENEGAR text messages.
  272. KAVENEGAR_API_KEY=""
  273. KAVENEGAR_SENDER=""
  274. DEFAULT_RECIPIENT_KAVENEGAR=""
  275. #------------------------------------------------------------------------------
  276. # telegram (telegram.org) global notification options
  277. # To get your chat ID send the command /my_id to telegram bot @get_id.
  278. # Users also need to open a query with the bot (see below).
  279. # note: multiple recipients can be given like this:
  280. # "CHAT_ID_1 CHAT_ID_2 ..."
  281. # enable/disable sending telegram messages
  282. SEND_TELEGRAM="YES"
  283. # Contact the bot @BotFather to create a new bot and receive a bot token.
  284. # Without it, netdata cannot send telegram messages.
  285. TELEGRAM_BOT_TOKEN=""
  286. # If a role's recipients are not configured, a message will be send to
  287. # this chat id (empty = do not send a notification for unconfigured roles):
  288. DEFAULT_RECIPIENT_TELEGRAM=""
  289. #------------------------------------------------------------------------------
  290. # slack (slack.com) global notification options
  291. # multiple recipients can be given like this:
  292. # "RECIPIENT1 RECIPIENT2 ..."
  293. # enable/disable sending slack notifications
  294. SEND_SLACK="YES"
  295. # Login to your slack.com workspace and create an incoming webhook, using the "Incoming Webhooks" App: https://slack.com/apps/A0F7XDUAZ-incoming-webhooks
  296. # Do not use the instructions in https://api.slack.com/incoming-webhooks#enable_webhooks, as those webhooks work only for a single channel.
  297. # You need only one for all your netdata servers (or you can have one for each of your netdata).
  298. # Without the app and a webhook, netdata cannot send slack notifications.
  299. SLACK_WEBHOOK_URL=""
  300. # if a role's recipients are not configured, a notification will be send to:
  301. # - A slack channel (syntax: '#channel' or 'channel')
  302. # - A slack user (syntax: '@user')
  303. # - The channel or user defined in slack for the webhook (syntax: '#')
  304. # empty = do not send a notification for unconfigured roles
  305. DEFAULT_RECIPIENT_SLACK=""
  306. #------------------------------------------------------------------------------
  307. # Microsoft Team (office.com) global notification options
  308. # More details are available here regarding the payload syntax options : https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference
  309. # Online designer : https://acdesignerbeta.azurewebsites.net/
  310. # multiple recipients can be given like this:
  311. # "CHANNEL1 CHANNEL2 ..."
  312. # enable/disable sending team notifications
  313. SEND_MSTEAM="YES"
  314. # if a role's recipients are not configured, a notification will be send to
  315. # this slack channel (empty = do not send a notification for unconfigured
  316. # roles):
  317. # For team the channel name is encoded in the URI after ....IncomingWebhook/___/.....
  318. # This value will be replaced in the webhook value to publish to several channels in a same Team.
  319. # In order to get it working properly, you have to replace the value between [] ....IncomingWebhook/[___]/..... by "CHANNEL" string.
  320. DEFAULT_RECIPIENT_MSTEAM=""
  321. # Based on the way MS Teams is working, put the differents channels here like : "CHANNEL1 CHANNEL2 ..."
  322. # AT LEAST ONE CHANNEL IS MANDATORY
  323. MSTEAM_WEBHOOK_URL=""
  324. # Define the default color scheme for alert to MS Team - icon and color
  325. # Icons - go to https://emojipedia.org/bomb/
  326. MSTEAM_ICON_DEFAULT="♡"
  327. MSTEAM_ICON_CLEAR="💚"
  328. MSTEAM_ICON_WARNING="⚠️"
  329. MSTEAM_ICON_CRITICAL="🔥"
  330. # Colors
  331. MSTEAM_COLOR_DEFAULT="0076D7"
  332. MSTEAM_COLOR_CLEAR="65A677"
  333. MSTEAM_COLOR_WARNING="FFA500"
  334. MSTEAM_COLOR_CRITICAL="D93F3C"
  335. #------------------------------------------------------------------------------
  336. # rocketchat (rocket.chat) global notification options
  337. # multiple recipients can be given like this:
  338. # "CHANNEL1 CHANNEL2 ..."
  339. # enable/disable sending rocketchat notifications
  340. SEND_ROCKETCHAT="YES"
  341. # Login to rocket.chat and create an incoming webhook. You need only one for all
  342. # your netdata servers (or you can have one for each of your netdata).
  343. # Without it, netdata cannot send rocketchat notifications.
  344. ROCKETCHAT_WEBHOOK_URL=""
  345. # if a role's recipients are not configured, a notification will be send to
  346. # this rocketchat channel (empty = do not send a notification for unconfigured
  347. # roles):
  348. DEFAULT_RECIPIENT_ROCKETCHAT=""
  349. #------------------------------------------------------------------------------
  350. # alerta (alerta.io) global notification options
  351. # multiple recipients (Environments) can be given like this:
  352. # "Production Development ..."
  353. # enable/disable sending alerta notifications
  354. SEND_ALERTA="YES"
  355. # here set your alerta server API url
  356. # this is the API url you defined when installed Alerta server,
  357. # it is the same for all users. Do not include last slash.
  358. # ALERTA_WEBHOOK_URL="https://<server>/alerta/api"
  359. ALERTA_WEBHOOK_URL=""
  360. # Login with an administrative user to you Alerta server and create an API KEY
  361. # with write permissions.
  362. ALERTA_API_KEY=""
  363. # you can define environments in /etc/alertad.conf option ALLOWED_ENVIRONMENTS
  364. # standard environments are Production and Development
  365. # if a role's recipients are not configured, a notification will be send to
  366. # this Environment (empty = do not send a notification for unconfigured roles):
  367. DEFAULT_RECIPIENT_ALERTA=""
  368. #------------------------------------------------------------------------------
  369. # flock (flock.com) global notification options
  370. # enable/disable sending flock notifications
  371. SEND_FLOCK="YES"
  372. # Login to flock.com and create an incoming webhook. You need only one for all
  373. # your netdata servers (or you can have one for each of your netdata).
  374. # Without it, netdata cannot send flock notifications.
  375. FLOCK_WEBHOOK_URL=""
  376. # if a role recipient is not configured, no notification will be sent
  377. DEFAULT_RECIPIENT_FLOCK=""
  378. #------------------------------------------------------------------------------
  379. # discord (discordapp.com) global notification options
  380. # multiple recipients can be given like this:
  381. # "CHANNEL1 CHANNEL2 ..."
  382. # enable/disable sending discord notifications
  383. SEND_DISCORD="YES"
  384. # Create a webhook by following the official documentation -
  385. # https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
  386. DISCORD_WEBHOOK_URL=""
  387. # if a role's recipients are not configured, a notification will be send to
  388. # this discord channel (empty = do not send a notification for unconfigured
  389. # roles):
  390. DEFAULT_RECIPIENT_DISCORD=""
  391. #------------------------------------------------------------------------------
  392. # hipchat global notification options
  393. # multiple recipients can be given like this:
  394. # "ROOM1 ROOM2 ..."
  395. # enable/disable sending hipchat notifications
  396. SEND_HIPCHAT="YES"
  397. # define hipchat server
  398. HIPCHAT_SERVER="api.hipchat.com"
  399. # api.hipchat.com authorization token
  400. # Without this, netdata cannot send hipchat notifications.
  401. HIPCHAT_AUTH_TOKEN=""
  402. # if a role's recipients are not configured, a notification will be send to
  403. # this hipchat room (empty = do not send a notification for unconfigured
  404. # roles):
  405. DEFAULT_RECIPIENT_HIPCHAT=""
  406. #------------------------------------------------------------------------------
  407. # kafka notification options
  408. # enable/disable sending kafka notifications
  409. SEND_KAFKA="YES"
  410. # The URL to POST kafka alarm data to. It should be the full URL.
  411. KAFKA_URL=""
  412. # The IP to be used in the kafka message as the sender.
  413. KAFKA_SENDER_IP=""
  414. #------------------------------------------------------------------------------
  415. # pagerduty.com notification options
  416. #
  417. # pagerduty.com notifications require a "Generic API" (Events v1)
  418. # pagerduty service.
  419. # https://support.pagerduty.com/docs/services-and-integrations
  420. # multiple recipients can be given like this:
  421. # "<pd_service_key_1> <pd_service_key_2> ..."
  422. # enable/disable sending pagerduty notifications
  423. SEND_PD="YES"
  424. # if a role's recipients are not configured, a notification will be sent to
  425. # the "General API" pagerduty.com service that uses this service key.
  426. # (empty = do not send a notification for unconfigured roles):
  427. DEFAULT_RECIPIENT_PD=""
  428. #------------------------------------------------------------------------------
  429. # fleep notification options
  430. #
  431. # To send fleep.io notifications, you will need a webhook for the
  432. # conversation you want to send to.
  433. # Fleep recipients are specified as the last part of the webhook URL.
  434. # So, for a webhook URL of: https://fleep.io/hook/IJONmBuuSlWlkb_ttqyXJg, the
  435. # recipient name would be: 'IJONmBuuSlWlkb_ttqyXJg'.
  436. # enable/disable sending fleep notifications
  437. SEND_FLEEP="YES"
  438. # if a role's recipients are not configured, a notification will not be sent.
  439. # (empty = do not send a notification for unconfigured roles):
  440. DEFAULT_RECIPIENT_FLEEP=""
  441. # The user name to label the messages with. If this is unset,
  442. # the hostname of the system the notification is for will be used.
  443. FLEEP_SENDER=""
  444. #------------------------------------------------------------------------------
  445. # irc notification options
  446. #
  447. # irc notifications require only the nc utility to be installed.
  448. # multiple recipients can be given like this:
  449. # "<irc_channel_1> <irc_channel_2> ..."
  450. # enable/disable sending irc notifications
  451. SEND_IRC="YES"
  452. # if a role's recipients are not configured, a notification will not be sent.
  453. # (empty = do not send a notification for unconfigured roles):
  454. DEFAULT_RECIPIENT_IRC=""
  455. # The irc network to which the recipients belong. It must be the full network.
  456. # e.g. "irc.freenode.net"
  457. IRC_NETWORK=""
  458. # The irc nickname which is required to send the notification. It must not be
  459. # an already registered name as the connection's MODE is defined as a 'guest'.
  460. IRC_NICKNAME=""
  461. # The irc realname which is required in order to make the connection and is an
  462. # extra identifier.
  463. IRC_REALNAME=""
  464. #------------------------------------------------------------------------------
  465. # syslog notifications
  466. #
  467. # syslog notifications only need you to have a working logger command, which
  468. # should be the case on pretty much any Linux system.
  469. # enable/disable sending syslog notifications
  470. # NOTE: make sure you have everything else configured the way you want
  471. # it _before_ turning this on.
  472. SEND_SYSLOG="NO"
  473. # A note on log levels and facilities:
  474. #
  475. # The traditional UNIX syslog mechanism has the concept of both log
  476. # levels and facilities. A log level indicates the relaitve severity of
  477. # the message, while a facility specifies a generic source for the message
  478. # (for example, the `mail` facility is where sendmail and postfix log
  479. # their messages). All major syslog daemons have the ability to filter
  480. # messages based on both log level and facility, and can often also make
  481. # routing decisions for messages based on both factors.
  482. #
  483. # On Linux, the eight log levels in decreasing order of severity are:
  484. # emerg, alert, crit, err, warning, notice, info, debug
  485. #
  486. # By default, warnings will be logged at the warning level, critical
  487. # alerts at the crit level, and clear notifications at the invo level.
  488. #
  489. # And the 19 facilities you can log to are:
  490. # auth, authpriv, cron, daemon, ftp, lpr, mail, news, syslog, user,
  491. # uucp, local0, local1, local2, local3, local4, local5, local6, and local7
  492. #
  493. # By default, netdata alerts will be logged to the local6 facility.
  494. #
  495. # Depending on your distribution, this means that either all your
  496. # netdata alerts will by default end up in the main system log (usually
  497. # /var/log/messages), or they won't be logged to a file at all.
  498. # Neither of these are likely to be what you actually want, but any
  499. # configuration to change that needs to happen in the syslog daemon
  500. # configuration, not here.
  501. # This controls which facility is used by defalt for logging. Defaults
  502. # to local6.
  503. SYSLOG_FACILITY=''
  504. # If a role's recipients are not configured, use the following.
  505. # (empty = do not send a notification for unconfigured roles)
  506. #
  507. # The recipient format for syslog uses the following format:
  508. # [[facility.level][@host[:port]]/]prefix
  509. #
  510. # `prefix` gets appended to the front of all log messages generated for
  511. # that recipient. The prefix is mandatory.
  512. # 'host' and 'port' can be used to specify a remote syslog server to
  513. # send messages to. Leave these out if you want messages to be delivered
  514. # locally. 'host' can be either a hostname or an IP address.
  515. # IPv6 addresses must have square around them.
  516. # 'facility' and 'level' are used to override the default logging facility
  517. # set above and the log level. If one is specified, both must be present.
  518. #
  519. # For example, to send messages with a 'netdata' prefix to a syslog
  520. # daemon listening on port 514 on 'loghost' using the daemon facility and
  521. # notice log level:
  522. # DEFAULT_RECIPIENT_SYSLOG='daemon.notice@loghost:514/netdata'
  523. #
  524. DEFAULT_RECIPIENT_SYSLOG="netdata"
  525. #------------------------------------------------------------------------------
  526. # iOS Push Notifications
  527. # enable/disable sending iOS push notifications
  528. SEND_PROWL="YES"
  529. # If a role's recipients are not configured, use the following,
  530. # (empty = do not send a notiication for unconfigured roles)
  531. #
  532. # Recipients for iOS push notifications are Prowl API keys.
  533. #
  534. # A recipient may also consist of multiple Prowl API keys separated by
  535. # commas, in which case notifications will be simultaneously sent for all
  536. # of those API keys.
  537. DEFAULT_RECIPIENT_PROWL=""
  538. #------------------------------------------------------------------------------
  539. # Amazon SNS notifications
  540. #
  541. # This method requires potentially complex manual configuration. See the
  542. # netdata wiki for information on what is needed.
  543. # enable/disable sending Amazon SNS notifications
  544. SEND_AWSSNS="YES"
  545. # Specify a template for the Amazon SNS notifications. This supports
  546. # the same set of variables that are usable in the `custom_sender()`
  547. # function in the custom notification configuration below.
  548. #
  549. AWSSNS_MESSAGE_FORMAT="${status} on ${host} at ${date}: ${chart} ${value_string}"
  550. # If a role's recipients are not configured, use the following.
  551. # (empty = do not send a notification for unconfigured roles)
  552. #
  553. # Recipients for AWS SNS notifications are specified as topic ARN's.
  554. #
  555. DEFAULT_RECIPIENT_AWSSNS=""
  556. #------------------------------------------------------------------------------
  557. # SMS Server Tools 3 (smstools3) global notification options
  558. # enable/disable sending SMS Server Tools 3 SMS notifications
  559. SEND_SMS="YES"
  560. # if a role's recipients are not configured, a notification will be sent to
  561. # this SMS channel (empty = do not send a notification for unconfigured
  562. # roles). Multiple recipients can be given like this: "PHONE1 PHONE2 ..."
  563. DEFAULT_RECIPIENT_SMS=""
  564. #------------------------------------------------------------------------------
  565. # custom notifications
  566. #
  567. # enable/disable sending custom notifications
  568. SEND_CUSTOM="YES"
  569. # if a role's recipients are not configured, use the following.
  570. # (empty = do not send a notification for unconfigured roles)
  571. DEFAULT_RECIPIENT_CUSTOM=""
  572. # The custom_sender() is a custom function to do whatever you need to do
  573. custom_sender() {
  574. # variables you can use:
  575. # ${host} the host generated this event
  576. # ${url_host} same as ${host} but URL encoded
  577. # ${unique_id} the unique id of this event
  578. # ${alarm_id} the unique id of the alarm that generated this event
  579. # ${event_id} the incremental id of the event, for this alarm id
  580. # ${when} the timestamp this event occurred
  581. # ${name} the name of the alarm, as given in netdata health.d entries
  582. # ${url_name} same as ${name} but URL encoded
  583. # ${chart} the name of the chart (type.id)
  584. # ${url_chart} same as ${chart} but URL encoded
  585. # ${family} the family of the chart
  586. # ${url_family} same as ${family} but URL encoded
  587. # ${status} the current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
  588. # ${old_status} the previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
  589. # ${value} the current value of the alarm
  590. # ${old_value} the previous value of the alarm
  591. # ${src} the line number and file the alarm has been configured
  592. # ${duration} the duration in seconds of the previous alarm state
  593. # ${duration_txt} same as ${duration} for humans
  594. # ${non_clear_duration} the total duration in seconds this is/was non-clear
  595. # ${non_clear_duration_txt} same as ${non_clear_duration} for humans
  596. # ${units} the units of the value
  597. # ${info} a short description of the alarm
  598. # ${value_string} friendly value (with units)
  599. # ${old_value_string} friendly old value (with units)
  600. # ${image} the URL of an image to represent the status of the alarm
  601. # ${color} a color in #AABBCC format for the alarm
  602. # ${goto_url} the URL the user can click to see the netdata dashboard
  603. # ${calc_expression} the expression evaluated to provide the value for the alarm
  604. # ${calc_param_values} the value of the variables in the evaluated expression
  605. # ${total_warnings} the total number of alarms in WARNING state on the host
  606. # ${total_critical} the total number of alarms in CRITICAL state on the host
  607. # these are more human friendly:
  608. # ${alarm} like "name = value units"
  609. # ${status_message} like "needs attention", "recovered", "is critical"
  610. # ${severity} like "Escalated to CRITICAL", "Recovered from WARNING"
  611. # ${raised_for} like "(alarm was raised for 10 minutes)"
  612. # example human readable SMS
  613. local msg="${host} ${status_message}: ${alarm} ${raised_for}"
  614. # limit it to 160 characters and encode it for use in a URL
  615. urlencode "${msg:0:160}" >/dev/null; msg="${REPLY}"
  616. # a space separated list of the recipients to send alarms to
  617. to="${1}"
  618. # Sample send SMS to an imaginary SMS gateway accessible via HTTPS
  619. #for phone in ${to}; do
  620. # httpcode=$(docurl -X POST \
  621. # --data-urlencode "From=XXX" \
  622. # --data-urlencode "To=${phone}" \
  623. # --data-urlencode "Body=${msg}" \
  624. # -u "${accountsid}:${accounttoken}" \
  625. # https://domain.website.com/)
  626. #
  627. # if [ "${httpcode}" = "200" ]; then
  628. # info "sent custom notification ${msg} to ${phone}"
  629. # sent=$((sent + 1))
  630. # else
  631. # error "failed to send custom notification ${msg} to ${phone} with HTTP error code ${httpcode}."
  632. # fi
  633. #done
  634. info "not sending custom notification to ${to}, for ${status} of '${host}.${chart}.${name}' - custom_sender() is not configured."
  635. }
  636. ###############################################################################
  637. # RECIPIENTS PER ROLE
  638. # -----------------------------------------------------------------------------
  639. # generic system alarms
  640. # CPU, disks, network interfaces, entropy, etc
  641. role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
  642. role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
  643. role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  644. role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
  645. role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
  646. role_recipients_alerta[sysadmin]="${DEFAULT_RECIPIENT_ALERTA}"
  647. role_recipients_flock[sysadmin]="${DEFAULT_RECIPIENT_FLOCK}"
  648. role_recipients_discord[sysadmin]="${DEFAULT_RECIPIENT_DISCORD}"
  649. role_recipients_hipchat[sysadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
  650. role_recipients_twilio[sysadmin]="${DEFAULT_RECIPIENT_TWILIO}"
  651. role_recipients_messagebird[sysadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  652. role_recipients_kavenegar[sysadmin]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  653. role_recipients_pd[sysadmin]="${DEFAULT_RECIPIENT_PD}"
  654. role_recipients_fleep[sysadmin]="${DEFAULT_RECIPIENT_FLEEP}"
  655. role_recipients_irc[sysadmin]="${DEFAULT_RECIPIENT_IRC}"
  656. role_recipients_syslog[sysadmin]="${DEFAULT_RECIPIENT_SYSLOG}"
  657. role_recipients_prowl[sysadming]="${DEFAULT_RECIPIENT_PROWL}"
  658. role_recipients_awssns[sysadmin]="${DEFAULT_RECIPIENT_AWSSNS}"
  659. role_recipients_custom[sysadmin]="${DEFAULT_RECIPIENT_CUSTOM}"
  660. role_recipients_msteam[sysadmin]="${DEFAULT_RECIPIENT_MSTEAM}"
  661. role_recipients_rocketchat[sysadmin]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  662. # -----------------------------------------------------------------------------
  663. # DNS related alarms
  664. role_recipients_email[domainadmin]="${DEFAULT_RECIPIENT_EMAIL}"
  665. role_recipients_pushover[domainadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
  666. role_recipients_pushbullet[domainadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  667. role_recipients_telegram[domainadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
  668. role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
  669. role_recipients_alerta[domainadmin]="${DEFAULT_RECIPIENT_ALERTA}"
  670. role_recipients_flock[domainadmin]="${DEFAULT_RECIPIENT_FLOCK}"
  671. role_recipients_discord[domainadmin]="${DEFAULT_RECIPIENT_DISCORD}"
  672. role_recipients_hipchat[domainadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
  673. role_recipients_twilio[domainadmin]="${DEFAULT_RECIPIENT_TWILIO}"
  674. role_recipients_messagebird[domainadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  675. role_recipients_kavenegar[domainadmin]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  676. role_recipients_pd[domainadmin]="${DEFAULT_RECIPIENT_PD}"
  677. role_recipients_fleep[domainadmin]="${DEFAULT_RECIPIENT_FLEEP}"
  678. role_recipients_irc[domainadmin]="${DEFAULT_RECIPIENT_IRC}"
  679. role_recipients_syslog[domainadmin]="${DEFAULT_RECIPIENT_SYSLOG}"
  680. role_recipients_prowl[domainadmin]="${DEFAULT_RECIPIENT_PROWL}"
  681. role_recipients_awssns[domainadmin]="${DEFAULT_RECIPIENT_AWSSNS}"
  682. role_recipients_custom[domainadmin]="${DEFAULT_RECIPIENT_CUSTOM}"
  683. role_recipients_msteam[domainadmin]="${DEFAULT_RECIPIENT_MSTEAM}"
  684. role_recipients_rocketchat[domainadmin]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  685. role_recipients_sms[domainadmin]="${DEFAULT_RECIPIENT_SMS}"
  686. # -----------------------------------------------------------------------------
  687. # database servers alarms
  688. # mysql, redis, memcached, postgres, etc
  689. role_recipients_email[dba]="${DEFAULT_RECIPIENT_EMAIL}"
  690. role_recipients_pushover[dba]="${DEFAULT_RECIPIENT_PUSHOVER}"
  691. role_recipients_pushbullet[dba]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  692. role_recipients_telegram[dba]="${DEFAULT_RECIPIENT_TELEGRAM}"
  693. role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
  694. role_recipients_alerta[dba]="${DEFAULT_RECIPIENT_ALERTA}"
  695. role_recipients_flock[dba]="${DEFAULT_RECIPIENT_FLOCK}"
  696. role_recipients_discord[dba]="${DEFAULT_RECIPIENT_DISCORD}"
  697. role_recipients_hipchat[dba]="${DEFAULT_RECIPIENT_HIPCHAT}"
  698. role_recipients_twilio[dba]="${DEFAULT_RECIPIENT_TWILIO}"
  699. role_recipients_messagebird[dba]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  700. role_recipients_kavenegar[dba]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  701. role_recipients_pd[dba]="${DEFAULT_RECIPIENT_PD}"
  702. role_recipients_fleep[dba]="${DEFAULT_RECIPIENT_FLEEP}"
  703. role_recipients_irc[dba]="${DEFAULT_RECIPIENT_IRC}"
  704. role_recipients_syslog[dba]="${DEFAULT_RECIPIENT_SYSLOG}"
  705. role_recipients_prowl[dba]="${DEFAULT_RECIPIENT_PROWL}"
  706. role_recipients_awssns[dba]="${DEFAULT_RECIPIENT_AWSSNS}"
  707. role_recipients_custom[dba]="${DEFAULT_RECIPIENT_CUSTOM}"
  708. role_recipients_msteam[dba]="${DEFAULT_RECIPIENT_MSTEAM}"
  709. role_recipients_rocketchat[dba]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  710. role_recipients_sms[dba]="${DEFAULT_RECIPIENT_SMS}"
  711. # -----------------------------------------------------------------------------
  712. # web servers alarms
  713. # apache, nginx, lighttpd, etc
  714. role_recipients_email[webmaster]="${DEFAULT_RECIPIENT_EMAIL}"
  715. role_recipients_pushover[webmaster]="${DEFAULT_RECIPIENT_PUSHOVER}"
  716. role_recipients_pushbullet[webmaster]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  717. role_recipients_telegram[webmaster]="${DEFAULT_RECIPIENT_TELEGRAM}"
  718. role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
  719. role_recipients_alerta[webmaster]="${DEFAULT_RECIPIENT_ALERTA}"
  720. role_recipients_flock[webmaster]="${DEFAULT_RECIPIENT_FLOCK}"
  721. role_recipients_discord[webmaster]="${DEFAULT_RECIPIENT_DISCORD}"
  722. role_recipients_hipchat[webmaster]="${DEFAULT_RECIPIENT_HIPCHAT}"
  723. role_recipients_twilio[webmaster]="${DEFAULT_RECIPIENT_TWILIO}"
  724. role_recipients_messagebird[webmaster]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  725. role_recipients_kavenegar[webmaster]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  726. role_recipients_pd[webmaster]="${DEFAULT_RECIPIENT_PD}"
  727. role_recipients_fleep[webmaster]="${DEFAULT_RECIPIENT_FLEEP}"
  728. role_recipients_irc[webmaster]="${DEFAULT_RECIPIENT_IRC}"
  729. role_recipients_syslog[webmaster]="${DEFAULT_RECIPIENT_SYSLOG}"
  730. role_recipients_prowl[webmaster]="${DEFAULT_RECIPIENT_PROWL}"
  731. role_recipients_awssns[webmaster]="${DEFAULT_RECIPIENT_AWSSNS}"
  732. role_recipients_custom[webmaster]="${DEFAULT_RECIPIENT_CUSTOM}"
  733. role_recipients_msteam[webmaster]="${DEFAULT_RECIPIENT_MSTEAM}"
  734. role_recipients_rocketchat[webmaster]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  735. role_recipients_sms[webmaster]="${DEFAULT_RECIPIENT_SMS}"
  736. # -----------------------------------------------------------------------------
  737. # proxy servers alarms
  738. # squid, etc
  739. role_recipients_email[proxyadmin]="${DEFAULT_RECIPIENT_EMAIL}"
  740. role_recipients_pushover[proxyadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
  741. role_recipients_pushbullet[proxyadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  742. role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
  743. role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
  744. role_recipients_alerta[proxyadmin]="${DEFAULT_RECIPIENT_ALERTA}"
  745. role_recipients_flock[proxyadmin]="${DEFAULT_RECIPIENT_FLOCK}"
  746. role_recipients_discord[proxyadmin]="${DEFAULT_RECIPIENT_DISCORD}"
  747. role_recipients_hipchat[proxyadmin]="${DEFAULT_RECIPIENT_HIPCHAT}"
  748. role_recipients_twilio[proxyadmin]="${DEFAULT_RECIPIENT_TWILIO}"
  749. role_recipients_messagebird[proxyadmin]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  750. role_recipients_kavenegar[proxyadmin]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  751. role_recipients_pd[proxyadmin]="${DEFAULT_RECIPIENT_PD}"
  752. role_recipients_fleep[proxyadmin]="${DEFAULT_RECIPIENT_FLEEP}"
  753. role_recipients_irc[proxyadmin]="${DEFAULT_RECIPIENT_IRC}"
  754. role_recipients_syslog[proxyadmin]="${DEFAULT_RECIPIENT_SYSLOG}"
  755. role_recipients_prowl[proxyadmin]="${DEFAULT_RECIPIENT_PROWL}"
  756. role_recipients_awssns[porxyadmin]="${DEFAULT_RECIPIENT_AWSSNS}"
  757. role_recipients_custom[proxyadmin]="${DEFAULT_RECIPIENT_CUSTOM}"
  758. role_recipients_msteam[proxyadmin]="${DEFAULT_RECIPIENT_MSTEAM}"
  759. role_recipients_rocketchat[proxyadmin]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  760. role_recipients_sms[proxyadmin]="${DEFAULT_RECIPIENT_SMS}"
  761. # -----------------------------------------------------------------------------
  762. # peripheral devices
  763. # UPS, photovoltaics, etc
  764. role_recipients_email[sitemgr]="${DEFAULT_RECIPIENT_EMAIL}"
  765. role_recipients_pushover[sitemgr]="${DEFAULT_RECIPIENT_PUSHOVER}"
  766. role_recipients_pushbullet[sitemgr]="${DEFAULT_RECIPIENT_PUSHBULLET}"
  767. role_recipients_telegram[sitemgr]="${DEFAULT_RECIPIENT_TELEGRAM}"
  768. role_recipients_slack[sitemgr]="${DEFAULT_RECIPIENT_SLACK}"
  769. role_recipients_alerta[sitemgr]="${DEFAULT_RECIPIENT_ALERTA}"
  770. role_recipients_flock[sitemgr]="${DEFAULT_RECIPIENT_FLOCK}"
  771. role_recipients_discord[sitemgr]="${DEFAULT_RECIPIENT_DISCORD}"
  772. role_recipients_hipchat[sitemgr]="${DEFAULT_RECIPIENT_HIPCHAT}"
  773. role_recipients_twilio[sitemgr]="${DEFAULT_RECIPIENT_TWILIO}"
  774. role_recipients_messagebird[sitemgr]="${DEFAULT_RECIPIENT_MESSAGEBIRD}"
  775. role_recipients_kavenegar[sitemgr]="${DEFAULT_RECIPIENT_KAVENEGAR}"
  776. role_recipients_pd[sitemgr]="${DEFAULT_RECIPIENT_PD}"
  777. role_recipients_fleep[sitemgr]="${DEFAULT_RECIPIENT_FLEEP}"
  778. role_recipients_syslog[sitemgr]="${DEFAULT_RECIPIENT_SYSLOG}"
  779. role_recipients_prowl[sitemgr]="${DEFAULT_RECIPIENT_PROWL}"
  780. role_recipients_awssns[sitemgr]="${DEFAULT_RECIPIENT_AWSSNS}"
  781. role_recipients_custom[sitemgr]="${DEFAULT_RECIPIENT_CUSTOM}"
  782. role_recipients_msteam[sitemgr]="${DEFAULT_RECIPIENT_MSTEAM}"
  783. role_recipients_rocketchat[sitemgr]="${DEFAULT_RECIPIENT_ROCKETCHAT}"
  784. role_recipients_sms[sitemgr]="${DEFAULT_RECIPIENT_SMS}"