Add centralized Cloud notifications to core docs (#10374)
* Add centralized Cloud notifs to core docs * Cleanup and copyediting
Joel Hans committed
Dec 18, 2020 at 10:34 UTC
99ebfa43cc739dac07f559e23581c30c271e5f96
2 files changed
+75
-83
docs/monitor/enable-notifications.md
+73
-81
@@ -1,16 +1,61 @@
1
<!--
2
-title: "Enable notifications"
3
-description: "Send Netdata's alerts to platforms like email, Slack, PagerDuty, Twilio, and more to enable incident response and faster resolution."
2
+title: "Enable alarm notifications"
3
+description: "Send Netdata alarms from a centralized place with Netdata Cloud, or configure nodes individually, to enable incident response and faster resolution."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/enable-notifications.md
5
-->
6
7
-# Enable notifications
7
+# Enable alarm notifications
8
9
-Netdata comes with a [notification system](/health/notifications/README.md) that supports more than a dozen services,
10
-such as email, Slack, PagerDuty, Twilio, Amazon SNS, Discord, and much more. You can enable as many platforms as you
11
-want, and configure them to match your organization's needs with features like role-based notifications.
9
+Netdata offers two ways to receive alarm notifications on external platforms. These methods work independently _or_ in
10
+parallel, which means you can enable both at the same time to send alarm notifications to any number of endpoints.
11
13
-## Supported notification platforms
12
+Both methods use a node's health alarms to generate the content of alarm notifications. Read the doc on [configuring
13
+alarms](/docs/monitor/configure-alarms.md) to change the preconfigured thresholds or to create tailored alarms for your
14
+infrastructure.
15
+
16
+Netdata Cloud offers [centralized alarm notifications](#netdata-cloud) via email, which leverages the health status
17
+information already streamed to Netdata Cloud from claimed nodes to send notifications to those who have enabled them.
18
+
19
+The Netdata Agent has a [notification system](#netdata-agent) that supports more than a dozen services, such as email,
20
+Slack, PagerDuty, Twilio, Amazon SNS, Discord, and much more.
21
+
22
+For example, use centralized alarm notifications in Netdata Cloud for immediate, zero-configuration alarm notifications
23
+for your team, then configure individual nodes send notifications to a PagerDuty endpoint for an automated incident
24
+response process.
25
+
26
+## Netdata Cloud
27
+
28
+Netdata Cloud's [centralized alarm notifications](https://learn.netdata.cloud/docs/cloud/monitoring/notifications/) is a
29
+zero-configuration way to get notified when an anomaly or incident strikes any node or application in your
30
+infrastructure. The advantage of using centralized alarm notifications from Netdata Cloud is that you don't have to
31
+worry about configuring each node in your infrastructure.
32
+
33
+To enable centralized alarm notifications for a Space, click on **Manage Space** in the left-hand menu, then click on
34
+the **Notifications** tab. Click the toggle switch next to **E-mail** to enable this notification method.
35
+
36
+Next, enable notifications on a user level by clicking on your profile icon, then **Profile** in the dropdown. The
37
+**Notifications** tab reveals rich management settings, including the ability to enable/disable methods entirely or
38
+choose what types of notifications to receive from each War Room.
39
+
40
+
42
+
43
+See the [centralized alarm notifications](https://learn.netdata.cloud/docs/cloud/monitoring/notifications/) reference
44
+doc for further details about what information is conveyed in an email notification, flood protection, and more.
45
+
46
+## Netdata Agent
47
+
48
+The Netdata Agent's [notification system](/health/notifications/README.md) runs on every node and dispatches
49
+notifications based on configured endpoints and roles. You can enable multiple endpoints on any one node _and_ use Agent
50
+notifications in parallel with centralized alarm notifications in Netdata Cloud.
51
+
52
+> ❗ If you want to enable notifications from multiple nodes in your infrastructure, each running the Netdata Agent, you
53
+> must configure each node individually.
54
+
55
+Below, we'll use [Slack notifications](#enable-slack-notifications) as an example of the process of enabling any
56
+notification platform.
57
+
58
+### Supported notification endpoints
59
60
- [**alerta.io**](/health/notifications/alerta/README.md)
61
- [**Amazon SNS**](/health/notifications/awssns/README.md)
@@ -38,78 +83,16 @@ want, and configure them to match your organization's needs with features like r
83
- [**Telegram**](/health/notifications/telegram/README.md)
84
- [**Twilio**](/health/notifications/twilio/README.md)
85
41
-This doc covers enabling email and Slack notifications, but the same process applies to enabling any other notification
42
-platform.
43
-
44
-## Enable email notifications
45
-
46
-To use [email notifications](/health/notifications/email/README.md), you need
47
-[`sendmail`](http://www.postfix.org/sendmail.1.html) or an equivalent installed on your system.
48
-
49
-Edit the `health_alarm_notify.conf` file, which resides in your Netdata [config
50
-directory](/docs/configure/nodes.md#netdata-config-directory).
51
-
52
-```bash
53
-sudo ./edit-config health_alarm_notify.conf
54
-```
55
-
56
-Look for the following lines:
57
-
58
-```conf
59
-# if a role recipient is not configured, an email will be sent to:
60
-DEFAULT_RECIPIENT_EMAIL="root"
61
-# to receive only critical alarms, set it to "root|critical"
62
-```
63
-
64
-Change the value of `DEFAULT_RECIPIENT_EMAIL` to the email address at which you'd like to receive notifications.
86
+### Enable Slack notifications
87
66
-```conf
67
-# if a role recipient is not configured, an email will be sent to:
68
-DEFAULT_RECIPIENT_EMAIL="me@example.com"
69
-# to receive only critical alarms, set it to "root|critical"
70
-```
71
-
72
-Test email notifications system by first becoming the Netdata user and then asking Netdata to send a test alarm:
73
-
74
-```bash
75
-sudo su -s /bin/bash netdata
76
-/usr/libexec/netdata/plugins.d/alarm-notify.sh test
77
-```
78
-
79
-You should see output similar to this:
80
-
81
-```bash
82
-# SENDING TEST WARNING ALARM TO ROLE: sysadmin
83
-2019-10-17 18:23:38: alarm-notify.sh: INFO: sent email notification for: hostname test.chart.test_alarm is WARNING to 'me@example.com'
84
-# OK
85
-
86
-# SENDING TEST CRITICAL ALARM TO ROLE: sysadmin
87
-2019-10-17 18:23:38: alarm-notify.sh: INFO: sent email notification for: hostname test.chart.test_alarm is CRITICAL to 'me@example.com'
88
-# OK
89
-
90
-# SENDING TEST CLEAR ALARM TO ROLE: sysadmin
91
-2019-10-17 18:23:39: alarm-notify.sh: INFO: sent email notification for: hostname test.chart.test_alarm is CLEAR to 'me@example.com'
92
-# OK
93
-```
94
-
95
-Check your email. You should receive three separate emails for each health status change: `WARNING`, `CRITICAL`, and
96
-`CLEAR`.
97
-
98
-See the [email notifications](/health/notifications/email/README.md) doc for more options and information.
99
-
100
-## Enable Slack notifications
101
-
102
-If you're one of the many who spend their workday getting pinged with GIFs by your colleagues, why not add Netdata
103
-notifications to the mix? It's a great way to immediately see, collaborate around, and respond to anomalies in your
104
-infrastructure.
105
-
106
-To get Slack notifications working, you first need to add an [incoming
107
-webhook](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) to the channel of your choice. Click the green **Add to
108
-Slack** button, choose the channel, and click the **Add Incoming WebHooks Integration** button.
88
+First, [Add an incoming webhook](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) in Slack for the channel where you
89
+want to see alarm notifications from Netdata. Click the green **Add to Slack** button, choose the channel, and click the
90
+**Add Incoming WebHooks Integration** button.
91
92
On the following page, you'll receive a **Webhook URL**. That's what you'll need to configure Netdata, so keep it handy.
93
112
-Time to dive back into your `health_alarm_notify.conf` file:
94
+Navigate to your [Netdata config directory](/docs/configure/nodes.md#netdata-config-directory) and use `edit-config` to
95
+open the `health_alarm_notify.conf` file:
96
97
```bash
98
sudo ./edit-config health_alarm_notify.conf
@@ -128,25 +111,34 @@ to send a notification to the channel you configured with the incoming webhook.
111
DEFAULT_RECIPIENT_SLACK="#"
112
```
113
131
-Time to test the notifications again:
114
+To test Slack notifications, switch to the Netdata user.
115
116
```bash
117
sudo su -s /bin/bash netdata
118
+```
119
+
120
+Next, run the `alarm-notify` script using the `test` option.
121
+
122
+```bash
123
/usr/libexec/netdata/plugins.d/alarm-notify.sh test
124
```
125
126
You should receive three notifications in your Slack channel for each health status change: `WARNING`, `CRITICAL`, and
127
`CLEAR`.
128
141
-See the [Slack notifications](/health/notifications/slack/README.md) doc for more options and information.
129
+See the [Agent Slack notifications](/health/notifications/slack/README.md) doc for more options and information.
130
131
## What's next?
132
145
-Learn more about Netdata's notifications system in the [notifications](/health/notifications/README.md) docs.
133
+Now that you have health entities configured to your infrastructure's needs and notifications to inform you of anomalies
134
+or incidents, your health monitoring setup is complete.
135
147
-Now that you have health entities configured to your infrastructure's needs, and notifications to inform you of
148
-anomalies, you have everything you need to monitor the health of your infrastructure. To make your dashboards most
149
-useful during root cause analysis, you can use Netdata's [distributed data
136
+To make your dashboards most useful during root cause analysis, use Netdata's [distributed data
137
architecture](/docs/store/distributed-data-architecture.md) for the best-in-class performance and scalability.
138
139
+### Related reference documentation
140
+
141
+- [Netdata Cloud · Alarm notifications](https://learn.netdata.cloud/docs/cloud/monitoring/notifications/)
142
+- [Netdata Agent · Notifications](/health/notifications/README.md)
143
+
144
[](<>)
docs/monitor/view-active-alarms.md
+2
-2
@@ -69,7 +69,7 @@ With the information that appears on Netdata Cloud and the local dashboard about
69
alarms](/docs/monitor/configure-alarms.md) to match your infrastructure's needs or your team's goals.
70
71
If you're happy with the pre-configured alarms, skip ahead to [enable
72
-notifications](/docs/monitor/enable-notifications.md) to instantly see alarms in email, Slack, PagerDuty, Twilio, and
73
-many other platforms.
72
+notifications](/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
73
+per-node notifications to endpoints like Slack, PagerDuty, Twilio, and more.
74
75
[](<>)