diff options
Diffstat (limited to 'health/notifications')
| -rwxr-xr-x | health/notifications/alarm-notify.sh.in | 41 | ||||
| -rw-r--r-- | health/notifications/pagerduty/README.md | 71 | ||||
| -rw-r--r-- | health/notifications/pushbullet/README.md | 24 |
3 files changed, 77 insertions, 59 deletions
diff --git a/health/notifications/alarm-notify.sh.in b/health/notifications/alarm-notify.sh.in index 08a32ff1..287cabfe 100755 --- a/health/notifications/alarm-notify.sh.in +++ b/health/notifications/alarm-notify.sh.in @@ -243,7 +243,6 @@ else total_crit_alarms="${26}" # List of alarms in critical state classification="${27}" # The class field from .conf files edit_command_line="${28}" # The command to edit the alarm, with the line number - sender_host="${29}" # The host sending this notification fi # ----------------------------------------------------------------------------- @@ -258,17 +257,6 @@ else fi # ----------------------------------------------------------------------------- -# Do the same for sender_host (find a suitable hostname to use, if netdata did not supply a hostname) - -if [ -z ${sender_host} ]; then - this_host=$(hostname -s 2>/dev/null) - s_host="${this_host}" - sender_host="${this_host}" -else - s_host="${sender_host}" -fi - -# ----------------------------------------------------------------------------- # screen statuses we don't need to send a notification # don't do anything if this is not WARNING, CRITICAL or CLEAR @@ -1012,10 +1000,21 @@ send_pushover() { # pushbullet sender send_pushbullet() { - local userapikey="${1}" source_device="${2}" recipients="${3}" url="${4}" title="${5}" message="${6}" httpcode sent=0 user + local userapikey="${1}" source_device="${2}" recipients="${3}" url="${4}" title="${5}" message="${6}" httpcode sent=0 userOrChannelTag if [ "${SEND_PUSHBULLET}" = "YES" ] && [ -n "${userapikey}" ] && [ -n "${recipients}" ] && [ -n "${message}" ] && [ -n "${title}" ]; then - #https://docs.pushbullet.com/#create-push - for user in ${recipients}; do + + # https://docs.pushbullet.com/#create-push + # Accept specification of user(s) (PushBullet account email address) and/or channel tag(s), separated by spaces. + # If recipient begins with a "#" then send to channel tag, otherwise send to email recipient. + + for userOrChannelTag in ${recipients}; do + if [ "${userOrChannelTag::1}" = "#" ]; then + userOrChannelTag_type="channel_tag" + userOrChannelTag="${userOrChannelTag:1}" # Remove hash from start of channel tag (required by pushbullet API) + else + userOrChannelTag_type="email" + fi + httpcode=$(docurl \ --header 'Access-Token: '${userapikey}'' \ --header 'Content-Type: application/json' \ @@ -1023,7 +1022,7 @@ send_pushbullet() { cat <<EOF {"title": "${title}", "type": "link", - "email": "${user}", + "${userOrChannelTag_type}": "${userOrChannelTag}", "body": "$(echo -n ${message})", "url": "${url}", "source_device_iden": "${source_device}"} @@ -1031,10 +1030,10 @@ EOF ) "https://api.pushbullet.com/v2/pushes" -X POST) if [ "${httpcode}" = "200" ]; then - info "sent pushbullet notification for: ${host} ${chart}.${name} is ${status} to '${user}'" + info "sent pushbullet notification for: ${host} ${chart}.${name} is ${status} to '${userOrChannelTag}'" sent=$((sent + 1)) else - error "failed to send pushbullet notification for: ${host} ${chart}.${name} is ${status} to '${user}' with HTTP response status code ${httpcode}." + error "failed to send pushbullet notification for: ${host} ${chart}.${name} is ${status} to '${userOrChannelTag}' with HTTP response status code ${httpcode}." fi done @@ -2845,7 +2844,7 @@ if [ -n "$total_crit_alarms" ]; then fi if [ -n "$edit_command_line" ]; then - IFS='=' read -r edit_command line <<<"$edit_command_line" + IFS='=' read -r edit_command line s_host <<<"$edit_command_line" fi IFS='' read -r -d '' email_html_part <<EOF @@ -3258,7 +3257,7 @@ Content-Transfer-Encoding: 8bit </tr> <tr> <td align="left" style="font-size:0px;padding:10px 25px;padding-left:0;word-break:break-word;"> - <div style="font-family:Open Sans, sans-serif;font-size:14px;line-height:1.3;text-align:left;color:#35414A;">Discuss and troubleshoot with others on the Netdata <a href="https://community.netdata.cloud/" class="link" style="color: #00AB44; text-decoration: none;">community forums</a></div> + <div style="font-family:Open Sans, sans-serif;font-size:14px;line-height:1.3;text-align:left;color:#35414A;">Join the troubleshooting discussion for this alert on our <a href="https://community.netdata.cloud/t/${name//[._]/-}" class="link" style="color: #00AB44; text-decoration: none;">community forums</a>.</div> </td> </tr> </tbody> @@ -3329,7 +3328,7 @@ Content-Transfer-Encoding: 8bit <tr> <td align="left" style="font-size:0px;padding:10px 25px;padding-top:8px;padding-left:0;word-break:break-word;"> <div style="font-family:Open Sans, sans-serif;font-size:12px;line-height:1.3;text-align:left;color:#35414A;">${edit_command} <br> - The alarm to edit is at line {${line}}</div> + <br>The alarm to edit is at line ${line}</div> </td> </tr> </tbody> diff --git a/health/notifications/pagerduty/README.md b/health/notifications/pagerduty/README.md index b1f60d49..30db6379 100644 --- a/health/notifications/pagerduty/README.md +++ b/health/notifications/pagerduty/README.md @@ -1,46 +1,63 @@ <!-- -title: "PagerDuty" +title: "Send alert notifications to PagerDuty" +description: "Send alerts to your PagerDuty dashboard any time an anomaly or performance issue strikes a node in your infrastructure." +sidebar_label: "PagerDuty" custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md --> -# PagerDuty +# Send alert notifications to PagerDuty -[PagerDuty](https://www.pagerduty.com/company/) is the enterprise incident resolution service that integrates with ITOps and DevOps monitoring stacks to improve operational reliability and agility. From enriching and aggregating events to correlating them into incidents, PagerDuty streamlines the incident management process by reducing alert noise and resolution times. +[PagerDuty](https://www.pagerduty.com/company/) is an enterprise incident resolution service that integrates with ITOps +and DevOps monitoring stacks to improve operational reliability and agility. From enriching and aggregating events to +correlating them into incidents, PagerDuty streamlines the incident management process by reducing alert noise and +resolution times. -Here is an example of a PagerDuty dashboard with Netdata notifications: +## What you need to get started - +- An installation of the open-source [Netdata](/docs/get-started.mdx) monitoring agent. +- An installation of the [PagerDuty agent](https://www.pagerduty.com/docs/guides/agent-install-guide/) on the node + running Netdata. +- A PagerDuty `Generic API` service using either the `Events API v2` or `Events API v1`. -To have Netdata send notifications to PagerDuty, you'll first need to set up a PagerDuty `Generic API` service and install the PagerDuty agent on the host running Netdata. See the following guide for details: +## Setup -<https://www.pagerduty.com/docs/guides/agent-install-guide/> +[Add a new service](https://support.pagerduty.com/docs/services-and-integrations#section-configuring-services-and-integrations) +to PagerDuty. Click **Use our API directly** and select either `Events API v2` or `Events API v1`. Once you finish +creating the service, click on the **Integrations** tab to find your **Integration Key**. -During the setup of the `Generic API` PagerDuty service, you'll obtain a `pagerduty service key`. Keep this **service key** handy. - -Once the PagerDuty agent is installed on your host and can send notifications from your host to your `Generic API` service on PagerDuty, add the **service key** to `DEFAULT_RECIPIENT_PD` in `health_alarm_notify.conf`: +Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use +[`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to open +`health_alarm_notify.conf`. +```bash +cd /etc/netdata +sudo ./edit-config health_alarm_notify.conf ``` -#------------------------------------------------------------------------------ -# 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> ..." +Scroll down to the `# pagerduty.com notification options` section. + +Ensure `SEND_PD` is set to `YES`, then copy your Integration Key into `DEFAULT_RECIPIENT_ID`. Change `USE_PD_VERSION` to +`2` if you chose `Events API v2` during service setup on PagerDuty. Minus comments, the section should look like this: -# enable/disable sending pagerduty notifications +```conf SEND_PD="YES" +DEFAULT_RECIPIENT_PD="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +USE_PD_VERSION="2" +``` -# 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="<service key>" +## Testing -# Which PD API are we going to use? For version 2 or newer, it is necessary to do a request for Pagerduty -# before to set the version(https://developer.pagerduty.com/docs/events-api-v2/overview/). -USE_PD_VERSION="1" +To test alert notifications to PagerDuty, run the following: + +```bash +sudo su -s /bin/bash netdata +/usr/libexec/netdata/plugins.d/alarm-notify.sh test ``` -[](<>) +## Configuration + +Aside from the three values set in `health_alarm_notify.conf`, there is no further configuration required to send alert +notifications to PagerDuty. + +To configure individual alarms, read our [alert configuration](/docs/monitor/configure-alarms.md) doc or +the [health entity reference](/health/REFERENCE.md) doc. diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md index 7a098d6a..a1c88c70 100644 --- a/health/notifications/pushbullet/README.md +++ b/health/notifications/pushbullet/README.md @@ -14,20 +14,22 @@ And like this on your Android device: You will need: -1. Signup and Login to pushbullet.com -2. Get your Access Token, go to <https://www.pushbullet.com/#settings/account> and create a new one -3. Fill in the PUSHBULLET_ACCESS_TOKEN with that value -4. Add the recipient emails to DEFAULT_RECIPIENT_PUSHBULLET - !!PLEASE NOTE THAT IF THE RECIPIENT DOES NOT HAVE A PUSHBULLET ACCOUNT, PUSHBULLET SERVICE WILL SEND AN EMAIL!! +1. Sign up and log in to [pushbullet.com](pushbullet.com) +2. Create a new access token in your [account settings](https://www.pushbullet.com/#settings/account). +3. Fill in the `PUSHBULLET_ACCESS_TOKEN` with the newly generated access token. +4. Add the recipient emails or channel tags (each channel tag must be prefixed with #, e.g. #channeltag) to `DEFAULT_RECIPIENT_PUSHBULLET`. + > 🚨 The pushbullet notification service will send emails to the email recipient, regardless of if they have a pushbullet account. -Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this: +To add notification channels, run `/etc/netdata/edit-config health_alarm_notify.conf` + +You can change the configuration like this: ``` ############################################################################### # pushbullet (pushbullet.com) push notification options -# multiple recipients can be given like this: -# "user1@email.com user2@mail.com" +# multiple recipients (a combination of email addresses or channel tags) can be given like this: +# "user1@email.com user2@mail.com #channel1 #channel2" # enable/disable sending pushbullet notifications SEND_PUSHBULLET="YES" @@ -35,14 +37,14 @@ SEND_PUSHBULLET="YES" # Signup and Login to pushbullet.com # To get your Access Token, go to https://www.pushbullet.com/#settings/account # And create a new access token -# Then just set the recipients emails -# Please note that the if the email in the DEFAULT_RECIPIENT_PUSHBULLET does +# Then just set the recipients emails and/or channel tags (channel tags must be prefixed with #) +# Please note that the if an email in the DEFAULT_RECIPIENT_PUSHBULLET does # not have a pushbullet account, the pushbullet service will send an email # to that address instead # Without an access token, Netdata cannot send pushbullet notifications. PUSHBULLET_ACCESS_TOKEN="o.Sometokenhere" -DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com" +DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com #examplechanneltag #anotherchanneltag" ``` [](<>) |