Mapping roles to service keys and allowing multiple service keys for pagerduty.com...

[netdata.git] / conf.d / health_alarm_notify.conf

diff --git a/conf.d/health_alarm_notify.conf b/conf.d/health_alarm_notify.conf
index 33a752f9ed31f6e663b55246e69c3088faf94635..dea4ea0511244604f62dae9f996b69a29af6545e 100644 (file)
--- a/conf.d/health_alarm_notify.conf
+++ b/conf.d/health_alarm_notify.conf
@@ -9,6 +9,7 @@
 # - messages to your slack team (slack.com),
 # - messages to your telegram chat / group chat (telegram.org)
 # - sms messages to your cell phone or any sms enabled device (twilio.com)
+# - notifications to users on pagerduty.com
 #
 # The 'to' line given at netdata alarms defines a *role*, so that many
 # people can be notified for each role.
@@ -16,7 +17,7 @@
 # This file is a BASH script itself.
 #
 #
-###############################################################################
+#------------------------------------------------------------------------------
 # proxy configuration
 #
 # If you need to send curl based notifications (pushover, pushbullet, slack,
@@ -25,7 +26,7 @@
 #export https_proxy="http://10.0.0.1:3128/"
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # notifications images
 #
 # Images in notifications need to be downloaded from an Internet facing site.
@@ -37,7 +38,7 @@
 #images_base_url="http://my.public.netdata.server:19999"
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # external commands
 
 # The full path to the sendmail command.
@@ -52,7 +53,7 @@ sendmail=""
 curl=""
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # NOTE ABOUT RECIPIENTS
 #
 # When you define recipients (all types):
@@ -62,6 +63,7 @@ curl=""
 #  - telegram chat ids
 #  - slack channels
 #  - sms phone numbers
+#  - pagerduty.com (pd) services
 #
 # You can append |critical to limit the notifications to be sent.
 #
@@ -73,14 +75,15 @@ curl=""
 #  telegram: "111827421 112746832|critical"
 #  slack   : "alarms disasters|critical"
 #  twilio  : "+15555555555 +17777777777|critical"
+#  pd      : "<pd_service_key_1> <pd_service_key_2>|critical"
 #
 # If a recipient is set to empty string, the default recipient of the given
-# notification method (email, pushover, telegram, slack) will be used.
+# notification method (email, pushover, telegram, slack, pd) will be used.
 # To disable a notification, use the recipient called: disabled
 # This works for all notification methods (including the default recipients).
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # email global notification options
 
 # multiple recipients can be given like this:
@@ -94,7 +97,7 @@ DEFAULT_RECIPIENT_EMAIL="root"
 # to receive only critical alarms, set it to "root|critical"
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # pushover (pushover.net) global notification options
 
 # multiple recipients can be given like this:
@@ -115,7 +118,7 @@ PUSHOVER_APP_TOKEN=""
 DEFAULT_RECIPIENT_PUSHOVER=""
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # pushbullet (pushbullet.com) push notification options
 
 # multiple recipients can be given like this:
@@ -136,7 +139,7 @@ SEND_PUSHBULLET="YES"
 PUSHBULLET_ACCESS_TOKEN=""
 DEFAULT_RECIPIENT_PUSHBULLET=""
 
-###############################################################################
+#------------------------------------------------------------------------------
 # Twilio (twilio.com) SMS options
 
 # multiple recipients can be given like this:
@@ -157,7 +160,7 @@ TWILIO_ACCOUNT_TOKEN=""
 TWILIO_NUMBER=""
 DEFAULT_RECIPIENT_TWILIO=""
 
-###############################################################################
+#------------------------------------------------------------------------------
 # telegram (telegram.org) global notification options
 
 # To get your chat ID send the command /my_id to telegram bot @get_id.
@@ -178,7 +181,7 @@ TELEGRAM_BOT_TOKEN=""
 DEFAULT_RECIPIENT_TELEGRAM=""
 
 
-###############################################################################
+#------------------------------------------------------------------------------
 # slack (slack.com) global notification options
 
 # multiple recipients can be given like this:
@@ -199,6 +202,38 @@ SLACK_WEBHOOK_URL=""
 DEFAULT_RECIPIENT_SLACK=""
 
 
+#------------------------------------------------------------------------------
+# kafka notification options
+
+# enable/disable sending kafka notifications
+SEND_KAFKA="YES"
+
+# The URL to POST kafka alarm data to. It should be the full URL.
+KAFKA_URL=""
+
+# The IP to be used in the kafka message as the sender.
+KAFKA_SENDER_IP=""
+
+
+#------------------------------------------------------------------------------
+# pagerduty.com notification options
+#
+# pagerduty.com notifications require the pagerduty agent to be installed and 
+# a "Generic API" pagerduty service.
+# https://www.pagerduty.com/docs/guides/agent-install-guide/
+
+# multiple recipients can be given like this:
+#              "<pd_service_key_1> <pd_service_key_2> ..."
+
+# enable/disable sending pagerduty notifications
+SEND_PD="YES"
+
+# if a role's recipients are not configured, a notification will be sent to
+# the "General API" pagerduty.com service that uses this service key.
+# (empty = do not send a notification for unconfigured roles):
+DEFAULT_RECIPIENT_PD=""
+
+
 ###############################################################################
 # RECIPIENTS PER ROLE
 
@@ -218,6 +253,8 @@ role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
 
 role_recipients_twilio[sysadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 
+role_recipients_pd[sysadmin]="${DEFAULT_RECIPIENT_PD}"
+
 # -----------------------------------------------------------------------------
 # DNS related alarms
 
@@ -233,6 +270,8 @@ role_recipients_slack[domainadmin]="${DEFAULT_RECIPIENT_SLACK}"
 
 role_recipients_twilio[domainadmin]="${DEFAULT_RECIPIENT_TWILIO}"
 
+role_recipients_pd[domainadmin]="${DEFAULT_RECIPIENT_PD}"
+
 # -----------------------------------------------------------------------------
 # database servers alarms
 # mysql, redis, memcached, etc
@@ -249,6 +288,8 @@ role_recipients_slack[dba]="${DEFAULT_RECIPIENT_SLACK}"
 
 role_recipients_twilio[dba]="${DEFAULT_RECIPIENT_TWILIO}"
 
+role_recipients_pd[dba]="${DEFAULT_RECIPIENT_PD}"
+
 # -----------------------------------------------------------------------------
 # web servers alarms
 # apache, nginx, etc
@@ -265,6 +306,8 @@ role_recipients_slack[webmaster]="${DEFAULT_RECIPIENT_SLACK}"
 
 role_recipients_twilio[webmaster]="${DEFAULT_RECIPIENT_TWILIO}"
 
+role_recipients_pd[webmaster]="${DEFAULT_RECIPIENT_PD}"
+
 # -----------------------------------------------------------------------------
 # proxy servers alarms
 # apache, nginx, etc
@@ -280,3 +323,5 @@ role_recipients_telegram[proxyadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
 role_recipients_slack[proxyadmin]="${DEFAULT_RECIPIENT_SLACK}"
 
 role_recipients_twilio[proxyadmin]="${DEFAULT_RECIPIENT_TWILIO}"
+
+role_recipients_pd[proxyadmin]="${DEFAULT_RECIPIENT_PD}"