Updated formatting issues and copy (#11944)
Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com> Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Tina Luedtke committed
Feb 2, 2022 at 07:27 UTC
c12e5c1137332967243a4ca0f6b2e505c716b9d4
1 file changed
+21
-34
health/notifications/alerta/README.md
+21
-34
@@ -11,51 +11,39 @@ consolidate and de-duplicate alerts from multiple sources for quick
11
‘at-a-glance’ visualisation. With just one system you can monitor
12
alerts from many other monitoring tools on a single screen.
13
14
-
14
+
15
16
-Netadata alarms can be sent to Alerta so you can see in one place
17
-alerts coming from many Netdata hosts or also from a multi-host
18
-Netadata configuration. The big advantage over other notifications
19
-systems is that there is a main view of all active alarms with
20
-the most recent state, and it is also possible to view alarm history.
16
+Alerta's advantage is the main view, where you can see all active alarms with the most recent state. You can also view an alert history. You can send Netdata alerts to Alerta to see alerts coming from many Netdata hosts or also from a multi-host
17
+Netdata configuration.
18
19
## Deploying Alerta
20
24
-It is recommended to set up the server in a separated server, VM or
25
-container. If you have other Nginx or Apache server in your organization,
21
+The recommended setup is using a dedicated server, VM or container. If you have other NGINX or Apache servers in your organization,
22
it is recommended to proxy to this new server.
23
28
-The easiest way to install Alerta is to use the Docker image available
29
-on [Docker hub][1]. Alternatively, follow the ["getting started"][2]
30
-tutorial to deploy Alerta to an Ubuntu server. More advanced
31
-configurations are out os scope of this tutorial but information
32
-about different deployment scenarios can be found in the [docs][3].
24
+You can install Alerta in several ways:
25
+- **Docker**: Alerta provides a [Docker image](https://hub.docker.com/r/alerta/alerta-web/) to get you started quickly.
26
+- **Deployment on Ubuntu server**: Alerta's [getting started tutorial](https://docs.alerta.io/gettingstarted/tutorial-1-deploy-alerta.html) walks you through this process.
27
+- **Advanced deployment scenarios**: More ways to install and deploy Alerta are documented on the [Alerta docs](http://docs.alerta.io/en/latest/deployment.html).
28
34
-[1]: https://hub.docker.com/r/alerta/alerta-web/
29
+## Sending alerts to Alerta
30
36
-[2]: http://alerta.readthedocs.io/en/latest/gettingstarted/tutorial-1-deploy-alerta.html
37
-
38
-[3]: http://docs.alerta.io/en/latest/deployment.html
39
-
40
-## Send alarms to Alerta
41
-
42
-Step 1. Create an API key (if authentication is enabled)
31
+### Step 1. Create an API key (if authentication in Alerta is enabled)
32
33
You will need an API key to send messages from any source, if
45
-Alerta is configured to use authentication (recommended). To
46
-create an API key go to "Configuration -> API Keys" and create
47
-a new API key called "netdata" with `write:alerts` permission.
34
+Alerta is configured to use authentication (recommended).
35
49
-Step 2. configure Netdata to send alarms to Alerta
50
-
51
-On your system run:
36
+Create a new API key in Alerta:
37
+1. Go to *Configuration* > *API Keys*
38
+2. Create a new API key called "netdata" with `write:alerts` permission.
39
40
+### Step 2. Configure Netdata to send alerts to Alerta
41
+1. Edit the `health_alarm_notify.conf` by running:
42
```sh
43
/etc/netdata/edit-config health_alarm_notify.conf
44
```
45
57
-and modify the file as below:
58
-
46
+2. Modify the file as below:
47
```
48
# enable/disable sending alerta notifications
49
SEND_ALERTA="YES"
@@ -84,11 +72,10 @@ We can test alarms using the standard approach:
72
/opt/netdata/netdata-plugins/plugins.d/alarm-notify.sh test
73
```
74
87
-Note: Netdata will send 3 alarms, and because last alarm is "CLEAR"
88
-you will not see them in main Alerta page, you need to select to see
89
-"closed" alarm in top-right lookup. A little change in `alarm-notify.sh`
90
-that let us test each state one by one will be useful.
75
+> **Note** This script will send 3 alarms.
76
+> Alerta will not show the alerts in the main page, because last alarm is "CLEAR".
77
+> To see the test alarms, you need to select "closed" alarms in the top-right lookup.
78
92
-For more information see <https://docs.alerta.io>
79
+For more information see the [Alerta documentation](https://docs.alerta.io)
80
81
[](<>)