diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-07-24 09:54:23 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-07-24 09:54:44 +0000 |
commit | 836b47cb7e99a977c5a23b059ca1d0b5065d310e (patch) | |
tree | 1604da8f482d02effa033c94a84be42bc0c848c3 /health/notifications/pushover | |
parent | Releasing debian version 1.44.3-2. (diff) | |
download | netdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.tar.xz netdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.zip |
Merging upstream version 1.46.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'health/notifications/pushover')
-rw-r--r-- | health/notifications/pushover/Makefile.inc | 12 | ||||
-rw-r--r-- | health/notifications/pushover/README.md | 119 | ||||
-rw-r--r-- | health/notifications/pushover/metadata.yaml | 78 |
3 files changed, 0 insertions, 209 deletions
diff --git a/health/notifications/pushover/Makefile.inc b/health/notifications/pushover/Makefile.inc deleted file mode 100644 index 9b703a149..000000000 --- a/health/notifications/pushover/Makefile.inc +++ /dev/null @@ -1,12 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# THIS IS NOT A COMPLETE Makefile -# IT IS INCLUDED BY ITS PARENT'S Makefile.am -# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT - -# install these files -dist_noinst_DATA += \ - pushover/README.md \ - pushover/Makefile.inc \ - $(NULL) - diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md deleted file mode 100644 index c8727ed44..000000000 --- a/health/notifications/pushover/README.md +++ /dev/null @@ -1,119 +0,0 @@ -<!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/metadata.yaml" -sidebar_label: "PushOver" -learn_status: "Published" -learn_rel_path: "Alerting/Notifications/Agent Dispatched Notifications" -message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" -endmeta--> - -# PushOver - - -<img src="https://netdata.cloud/img/pushover.png" width="150"/> - - -Send notification to Pushover using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. -- Netdata will send warning messages with priority 0 and critical messages with priority 1. -- Pushover allows you to select do-not-disturb hours. The way this is configured, critical notifications will ring and vibrate your phone, even during the do-not-disturb-hours. -- All other notifications will be delivered silently. - - - -<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> - -## Setup - -### Prerequisites - -#### - -- An Application token. You can use the same on all your Netdata servers. -- A User token for each user you are going to send notifications to. This is the actual recipient of the notification. -- Access to the terminal where Netdata Agent is running - - - -### Configuration - -#### 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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config health_alarm_notify.conf -``` -#### Options - -The following options can be defined for this notification - -<details><summary>Config Options</summary> - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| SEND_PUSHOVER | Set `SEND_PUSHOVER` to YES | YES | yes | -| PUSHOVER_WEBHOOK_URL | set `PUSHOVER_WEBHOOK_URL` to your Pushover Application token. | | yes | -| DEFAULT_RECIPIENT_PUSHOVER | Set `DEFAULT_RECIPIENT_PUSHOVER` the Pushover User token you want the alert notifications to be sent to. You can define multiple User tokens like this: `USERTOKEN1` `USERTOKEN2`. | | yes | - -##### DEFAULT_RECIPIENT_PUSHOVER - -All roles will default to this variable if left unconfigured. - -The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file: -```conf -role_recipients_pushover[sysadmin]="USERTOKEN1" -role_recipients_pushover[domainadmin]="USERTOKEN2" -role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4" -role_recipients_pushover[webmaster]="USERTOKEN5" -role_recipients_pushover[proxyadmin]="USERTOKEN6" -role_recipients_pushover[sitemgr]="USERTOKEN7" -``` - - -</details> - -#### Examples - -##### Basic Configuration - - - -```yaml -#------------------------------------------------------------------------------ -# pushover (pushover.net) global notification options - -SEND_PUSHOVER="YES" -PUSHOVER_APP_TOKEN="XXXXXXXXX" -DEFAULT_RECIPIENT_PUSHOVER="USERTOKEN" - -``` - - -## 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. - - diff --git a/health/notifications/pushover/metadata.yaml b/health/notifications/pushover/metadata.yaml deleted file mode 100644 index 9af729ea8..000000000 --- a/health/notifications/pushover/metadata.yaml +++ /dev/null @@ -1,78 +0,0 @@ -# yamllint disable rule:line-length ---- -- id: 'notify-pushover' - meta: - name: 'PushOver' - link: 'https://pushover.net/' - categories: - - notify.agent - icon_filename: 'pushover.png' - keywords: - - PushOver - overview: - notification_description: | - Send notification to Pushover using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - - Netdata will send warning messages with priority 0 and critical messages with priority 1. - - Pushover allows you to select do-not-disturb hours. The way this is configured, critical notifications will ring and vibrate your phone, even during the do-not-disturb-hours. - - All other notifications will be delivered silently. - notification_limitations: '' - setup: - prerequisites: - list: - - title: '' - description: | - - An Application token. You can use the same on all your Netdata servers. - - A User token for each user you are going to send notifications to. This is the actual recipient of the notification. - - Access to the terminal where Netdata Agent is running - configuration: - file: - name: 'health_alarm_notify.conf' - options: - description: 'The following options can be defined for this notification' - folding: - title: 'Config Options' - enabled: true - list: - - name: 'SEND_PUSHOVER' - default_value: 'YES' - description: "Set `SEND_PUSHOVER` to YES" - required: true - - name: 'PUSHOVER_WEBHOOK_URL' - default_value: '' - description: "set `PUSHOVER_WEBHOOK_URL` to your Pushover Application token." - required: true - - name: 'DEFAULT_RECIPIENT_PUSHOVER' - default_value: '' - description: "Set `DEFAULT_RECIPIENT_PUSHOVER` the Pushover User token you want the alert notifications to be sent to. You can define multiple User tokens like this: `USERTOKEN1` `USERTOKEN2`." - required: true - detailed_description: | - All roles will default to this variable if left unconfigured. - - The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file: - ```conf - role_recipients_pushover[sysadmin]="USERTOKEN1" - role_recipients_pushover[domainadmin]="USERTOKEN2" - role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4" - role_recipients_pushover[webmaster]="USERTOKEN5" - role_recipients_pushover[proxyadmin]="USERTOKEN6" - role_recipients_pushover[sitemgr]="USERTOKEN7" - ``` - examples: - folding: - enabled: true - title: '' - list: - - name: 'Basic Configuration' - folding: - enabled: false - description: '' - config: | - #------------------------------------------------------------------------------ - # pushover (pushover.net) global notification options - - SEND_PUSHOVER="YES" - PUSHOVER_APP_TOKEN="XXXXXXXXX" - DEFAULT_RECIPIENT_PUSHOVER="USERTOKEN" - troubleshooting: - problems: - list: [] |