Added a sample metadata.yaml for Alerta (#15591)
* Added a sample metadata.yaml for Alerta * Fixing training spaces bringing yamlint errors
Satyadeep Ashwathnarayana committed
Jul 28, 2023 at 01:09 UTC
48cc810b0108fb65b8e939e1be771133a9f12154
1 file changed
+93
health/notifications/alerta/metadata.yaml
new
+93
@@ -0,0 +1,93 @@
1
+# yamllint disable rule:line-length
2
+---
3
+- id: 'notify-alerta'
4
+ meta:
5
+ name: 'Alerta'
6
+ link: 'https://alerta.io/'
7
+ categories:
8
+ - notify.agent
9
+ icon_filename: 'alerta.png'
10
+ keywords:
11
+ - Alerta
12
+ overview:
13
+ notification_description: |
14
+ 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.
15
+ You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host Netdata configuration.
16
+ notification_limitations: ''
17
+ setup:
18
+ prerequisites:
19
+ list:
20
+ - title: ''
21
+ description: |
22
+ - A working Alerta instance
23
+ - An Alerta API key (if authentication in Alerta is enabled)
24
+ - Access to the terminal where Netdata Agent is running
25
+ configuration:
26
+ file:
27
+ name: 'health_alarm_notify.conf'
28
+ options:
29
+ description: 'The following options can be defined for this notification'
30
+ folding:
31
+ title: 'Config Options'
32
+ enabled: true
33
+ list:
34
+ - name: 'SEND_ALERTA'
35
+ default_value: ''
36
+ description: |
37
+ Set `SEND_ALERTA` to YES
38
+ required: true
39
+ - name: 'ALERTA_WEBHOOK_URL'
40
+ default_value: ''
41
+ description: |
42
+ set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server.
43
+ required: true
44
+ - name: 'ALERTA_API_KEY'
45
+ default_value: ''
46
+ description: |
47
+ Set `ALERTA_API_KEY` to your API key.
48
+ required: true
49
+ detailed_description: |
50
+ 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:
51
+ 1. Go to Configuration > API Keys.
52
+ 2. Create a new API key called "netdata" with `write:alerts` permission.
53
+ - name: 'DEFAULT_RECIPIENT_ALERTA'
54
+ default_value: ''
55
+ description: |
56
+ Set `DEFAULT_RECIPIENT_ALERTA`` to the default recipient environment you want the alert notifications to be sent to.
57
+ All roles will default to this variable if left unconfigured.
58
+ required: true
59
+ - name: 'DEFAULT_RECIPIENT_CUSTOM'
60
+ default_value: ''
61
+ description: |
62
+ Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice
63
+ required: false
64
+ detailed_description: |
65
+ The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
66
+
67
+ ```
68
+ role_recipients_alerta[sysadmin]="Systems"
69
+ role_recipients_alerta[domainadmin]="Domains"
70
+ role_recipients_alerta[dba]="Databases Systems"
71
+ role_recipients_alerta[webmaster]="Marketing Development"
72
+ role_recipients_alerta[proxyadmin]="Proxy"
73
+ role_recipients_alerta[sitemgr]="Sites"
74
+ ```
75
+
76
+ The values you provide should be defined as environments in `/etc/alertad.conf` with `ALLOWED_ENVIRONMENTS` option.
77
+ examples:
78
+ folding:
79
+ enabled: true
80
+ title: ''
81
+ list:
82
+ - name: 'Basic Configuration'
83
+ folding:
84
+ enabled: false
85
+ description: ''
86
+ config: |
87
+ #------------------------------------------------------------------------------
88
+ # alerta (alerta.io) global notification options
89
+
90
+ SEND_ALERTA="YES"
91
+ ALERTA_WEBHOOK_URL="http://yourserver/alerta/api"
92
+ ALERTA_API_KEY="INSERT_YOUR_API_KEY_HERE"
93
+ DEFAULT_RECIPIENT_ALERTA="Production"