summaryrefslogtreecommitdiffstats
path: root/health/notifications/alerta
diff options
context:
space:
mode:
Diffstat (limited to 'health/notifications/alerta')
-rw-r--r--health/notifications/alerta/Makefile.inc12
-rw-r--r--health/notifications/alerta/README.md128
-rw-r--r--health/notifications/alerta/metadata.yaml90
3 files changed, 0 insertions, 230 deletions
diff --git a/health/notifications/alerta/Makefile.inc b/health/notifications/alerta/Makefile.inc
deleted file mode 100644
index 10f26b0cd..000000000
--- a/health/notifications/alerta/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 += \
- alerta/README.md \
- alerta/Makefile.inc \
- $(NULL)
-
diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md
deleted file mode 100644
index 02f9f45ef..000000000
--- a/health/notifications/alerta/README.md
+++ /dev/null
@@ -1,128 +0,0 @@
-<!--startmeta
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md"
-meta_yaml: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/metadata.yaml"
-sidebar_label: "Alerta"
-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-->
-
-# Alerta
-
-
-<img src="https://netdata.cloud/img/alerta.png" width="150"/>
-
-
-The [Alerta](https://alerta.io/) monitoring system is a tool used to consolidate and de-duplicate alerts from multiple sources for quick ‘at-a-glance’ visualization. With just one system you can monitor alerts from many other monitoring tools on a single screen.
-You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host Netdata configuration.
-
-
-
-<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
-
-## Setup
-
-### Prerequisites
-
-####
-
-- A working Alerta instance
-- An Alerta API key (if authentication in Alerta is enabled)
-- 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_ALERTA | Set `SEND_ALERTA` to YES | | yes |
-| ALERTA_WEBHOOK_URL | set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server. | | yes |
-| ALERTA_API_KEY | Set `ALERTA_API_KEY` to your API key. | | yes |
-| DEFAULT_RECIPIENT_ALERTA | Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured. | | yes |
-| DEFAULT_RECIPIENT_CUSTOM | Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice | | no |
-
-##### ALERTA_API_KEY
-
-You will need an API key to send messages from any source, if Alerta is configured to use authentication (recommended). To create a new API key:
-1. Go to Configuration > API Keys.
-2. Create a new API key called "netdata" with `write:alerts` permission.
-
-
-##### DEFAULT_RECIPIENT_CUSTOM
-
-The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
-
-```conf
-role_recipients_alerta[sysadmin]="Systems"
-role_recipients_alerta[domainadmin]="Domains"
-role_recipients_alerta[dba]="Databases Systems"
-role_recipients_alerta[webmaster]="Marketing Development"
-role_recipients_alerta[proxyadmin]="Proxy"
-role_recipients_alerta[sitemgr]="Sites"
-```
-
-The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option.
-
-
-</details>
-
-#### Examples
-
-##### Basic Configuration
-
-
-
-```yaml
-#------------------------------------------------------------------------------
-# alerta (alerta.io) global notification options
-
-SEND_ALERTA="YES"
-ALERTA_WEBHOOK_URL="http://yourserver/alerta/api"
-ALERTA_API_KEY="INSERT_YOUR_API_KEY_HERE"
-DEFAULT_RECIPIENT_ALERTA="Production"
-
-```
-
-
-## 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/alerta/metadata.yaml b/health/notifications/alerta/metadata.yaml
deleted file mode 100644
index f815032b9..000000000
--- a/health/notifications/alerta/metadata.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-# yamllint disable rule:line-length
----
-- id: 'notify-alerta'
- meta:
- name: 'Alerta'
- link: 'https://alerta.io/'
- categories:
- - notify.agent
- icon_filename: 'alerta.png'
- keywords:
- - Alerta
- overview:
- notification_description: |
- The [Alerta](https://alerta.io/) monitoring system is a tool used to consolidate and de-duplicate alerts from multiple sources for quick ‘at-a-glance’ visualization. With just one system you can monitor alerts from many other monitoring tools on a single screen.
- You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host Netdata configuration.
- notification_limitations: ''
- setup:
- prerequisites:
- list:
- - title: ''
- description: |
- - A working Alerta instance
- - An Alerta API key (if authentication in Alerta is enabled)
- - 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_ALERTA'
- default_value: ''
- description: "Set `SEND_ALERTA` to YES"
- required: true
- - name: 'ALERTA_WEBHOOK_URL'
- default_value: ''
- description: "set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server."
- required: true
- - name: 'ALERTA_API_KEY'
- default_value: ''
- description: "Set `ALERTA_API_KEY` to your API key."
- required: true
- detailed_description: |
- You will need an API key to send messages from any source, if Alerta is configured to use authentication (recommended). To create a new API key:
- 1. Go to Configuration > API Keys.
- 2. Create a new API key called "netdata" with `write:alerts` permission.
- - name: 'DEFAULT_RECIPIENT_ALERTA'
- default_value: ''
- description: "Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured."
- required: true
- - name: 'DEFAULT_RECIPIENT_CUSTOM'
- default_value: ''
- description: "Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice"
- required: false
- detailed_description: |
- The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
-
- ```conf
- role_recipients_alerta[sysadmin]="Systems"
- role_recipients_alerta[domainadmin]="Domains"
- role_recipients_alerta[dba]="Databases Systems"
- role_recipients_alerta[webmaster]="Marketing Development"
- role_recipients_alerta[proxyadmin]="Proxy"
- role_recipients_alerta[sitemgr]="Sites"
- ```
-
- The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option.
- examples:
- folding:
- enabled: true
- title: ''
- list:
- - name: 'Basic Configuration'
- folding:
- enabled: false
- description: ''
- config: |
- #------------------------------------------------------------------------------
- # alerta (alerta.io) global notification options
-
- SEND_ALERTA="YES"
- ALERTA_WEBHOOK_URL="http://yourserver/alerta/api"
- ALERTA_API_KEY="INSERT_YOUR_API_KEY_HERE"
- DEFAULT_RECIPIENT_ALERTA="Production"
- troubleshooting:
- problems:
- list: []