@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 125 lines 3.69 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/pushbullet/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/pushbullet/metadata.yaml"
4 sidebar_label: "Pushbullet"
5 learn_status: "Published"
6 learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications"
7 keywords: ['Pushbullet']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
9 endmeta-->
10
11 # Pushbullet
12
13
14 <img src="https://netdata.cloud/img/pushbullet.png" width="150"/>
15
16
17 Send notifications to Pushbullet using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
18
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Setup
23
24
25 ### Prerequisites
26
27 ####
28
29 - A Pushbullet access token that can be created in your [account settings](https://www.pushbullet.com/#settings/account).
30 - Access to the terminal where Netdata Agent is running
31
32
33
34 ### Configuration
35
36 #### Options
37
38 The following options can be defined for this notification
39
40 <details open><summary>Config Options</summary>
41
42
43
44 | Option | Description | Default | Required |
45 |:-----|:------------|:--------|:---------:|
46 | Send_PUSHBULLET | Set `Send_PUSHBULLET` to YES | YES | yes |
47 | PUSHBULLET_ACCESS_TOKEN | set `PUSHBULLET_ACCESS_TOKEN` to the access token you generated. | | yes |
48 | [DEFAULT_RECIPIENT_PUSHBULLET](#option-default-recipient-pushbullet) | Set `DEFAULT_RECIPIENT_PUSHBULLET` to the email (e.g. `example@domain.com`) or the channel tag (e.g. `#channel`) you want the alert notifications to be sent to. | | yes |
49
50 <a id="option-default-recipient-pushbullet"></a>
51 ##### DEFAULT_RECIPIENT_PUSHBULLET
52
53 You can define multiple entries like this: user1@email.com user2@email.com.
54
55 All roles will default to this variable if left unconfigured.
56
57 The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file:
58 ```text
59 role_recipients_pushbullet[sysadmin]="user1@email.com"
60 role_recipients_pushbullet[domainadmin]="user2@mail.com"
61 role_recipients_pushbullet[dba]="#channel1"
62 role_recipients_pushbullet[webmaster]="#channel2"
63 role_recipients_pushbullet[proxyadmin]="user3@mail.com"
64 role_recipients_pushbullet[sitemgr]="user4@mail.com"
65 ```
66
67
68
69 </details>
70
71
72
73 #### via File
74
75 The configuration file name for this integration is `health_alarm_notify.conf`.
76
77
78 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
79 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
80
81 ```bash
82 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
83 sudo ./edit-config health_alarm_notify.conf
84 ```
85
86 ##### Examples
87
88 ###### Basic Configuration
89
90
91
92 ```yaml
93 #------------------------------------------------------------------------------
94 # pushbullet (pushbullet.com) push notification options
95
96 SEND_PUSHBULLET="YES"
97 PUSHBULLET_ACCESS_TOKEN="XXXXXXXXX"
98 DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com #examplechanneltag #anotherchanneltag"
99
100 ```
101
102
103 ## Troubleshooting
104
105 ### Test Notification
106
107 You can run the following command by hand, to test alerts configuration:
108
109 ```bash
110 # become user netdata
111 sudo su -s /bin/bash netdata
112
113 # enable debugging info on the console
114 export NETDATA_ALARM_NOTIFY_DEBUG=1
115
116 # send test alarms to sysadmin
117 /usr/libexec/netdata/plugins.d/alarm-notify.sh test
118
119 # send test alarms to any role
120 /usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
121 ```
122
123 Note that this will test _all_ alert mechanisms for the selected role.
124
125