@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 127 lines 3.8 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/prowl/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/prowl/metadata.yaml"
4 sidebar_label: "Prowl"
5 learn_status: "Published"
6 learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications"
7 keywords: ['Prowl']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
9 endmeta-->
10
11 # Prowl
12
13
14 <img src="https://netdata.cloud/img/prowl.png" width="150"/>
15
16
17 Send notifications to Prowl 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 ## Limitations
23
24 - Because of how Netdata integrates with Prowl, there is a hard limit of at most 1000 notifications per hour (starting from the first notification sent). Any alerts beyond the first thousand in an hour will be dropped.
25 - Warning messages will be sent with the 'High' priority, critical messages will be sent with the 'Emergency' priority, and all other messages will be sent with the normal priority. Opening the notification's associated URL will take you to the Netdata dashboard of the system that issued the alert, directly to the chart that it triggered on.
26
27
28 ## Setup
29
30
31 ### Prerequisites
32
33 ####
34
35 - A Prowl API key, which can be requested through the Prowl website after registering
36 - Access to the terminal where Netdata Agent is running
37
38
39
40 ### Configuration
41
42 #### Options
43
44 The following options can be defined for this notification
45
46 <details open><summary>Config Options</summary>
47
48
49
50 | Option | Description | Default | Required |
51 |:-----|:------------|:--------|:---------:|
52 | SEND_PROWL | Set `SEND_PROWL` to YES | YES | yes |
53 | [DEFAULT_RECIPIENT_PROWL](#option-default-recipient-prowl) | Set `DEFAULT_RECIPIENT_PROWL` to the Prowl API key you want the alert notifications to be sent to. You can define multiple API keys like this: `APIKEY1`, `APIKEY2`. | | yes |
54
55 <a id="option-default-recipient-prowl"></a>
56 ##### DEFAULT_RECIPIENT_PROWL
57
58 All roles will default to this variable if left unconfigured.
59
60 The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file:
61 ```text
62 role_recipients_prowl[sysadmin]="AAAAAAAA"
63 role_recipients_prowl[domainadmin]="BBBBBBBBB"
64 role_recipients_prowl[dba]="CCCCCCCCC"
65 role_recipients_prowl[webmaster]="DDDDDDDDDD"
66 role_recipients_prowl[proxyadmin]="EEEEEEEEEE"
67 role_recipients_prowl[sitemgr]="FFFFFFFFFF"
68 ```
69
70
71
72 </details>
73
74
75
76 #### via File
77
78 The configuration file name for this integration is `health_alarm_notify.conf`.
79
80
81 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
82 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
83
84 ```bash
85 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
86 sudo ./edit-config health_alarm_notify.conf
87 ```
88
89 ##### Examples
90
91 ###### Basic Configuration
92
93
94
95 ```yaml
96 #------------------------------------------------------------------------------
97 # iOS Push Notifications
98
99 SEND_PROWL="YES"
100 DEFAULT_RECIPIENT_PROWL="XXXXXXXXXX"
101
102 ```
103
104
105 ## Troubleshooting
106
107 ### Test Notification
108
109 You can run the following command by hand, to test alerts configuration:
110
111 ```bash
112 # become user netdata
113 sudo su -s /bin/bash netdata
114
115 # enable debugging info on the console
116 export NETDATA_ALARM_NOTIFY_DEBUG=1
117
118 # send test alarms to sysadmin
119 /usr/libexec/netdata/plugins.d/alarm-notify.sh test
120
121 # send test alarms to any role
122 /usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
123 ```
124
125 Note that this will test _all_ alert mechanisms for the selected role.
126
127