From b485aab7e71c1625cfc27e0f92c9509f42378458 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 May 2024 13:19:16 +0200 Subject: Adding upstream version 1.45.3+dfsg. Signed-off-by: Daniel Baumann --- health/notifications/twilio/Makefile.inc | 12 --- health/notifications/twilio/README.md | 118 ------------------------------ health/notifications/twilio/metadata.yaml | 83 --------------------- 3 files changed, 213 deletions(-) delete mode 100644 health/notifications/twilio/Makefile.inc delete mode 100644 health/notifications/twilio/README.md delete mode 100644 health/notifications/twilio/metadata.yaml (limited to 'health/notifications/twilio') diff --git a/health/notifications/twilio/Makefile.inc b/health/notifications/twilio/Makefile.inc deleted file mode 100644 index 0f2d8d8a9..000000000 --- a/health/notifications/twilio/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 += \ - twilio/README.md \ - twilio/Makefile.inc \ - $(NULL) - diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md deleted file mode 100644 index c125a967f..000000000 --- a/health/notifications/twilio/README.md +++ /dev/null @@ -1,118 +0,0 @@ - - -# Twilio - - - - - -Send notifications to Twilio using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - - - - - -## Setup - -### Prerequisites - -#### - -- Get your SID, and Token from https://www.twilio.com/console -- Terminal access to the Agent you wish to configure - - - -### 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 - -
Config Options - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| SEND_TWILIO | Set `SEND_TWILIO` to YES | YES | yes | -| TWILIO_ACCOUNT_SID | set `TWILIO_ACCOUNT_SID` to your account SID. | | yes | -| TWILIO_ACCOUNT_TOKEN | Set `TWILIO_ACCOUNT_TOKEN` to your account token. | | yes | -| TWILIO_NUMBER | Set `TWILIO_NUMBER` to your account's number. | | yes | -| DEFAULT_RECIPIENT_TWILIO | Set DEFAULT_RECIPIENT_TWILIO to the number you want the alert notifications to be sent to. You can define multiple numbers like this: +15555555555 +17777777777. | | yes | - -##### DEFAULT_RECIPIENT_TWILIO - -You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file: - -```conf -role_recipients_twilio[sysadmin]="+15555555555" -role_recipients_twilio[domainadmin]="+15555555556" -role_recipients_twilio[dba]="+15555555557" -role_recipients_twilio[webmaster]="+15555555558" -role_recipients_twilio[proxyadmin]="+15555555559" -role_recipients_twilio[sitemgr]="+15555555550" -``` - - -
- -#### Examples - -##### Basic Configuration - - - -```yaml -#------------------------------------------------------------------------------ -# Twilio (twilio.com) SMS options - -SEND_TWILIO="YES" -TWILIO_ACCOUNT_SID="xxxxxxxxx" -TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx" -TWILIO_NUMBER="xxxxxxxxxxx" -DEFAULT_RECIPIENT_TWILIO="+15555555555" - -``` - - -## 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/twilio/metadata.yaml b/health/notifications/twilio/metadata.yaml deleted file mode 100644 index 35fc3f042..000000000 --- a/health/notifications/twilio/metadata.yaml +++ /dev/null @@ -1,83 +0,0 @@ -# yamllint disable rule:line-length ---- -- id: 'notify-twilio' - meta: - name: 'Twilio' - link: 'https://www.twilio.com/' - categories: - - notify.agent - icon_filename: 'twilio.png' - keywords: - - Twilio - overview: - notification_description: | - Send notifications to Twilio using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - notification_limitations: '' - setup: - prerequisites: - list: - - title: '' - description: | - - Get your SID, and Token from https://www.twilio.com/console - - Terminal access to the Agent you wish to configure - 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_TWILIO' - default_value: 'YES' - description: "Set `SEND_TWILIO` to YES" - required: true - - name: 'TWILIO_ACCOUNT_SID' - default_value: '' - description: "set `TWILIO_ACCOUNT_SID` to your account SID." - required: true - - name: 'TWILIO_ACCOUNT_TOKEN ' - default_value: '' - description: "Set `TWILIO_ACCOUNT_TOKEN` to your account token." - required: true - - name: 'TWILIO_NUMBER' - default_value: '' - description: "Set `TWILIO_NUMBER` to your account's number." - required: true - - name: 'DEFAULT_RECIPIENT_TWILIO' - default_value: '' - description: "Set DEFAULT_RECIPIENT_TWILIO to the number you want the alert notifications to be sent to. You can define multiple numbers like this: +15555555555 +17777777777." - required: true - detailed_description: | - You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file: - - ```conf - role_recipients_twilio[sysadmin]="+15555555555" - role_recipients_twilio[domainadmin]="+15555555556" - role_recipients_twilio[dba]="+15555555557" - role_recipients_twilio[webmaster]="+15555555558" - role_recipients_twilio[proxyadmin]="+15555555559" - role_recipients_twilio[sitemgr]="+15555555550" - ``` - examples: - folding: - enabled: true - title: '' - list: - - name: 'Basic Configuration' - folding: - enabled: false - description: '' - config: | - #------------------------------------------------------------------------------ - # Twilio (twilio.com) SMS options - - SEND_TWILIO="YES" - TWILIO_ACCOUNT_SID="xxxxxxxxx" - TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx" - TWILIO_NUMBER="xxxxxxxxxxx" - DEFAULT_RECIPIENT_TWILIO="+15555555555" - troubleshooting: - problems: - list: [] -- cgit v1.2.3