diff options
| -rw-r--r-- | CONTRIBUTORS.md | 1 | ||||
| -rwxr-xr-x | conf.d/health_alarm_notify.conf | 45 | ||||
| -rwxr-xr-x | plugins.d/alarm-notify.sh | 92 |
3 files changed, 137 insertions, 1 deletions
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 7d2d930074..b8d4cad0d2 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -93,3 +93,4 @@ username|name|email (optional) @shadycuz|Levi Blaney|shadycuz+spam@gmail.com @Flums|Philip Gabrielsen|philip@digno.no @domschl|Dominik Schlösser|dominik.schloesser@gmail.com +@tioumen|Guillaume Hospital diff --git a/conf.d/health_alarm_notify.conf b/conf.d/health_alarm_notify.conf index 4e800dcab9..58c09bad59 100755 --- a/conf.d/health_alarm_notify.conf +++ b/conf.d/health_alarm_notify.conf @@ -16,6 +16,7 @@ # - notifications to users on pagerduty.com # - messages to your irc channel on your selected network # - messages to a local or remote syslog daemon +# - message to Microsoft Team (thru webhook) # # The 'to' line given at netdata alarms defines a *role*, so that many # people can be notified for each role. @@ -333,6 +334,38 @@ SLACK_WEBHOOK_URL="" DEFAULT_RECIPIENT_SLACK="" #------------------------------------------------------------------------------ +# Microsoft Team (office.com) global notification options +# More details are available here regarding the payload syntax options : https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference +# Online designer : https://acdesignerbeta.azurewebsites.net/ +# multiple recipients can be given like this: +# "CHANNEL1 CHANNEL2 ..." + +# enable/disable sending team notifications +SEND_MSTEAM="YES" + +MSTEAM_WEBHOOK_URL="" + +# if a role's recipients are not configured, a notification will be send to +# this slack channel (empty = do not send a notification for unconfigured +# roles): +# For team the channel name is encoded in the URI after ....IncomingWebhook/___/..... +DEFAULT_RECIPIENT_MSTEAM="" + +# Define the default color scheme for alert to MS Team - icon and color +# Icons - go to https://emojipedia.org/bomb/ +MSTEAM_ICON_DEFAULT="♡" +MSTEAM_ICON_CLEAR="💚" +MSTEAM_ICON_WARNING="⚠️" +MSTEAM_ICON_CRITICAL="🔥" + +# Colors +MSTEAM_COLOR_DEFAULT="0076D7" +MSTEAM_COLOR_CLEAR="65A677" +MSTEAM_COLOR_WARNING="FFA500" +MSTEAM_COLOR_CRITICAL="D93F3C" + + +#------------------------------------------------------------------------------ # rocketchat (rocket.chat) global notification options # multiple recipients can be given like this: @@ -685,6 +718,8 @@ role_recipients_syslog[sysadmin]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[sysadmin]="${DEFAULT_RECIPIENT_CUSTOM}" +role_recipients_msteam[sysadmin]="${DEFAULT_RECIPIENT_MSTEAM}" + # ----------------------------------------------------------------------------- # DNS related alarms @@ -722,6 +757,8 @@ role_recipients_syslog[domainadmin]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[domainadmin]="${DEFAULT_RECIPIENT_CUSTOM}" +role_recipients_msteam[domainadmin]="${DEFAULT_RECIPIENT_MSTEAM}" + # ----------------------------------------------------------------------------- # database servers alarms # mysql, redis, memcached, postgres, etc @@ -760,6 +797,8 @@ role_recipients_syslog[dba]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[dba]="${DEFAULT_RECIPIENT_CUSTOM}" +role_recipients_msteam[dba]="${DEFAULT_RECIPIENT_MSTEAM}" + # ----------------------------------------------------------------------------- # web servers alarms # apache, nginx, lighttpd, etc @@ -798,6 +837,8 @@ role_recipients_syslog[webmaster]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[webmaster]="${DEFAULT_RECIPIENT_CUSTOM}" +role_recipients_msteam[webmaster]="${DEFAULT_RECIPIENT_MSTEAM}" + # ----------------------------------------------------------------------------- # proxy servers alarms # squid, etc @@ -836,6 +877,8 @@ role_recipients_syslog[proxyadmin]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[proxyadmin]="${DEFAULT_RECIPIENT_CUSTOM}" +role_recipients_msteam[proxyadmin]="${DEFAULT_RECIPIENT_MSTEAM}" + # ----------------------------------------------------------------------------- # peripheral devices # UPS, photovoltaics, etc @@ -871,3 +914,5 @@ role_recipients_fleep[sitemgr]="${DEFAULT_RECIPIENT_FLEEP}" role_recipients_syslog[sitemgr]="${DEFAULT_RECIPIENT_SYSLOG}" role_recipients_custom[sitemgr]="${DEFAULT_RECIPIENT_CUSTOM}" + +role_recipients_msteam[sitemgr]="${DEFAULT_RECIPIENT_MSTEAM}"
\ No newline at end of file diff --git a/plugins.d/alarm-notify.sh b/plugins.d/alarm-notify.sh index 373026f706..d5ee7abd09 100755 --- a/plugins.d/alarm-notify.sh +++ b/plugins.d/alarm-notify.sh @@ -29,10 +29,12 @@ # - fleep notifications by @Ferroin # - custom notifications by @ktsaou # - syslog messages by @Ferroin +# - Microsoft Team notification by @tioumen # ----------------------------------------------------------------------------- # testing notifications + if [ \( "${1}" = "test" -o "${2}" = "test" \) -a "${#}" -le 2 ] then if [ "${2}" = "test" ] @@ -218,7 +220,7 @@ fi images_base_url="https://registry.my-netdata.io" # curl options to use -curl_options= +curl_options="" # needed commands # if empty they will be searched in the system path @@ -227,6 +229,7 @@ sendmail= # enable / disable features SEND_SLACK="YES" +SEND_MSTEAM="YES" SEND_ALERTA="YES" SEND_FLOCK="YES" SEND_DISCORD="YES" @@ -250,6 +253,11 @@ SLACK_WEBHOOK_URL= DEFAULT_RECIPIENT_SLACK= declare -A role_recipients_slack=() +# Microsoft Team configs +MSTEAM_WEBHOOK_URL= +DEFAULT_RECIPIENT_MSTEAM= +declare -A role_recipients_msteam=() + # rocketchat configs ROCKETCHAT_WEBHOOK_URL= DEFAULT_RECIPIENT_ROCKETCHAT= @@ -426,6 +434,7 @@ filter_recipient_by_criticality() { # find the recipients' addresses per method declare -A arr_slack=() +declare -A arr_msteam=() declare -A arr_rocketchat=() declare -A arr_alerta=() declare -A arr_flock=() @@ -524,6 +533,14 @@ do [ "${r}" != "disabled" ] && filter_recipient_by_criticality slack "${r}" && arr_slack[${r/|*/}]="1" done + # Microsoft Team + a="${role_recipients_msteam[${x}]}" + [ -z "${a}" ] && a="${DEFAULT_RECIPIENT_MSTEAM}" + for r in ${a//,/ } + do + [ "${r}" != "disabled" ] && filter_recipient_by_criticality msteam "${r}" && arr_msteam[${r/|*/}]="1" + done + # rocketchat a="${role_recipients_rocketchat[${x}]}" [ -z "${a}" ] && a="${DEFAULT_RECIPIENT_ROCKETCHAT}" @@ -602,6 +619,10 @@ done to_slack="${!arr_slack[*]}" [ -z "${to_slack}" ] && SEND_SLACK="NO" +# build the list of Microsoft team recipients (channels) +to_msteam="${!arr_msteam[*]}" +[ -z "${to_msteam}" ] && SEND_MSTEAM="NO" + # build the list of rocketchat recipients (channels) to_rocketchat="${!arr_rocketchat[*]}" [ -z "${to_rocketchat}" ] && SEND_ROCKETCHAT="NO" @@ -753,6 +774,7 @@ if [ \( \ -o "${SEND_KAFKA}" = "YES" \ -o "${SEND_FLEEP}" = "YES" \ -o "${SEND_CUSTOM}" = "YES" \ + -o "${SEND_MSTEAM}" = "YES" \ \) -a -z "${curl}" ] then curl="$(which curl 2>/dev/null || command -v curl 2>/dev/null)" @@ -763,6 +785,7 @@ if [ \( \ SEND_PUSHBULLET="NO" SEND_TELEGRAM="NO" SEND_SLACK="NO" + SEND_MSTEAM="NO" SEND_ROCKETCHAT="NO" SEND_ALERTA="NO" SEND_FLOCK="NO" @@ -819,6 +842,7 @@ if [ "${SEND_EMAIL}" != "YES" \ -a "${SEND_CUSTOM}" != "YES" \ -a "${SEND_IRC}" != "YES" \ -a "${SEND_SYSLOG}" != "YES" \ + -a "${SEND_MSTEAM}" != "YES" \ ] then fatal "All notification methods are disabled. Not sending notification for host '${host}', chart '${chart}' to '${roles}' for '${name}' = '${value}' for status '${status}'." @@ -1339,6 +1363,62 @@ send_telegram() { } # ----------------------------------------------------------------------------- +# Microsoft Team sender + +send_msteam() { + + local webhook="${1}" channels="${2}" httpcode sent=0 channel color payload + + [ "${SEND_MSTEAM}" != "YES" ] && return 1 + + case "${status}" in + WARNING) icon="${MSTEAM_ICON_WARNING}" && color="${MSTEAM_COLOR_WARNING}";; + CRITICAL) icon="${MSTEAM_ICON_CRITICAL}" && color="${MSTEAM_COLOR_CRITICAL}";; + CLEAR) icon="${MSTEAM_ICON_CLEAR}" && color="${MSTEAM_COLOR_CLEAR}";; + *) icon="${MSTEAM_ICON_DEFAULT}" && color="${MSTEAM_COLOR_DEFAULT}";; + esac + + for channels in ${channels} + do + ## More details are available here regarding the payload syntax options : https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference + ## Online designer : https://acdesignerbeta.azurewebsites.net/ + payload="$(cat <<EOF + { + "@context": "http://schema.org/extensions", + "@type": "MessageCard", + "themeColor": "${color}", + "title": "$icon Alert ${status} from netdata for ${host}", + "text": "${host} ${status_message}, ${chart} (_${family}_), *${alarm}*", + "potentialAction": [ + { + "@type": "OpenUri", + "name": "Netdata", + "targets": [ + { "os": "default", "uri": "http://$(hostname -f):19999" } + ] + } + ] + } +EOF + )" + + httpcode=$(docurl -H "Content-Type: application/json" -d "${payload}" "${webhook}") + + if [ "${httpcode}" = "200" ] + then + info "sent Microsoft team notification for: ${host} ${chart}.${name} is ${status} to '${webhook}'" + sent=$((sent + 1)) + else + error "failed to send Microsoft team notification for: ${host} ${chart}.${name} is ${status} to '${webhook}', with HTTP error code ${httpcode}." + fi + done + + [ ${sent} -gt 0 ] && return 0 + + return 1 +} + + # slack sender send_slack() { @@ -1875,6 +1955,15 @@ send_slack "${SLACK_WEBHOOK_URL}" "${to_slack}" SENT_SLACK=$? # ----------------------------------------------------------------------------- +# send the Microsoft notification + +# Microsoft team aggregates posts from the same username +# so we use "${host} ${status}" as the bot username, to make them diff + +send_msteam "${MSTEAM_WEBHOOK_URL}" "${to_msteam}" +SENT_MSTEAM=$? + +# ----------------------------------------------------------------------------- # send the rocketchat notification # rocketchat aggregates posts from the same username @@ -2185,6 +2274,7 @@ if [ ${SENT_EMAIL} -eq 0 \ -o ${SENT_PUSHOVER} -eq 0 \ -o ${SENT_TELEGRAM} -eq 0 \ -o ${SENT_SLACK} -eq 0 \ + -o ${SENT_MSTEAM} -eq 0 \ -o ${SENT_ROCKETCHAT} -eq 0 \ -o ${SENT_ALERTA} -eq 0 \ -o ${SENT_FLOCK} -eq 0 \ |