4 # pushover support by Jan Arnold
8 if [ $(( ${BASH_VERSINFO[0]} )) -lt 4 ]
12 echo >&2 "BASH version 4 or later is required."
13 echo >&2 "You are running version: ${BASH_VERSION}"
14 echo >&2 "Please upgrade."
19 # defaults to allow running this script by hand
20 NETDATA_CONFIG_DIR="${NETDATA_CONFIG_DIR-/etc/netdata}"
21 NETDATA_CACHE_DIR="${NETDATA_CACHE_DIR-/var/cache/netdata}"
22 [ -z "${NETDATA_REGISTRY_URL}" ] && NETDATA_REGISTRY_URL="https://registry.my-netdata.io"
23 [ -z "${NETDATA_HOSTNAME}" ] && NETDATA_HOSTNAME="$(hostname)"
24 [ -z "${NETDATA_REGISTRY_HOSTNAME}" ] && NETDATA_REGISTRY_HOSTNAME="${NETDATA_HOSTNAME}"
26 # -----------------------------------------------------------------------------
27 # parse command line parameters
29 recipient="${1}" # the recepient of the email
30 host="${2}" # the host this event refers to
31 unique_id="${3}" # the unique id of this event
32 alarm_id="${4}" # the unique id of the alarm that generated this event
33 event_id="${5}" # the incremental id of the event, for this alarm
34 when="${6}" # the timestamp this event occured
35 name="${7}" # the name of the alarm, as given in netdata health.d entries
36 chart="${8}" # the name of the chart (type.id)
37 family="${9}" # the family of the chart
38 status="${10}" # the current status : REMOVED, UNITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
39 old_status="${11}" # the previous status: REMOVED, UNITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
40 value="${12}" # the current value
41 old_value="${13}" # the previous value
42 src="${14}" # the line number and file the alarm has been configured
43 duration="${15}" # the duration in seconds the previous state took
44 non_clear_duration="${16}" # the total duration in seconds this is non-clear
45 units="${17}" # the units of the value
46 info="${18}" # a short description of the alarm
48 # -----------------------------------------------------------------------------
49 # screen statuses we don't need to send a notification
51 # don't do anything if this is not WARNING, CRITICAL or CLEAR
52 if [ "${status}" != "WARNING" -a "${status}" != "CRITICAL" -a "${status}" != "CLEAR" ]
54 echo >&2 "${me}: not sending notification for ${status} on '${chart}.${name}'"
58 # don't do anything if this is CLEAR, but it was not WARNING or CRITICAL
59 if [ "${old_status}" != "WARNING" -a "${old_status}" != "CRITICAL" -a "${status}" = "CLEAR" ]
61 echo >&2 "${me}: not sending notification for ${status} on '${chart}.${name}' (last status was ${old_status})"
65 # -----------------------------------------------------------------------------
68 # this is defined here so that private registries
70 # images_base_url="${NETDATA_REGISTRY_URL}"
71 images_base_url="https://registry.my-netdata.io"
74 # if empty they will be searched in the system path
78 # enable / disable features
85 DEFAULT_RECIPIENT_SLACK=
86 declare -A role_recipients_slack=()
90 DEFAULT_RECIPIENT_PUSHOVER=
91 declare -A role_recipients_pushover=()
94 DEFAULT_RECIPIENT_EMAIL="root"
95 declare -A role_recipients_email=()
97 # load the user configuration
98 # this will overwrite the variables above
99 if [ -f "${NETDATA_CONFIG_DIR}/health_alarm_notify.conf" ]
101 source "${NETDATA_CONFIG_DIR}/health_alarm_notify.conf"
104 # -----------------------------------------------------------------------------
105 # filter recipients based on the criticality of each
107 filter_recipient_by_criticality() {
108 local method="${1}" x="${2}" r s
114 # no severity filtering for this person
115 [ "${r}" = "${s}" ] && return 0
117 # the severity is invalid
119 [ "${s}" != "CRITICAL" ] && return 0
121 # the new or the old status matches the severity
122 if [ "${s}" = "${status}" -o "${s}" = "${old_status}" ]
124 [ ! -d "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}" ] && \
125 mkdir -p "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}"
127 # we need to keep track of the notifications we sent
128 # so that the same user will receive the recovery
129 # even if old_status does not match the required severity
130 touch "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}"
134 # it is a cleared alarm we have sent notification for
135 if [ "${status}" != "WARNING" -a "${status}" != "CRITICAL" -a -f "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}" ]
137 rm "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}"
144 # -----------------------------------------------------------------------------
145 # find the recipient's addresses per method
147 declare -A arr_slack=()
148 declare -A arr_pushover=()
149 declare -A arr_email=()
151 # netdata may call us with multiple recipients
152 # so, here we find the unique ones
153 for x in ${recipient//,/ }
156 a="${role_recipients_email[${recipient}]}"
157 [ -z "${a}" ] && a="${DEFAULT_RECIPIENT_EMAIL}"
160 [ "${r}" != "disabled" ] && filter_recipient_by_criticality email "${r}" && arr_email[${r/|*/}]="1"
164 a="${role_recipients_pushover[${recipient}]}"
165 [ -z "${a}" ] && a="${DEFAULT_RECIPIENT_PUSHOVER}"
168 [ "${r}" != "disabled" ] && filter_recipient_by_criticality pushover "${r}" && arr_pushover[${r/|*/}]="1"
172 a="${role_recipients_slack[${recipient}]}"
173 [ -z "${a}" ] && a="${DEFAULT_RECIPIENT_SLACK}"
176 [ "${r}" != "disabled" ] && filter_recipient_by_criticality slack "${r}" && arr_slack[${r/|*/}]="1"
180 # build the list of slack recipients (channels)
181 to_slack="${!arr_slack[*]}"
182 [ -z "${to_slack}" ] && SEND_SLACK="NO"
184 # build the list of pushover recipients (user tokens)
185 to_pushover="${!arr_pushover[*]}"
186 [ -z "${to_pushover}" ] && SEND_PUSHOVER="NO"
188 # build the list of email recipients (email addresses)
190 for x in "${!arr_email[@]}"
192 [ ! -z "${to_email}" ] && to_email="${to_email}, "
193 to_email="${to_email}${x}"
195 [ -z "${to_email}" ] && SEND_EMAIL="NO"
198 # -----------------------------------------------------------------------------
199 # verify the delivery methods supported
202 [ -z "${SLACK_WEBHOOK_URL}" ] && SEND_SLACK="NO"
205 [ -z "${PUSHOVER_APP_TOKEN}" ] && SEND_PUSHOVER="NO"
207 if [ \( "${SEND_PUSHOVER}" = "YES" -o "${SEND_SLACK}" = "YES" \) -a -z "${curl}" ]
209 curl="$(which curl 2>/dev/null || command -v curl 2>/dev/null)"
217 if [ "${SEND_EMAIL}" = "YES" -a -z "${sendmail}" ]
219 sendmail="$(which sendmail 2>/dev/null || command -v sendmail 2>/dev/null)"
220 [ -z "${sendmail}" ] && SEND_EMAIL="NO"
223 # check that we have at least a method enabled
224 if [ "${SEND_EMAIL}" != "YES" -a "${SEND_PUSHOVER}" != "YES" -a "${SEND_SLACK}" != "YES" ]
226 echo >&2 "All notification methods are disabled. Not sending a notification."
230 # -----------------------------------------------------------------------------
231 # get the system hostname
233 [ -z "${host}" ] && host="${NETDATA_HOSTNAME}"
234 [ -z "${host}" ] && host="${NETDATA_REGISTRY_HOSTNAME}"
235 [ -z "${host}" ] && host="$(hostname 2>/dev/null)"
237 # -----------------------------------------------------------------------------
238 # get the date the alarm happened
240 date="$(date --date=@${when} 2>/dev/null)"
241 [ -z "${date}" ] && date="$(date 2>/dev/null)"
243 # -----------------------------------------------------------------------------
244 # URL encode a string
247 local string="${1}" strlen encoded pos c o
250 for (( pos=0 ; pos<strlen ; pos++ ))
259 printf -v o '%%%02x' "'$c"
269 # -----------------------------------------------------------------------------
270 # convert a duration in seconds, to a human readable duration
271 # using DAYS, MINUTES, SECONDS
274 local s="${1}" d=0 h=0 m=0 ds="day" hs="hour" ms="minute" ss="second" ret
276 s=$(( s - (d * 86400) ))
278 s=$(( s - (h * 3600) ))
280 s=$(( s - (m * 60) ))
284 [ ${m} -ge 30 ] && h=$(( h + 1 ))
285 [ ${d} -gt 1 ] && ds="days"
286 [ ${h} -gt 1 ] && hs="hours"
289 ret="${d} ${ds} and ${h} ${hs}"
295 [ ${s} -ge 30 ] && m=$(( m + 1 ))
296 [ ${h} -gt 1 ] && hs="hours"
297 [ ${m} -gt 1 ] && ms="minutes"
300 ret="${h} ${hs} and ${m} ${ms}"
306 [ ${m} -gt 1 ] && ms="minutes"
307 [ ${s} -gt 1 ] && ss="seconds"
310 ret="${m} ${ms} and ${s} ${ss}"
315 [ ${s} -gt 1 ] && ss="seconds"
323 # -----------------------------------------------------------------------------
328 if [ "${SEND_EMAIL}" = "YES" ]
336 echo >&2 "${me}: Sent email notification for: ${host} ${chart}.${name} is ${status} to '${to_email}'"
339 echo >&2 "${me}: Failed to send email notification for: ${host} ${chart}.${name} is ${status} to '${to_email}' with error code ${ret}."
347 # -----------------------------------------------------------------------------
351 local apptoken="${1}" usertokens="${2}" when="${3}" url="${4}" status="${5}" title="${6}" message="${7}" httpcode sent=0 user priority
353 if [ "${SEND_PUSHOVER}" = "YES" -a ! -z "${apptoken}" -a ! -z "${usertokens}" -a ! -z "${title}" -a ! -z "${message}" ]
356 # https://pushover.net/api
359 CLEAR) priority=-1;; # low priority: no sound or vibration
360 WARNING) priotity=0;; # normal priority: respect quiet hours
361 CRITICAL) priority=1;; # high priority: bypass quiet hours
362 *) priority=-2;; # lowest priority: no notification at all
365 for user in ${usertokens}
367 httpcode=$(${curl} --write-out %{http_code} --silent --output /dev/null \
368 --form-string "token=${apptoken}" \
369 --form-string "user=${user}" \
370 --form-string "html=1" \
371 --form-string "title=${title}" \
372 --form-string "message=${message}" \
373 --form-string "timestamp=${when}" \
374 --form-string "url=${url}" \
375 --form-string "url_title=Open netdata dashboard to view the alarm" \
376 --form-string "priority=${priority}" \
377 https://api.pushover.net/1/messages.json)
379 if [ "${httpcode}" == "200" ]
381 echo >&2 "${me}: Sent pushover notification for: ${host} ${chart}.${name} is ${status} to '${user}'"
384 echo >&2 "${me}: Failed to send pushover notification for: ${host} ${chart}.${name} is ${status} to '${user}' with HTTP error code ${httpcode}."
388 [ ${sent} -gt 0 ] && return 0
394 # -----------------------------------------------------------------------------
398 local webhook="${1}" channels="${2}" httpcode sent=0 channel color payload
400 [ "${SEND_SLACK}" != "YES" ] && return 1
403 WARNING) color="warning" ;;
404 CRITICAL) color="danger" ;;
405 CLEAR) color="good" ;;
406 *) color="#777777" ;;
409 for channel in ${channels}
413 "channel": "#${channel}",
414 "username": "netdata on ${host}",
415 "icon_url": "${images_base_url}/images/seo-performance-128.png",
418 "fallback": "${alarm} - ${chart} (${family}) - ${info}",
419 "pretext": "${host} ${status_message}",
422 "title_link": "${goto_url}",
430 "title": "${family}",
434 "thumb_url": "${image}",
435 "footer": "<${goto_url}|${host}>",
443 httpcode=$(${curl} --write-out %{http_code} --silent --output /dev/null -X POST --data-urlencode "payload=${payload}" "${webhook}")
444 if [ "${httpcode}" == "200" ]
446 echo >&2 "${me}: Sent slack notification for: ${host} ${chart}.${name} is ${status} to '${channel}'"
449 echo >&2 "${me}: Failed to send slack notification for: ${host} ${chart}.${name} is ${status} to '${channel}', with HTTP error code ${httpcode}."
453 [ ${sent} -gt 0 ] && return 0
459 # -----------------------------------------------------------------------------
460 # prepare the content of the notification
462 # the url to send the user on click
463 urlencode "${NETDATA_REGISTRY_HOSTNAME}" >/dev/null; url_host="${REPLY}"
464 urlencode "${chart}" >/dev/null; url_chart="${REPLY}"
465 urlencode "${family}" >/dev/null; url_family="${REPLY}"
466 urlencode "${name}" >/dev/null; url_name="${REPLY}"
467 goto_url="${NETDATA_REGISTRY_URL}/goto-host-from-alarm.html?host=${url_host}&chart=${url_chart}&family=${url_family}&alarm=${url_name}&alarm_unique_id=${unique_id}&alarm_id=${alarm_id}&alarm_event_id=${event_id}"
469 # the severity of the alarm
472 # the time the alarm was raised
473 duration4human ${duration} >/dev/null; duration_txt="${REPLY}"
474 duration4human ${non_clear_duration} >/dev/null; non_clear_duration_txt="${REPLY}"
475 raised_for="(was ${old_status,,} for ${duration_txt})"
477 # the key status message
478 status_message="status unknown"
480 # the color of the alarm
484 alarm="${name//_/ } = ${value} ${units}"
486 # the image of the alarm
487 image="${images_base_url}/images/seo-performance-128.png"
489 # prepare the title based on status
492 image="${images_base_url}/images/alert-128-red.png"
493 status_message="is critical"
498 image="${images_base_url}/images/alert-128-orange.png"
499 status_message="needs attention"
504 image="${images_base_url}/images/check-mark-2-128-green.png"
505 status_message="recovered"
508 # don't show the value when the status is CLEAR
509 # for certain alarms, this value might not have any meaning
510 alarm="${name//_/ } ${raised_for}"
514 if [ "${status}" = "CLEAR" ]
516 severity="Recovered from ${old_status}"
517 if [ $non_clear_duration -gt $duration ]
519 raised_for="(alarm was raised for ${non_clear_duration_txt})"
522 elif [ "${old_status}" = "WARNING" -a "${status}" = "CRITICAL" ]
524 severity="Escalated to ${status}"
525 if [ $non_clear_duration -gt $duration ]
527 raised_for="(alarm is raised for ${non_clear_duration_txt})"
530 elif [ "${old_status}" = "CRITICAL" -a "${status}" = "WARNING" ]
532 severity="Demoted to ${status}"
533 if [ $non_clear_duration -gt $duration ]
535 raised_for="(alarm is raised for ${non_clear_duration_txt})"
542 # prepare HTML versions of elements
544 [ ! -z "${info}" ] && info_html=" <small><br/>${info}</small>"
547 [ ! -z "${raised_for}" ] && raised_for_html="<br/><small>${raised_for}</small>"
549 # -----------------------------------------------------------------------------
550 # send the slack notification
552 # slack aggregates posts from the same username
553 # so we use "${host} ${status}" as the bot username, to make them diff
555 send_slack "${SLACK_WEBHOOK_URL}" "${to_slack}"
558 # -----------------------------------------------------------------------------
559 # send the pushover notification
561 send_pushover "${PUSHOVER_APP_TOKEN}" "${to_pushover}" "${when}" "${goto_url}" "${status}" "${host} ${status_message} - ${name//_/ } - ${chart}" "
562 <font color=\"${color}\"><b>${alarm}</b></font>${info_html}<br/>
563 <small><b>${chart}</b><br/>Chart<br/> </small>
564 <small><b>${family}</b><br/>Family<br/> </small>
565 <small><b>${severity}</b><br/>Severity<br/> </small>
566 <small><b>${date}${raised_for_html}</b><br/>Time<br/> </small>
567 <a href=\"${goto_url}\">View Netdata</a><br/>
568 <small><small>The source of this alarm is line ${src}</small></small>
573 # -----------------------------------------------------------------------------
578 Subject: ${host} ${status_message} - ${name//_/ } - ${chart}
579 Content-Type: text/html
581 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
582 <html xmlns="http://www.w3.org/1999/xhtml" style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; box-sizing: border-box; font-size: 14px; margin: 0; padding: 0;">
583 <body style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 14px; width: 100% !important; min-height: 100%; line-height: 1.6; background: #f6f6f6; margin:0; padding: 0;">
587 <td style="vertical-align: top;" valign="top"></td>
588 <td width="700" style="vertical-align: top; display: block !important; max-width: 700px !important; clear: both !important; margin: 0 auto; padding: 0;" valign="top">
589 <div style="max-width: 700px; display: block; margin: 0 auto; padding: 20px;">
590 <table width="100%" cellpadding="0" cellspacing="0" style="background: #fff; border: 1px solid #e9e9e9;">
593 <td bgcolor="#eee" style="padding: 5px 20px 5px 20px; background-color: #eee;">
594 <div style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 20px; color: #777; font-weight: bold;">netdata notification</div>
598 <td bgcolor="${color}" style="font-size: 16px; vertical-align: top; font-weight: 400; text-align: center; margin: 0; padding: 10px; color: #ffffff; background: ${color} !important; border: 1px solid ${color}; border-top-color: ${color};" align="center" valign="top">
599 <h1 style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-weight: 400; margin: 0;">${host} ${status_message}</h1>
603 <td style="vertical-align: top;" valign="top">
604 <div style="margin: 0; padding: 20px; max-width: 700px;">
605 <table width="100%" cellpadding="0" cellspacing="0" style="max-width:700px">
608 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding:0 0 20px;" align="left" valign="top">
609 <span>${chart}</span>
610 <span style="display: block; color: #666666; font-size: 12px; font-weight: 300; line-height: 1; text-transform: uppercase;">Chart</span>
613 <tr style="margin: 0; padding: 0;">
614 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding: 0 0 20px;" align="left" valign="top">
615 <span><b>${alarm}</b>${info_html}</span>
616 <span style="display: block; color: #666666; font-size: 12px; font-weight: 300; line-height: 1; text-transform: uppercase;">Alarm</span>
620 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding: 0 0 20px;" align="left" valign="top">
621 <span>${family}</span>
622 <span style="display: block; color: #666666; font-size: 12px; font-weight: 300; line-height: 1; text-transform: uppercase;">Family</span>
625 <tr style="margin: 0; padding: 0;">
626 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding: 0 0 20px;" align="left" valign="top">
627 <span>${severity}</span>
628 <span style="display: block; color: #666666; font-size: 12px; font-weight: 300; line-height: 1; text-transform: uppercase;">Severity</span>
631 <tr style="margin: 0; padding: 0;">
632 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding: 0 0 20px;" align="left" valign="top"><span>${date}</span>
633 <span>${raised_for_html}</span> <span style="display: block; color: #666666; font-size: 12px; font-weight: 300; line-height: 1; text-transform: uppercase;">Time</span>
636 <tr style="margin: 0; padding: 0;">
637 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 18px; vertical-align: top; margin: 0; padding: 0 0 20px;">
638 <a href="${goto_url}" style="font-size: 14px; color: #ffffff; text-decoration: none; line-height: 1.5; font-weight: bold; text-align: center; display: inline-block; text-transform: capitalize; background: #35568d; border-width: 1px; border-style: solid; border-color: #2b4c86; margin: 0; padding: 10px 15px;" target="_blank">View Netdata</a>
641 <tr style="text-align: center; margin: 0; padding: 0;">
642 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 11px; vertical-align: top; margin: 0; padding: 10px 0 0 0; color: #666666;" align="center" valign="bottom">The source of this alarm is line <code>${src}</code>
645 <tr style="text-align: center; margin: 0; padding: 0;">
646 <td style="font-family: 'Helvetica Neue', 'Helvetica', Helvetica, Arial, sans-serif; font-size: 12px; vertical-align: top; margin:0; padding: 20px 0 0 0; color: #666666; border-top: 1px solid #f0f0f0;" align="center" valign="bottom">Sent by
647 <a href="https://mynetdata.io/" target="_blank">netdata</a>, the real-time performance monitoring.
668 # -----------------------------------------------------------------------------
671 # we did send somehting
672 [ ${SENT_EMAIL} -eq 0 -o ${SENT_PUSHOVER} -eq 0 -o ${SENT_SLACK} -eq 0 ] && exit 0
674 # we did not send anything