ContextQMD
Back to Netdata

Pushbullet

src/health/notifications/pushbullet/README.md

2.10.33.7 KB
Original Source
<!--startmeta custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/pushbullet/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/pushbullet/metadata.yaml" sidebar_label: "Pushbullet" learn_status: "Published" learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications" keywords: ['Pushbullet'] message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" endmeta-->

Pushbullet

Send notifications to Pushbullet using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.

Setup

Prerequisites

  • A Pushbullet access token that can be created in your account settings.
  • Access to the terminal where Netdata Agent is running

Configuration

Options

The following options can be defined for this notification

<details open><summary>Config Options</summary>
OptionDescriptionDefaultRequired
Send_PUSHBULLETSet Send_PUSHBULLET to YESYESyes
PUSHBULLET_ACCESS_TOKENset PUSHBULLET_ACCESS_TOKEN to the access token you generated.yes
DEFAULT_RECIPIENT_PUSHBULLETSet DEFAULT_RECIPIENT_PUSHBULLET to the email (e.g. [email protected]) or the channel tag (e.g. #channel) you want the alert notifications to be sent to.yes

<a id="option-default-recipient-pushbullet"></a>

DEFAULT_RECIPIENT_PUSHBULLET

You can define multiple entries like this: [email protected] [email protected].

All roles will default to this variable if left unconfigured.

The DEFAULT_RECIPIENT_PUSHBULLET can be edited in the following entries at the bottom of the same file:

text
role_recipients_pushbullet[sysadmin]="[email protected]"
role_recipients_pushbullet[domainadmin]="[email protected]"
role_recipients_pushbullet[dba]="#channel1"
role_recipients_pushbullet[webmaster]="#channel2"
role_recipients_pushbullet[proxyadmin]="[email protected]"
role_recipients_pushbullet[sitemgr]="[email protected]"
</details>

via File

The configuration file name for this integration is health_alarm_notify.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config health_alarm_notify.conf
Examples
Basic Configuration
yaml
#------------------------------------------------------------------------------
# pushbullet (pushbullet.com) push notification options

SEND_PUSHBULLET="YES"
PUSHBULLET_ACCESS_TOKEN="XXXXXXXXX"
DEFAULT_RECIPIENT_PUSHBULLET="[email protected] [email protected] #examplechanneltag #anotherchanneltag"

Troubleshooting

Test Notification

You can run the following command by hand, to test alerts configuration:

bash
# become user netdata
sudo su -s /bin/bash netdata

# enable debugging info on the console
export NETDATA_ALARM_NOTIFY_DEBUG=1

# send test alarms to sysadmin
/usr/libexec/netdata/plugins.d/alarm-notify.sh test

# send test alarms to any role
/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"

Note that this will test all alert mechanisms for the selected role.