Notification section updates (#17551)
* Update enable-notifications.md * Update README.md * Update enable-notifications.md * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Apr 30, 2024 at 11:25 UTC
f0e4ec8defedb5089d6753353b2e98aec4bc2cb3
2 files changed
+19
-99
docs/monitor/enable-notifications.md
+4
-87
@@ -1,90 +1,7 @@
1
-<!--
2
-title: "Alert notifications"
3
-description: "Send Netdata alerts 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
-sidebar_label: "Notify"
6
-learn_status: "Published"
7
-learn_rel_path: "Integrations/Notify"
8
--->
1
+# Notifications
2
10
-# Alert notifications
11
-
12
-Netdata offers two ways to receive alert notifications on external platforms. These methods work independently _or_ in
13
-parallel, which means you can enable both at the same time to send alert notifications to any number of endpoints.
14
-
15
-Both methods use a node's health alerts to generate the content of alert notifications. Read our documentation on [configuring alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) to change the preconfigured thresholds or to create tailored alerts for your
16
-infrastructure.
17
-
18
-Netdata Cloud offers [centralized alert notifications](#netdata-cloud) via email, which leverages the health status
19
-information already streamed to Netdata Cloud from connected nodes to send notifications to those who have enabled them.
20
-
21
-The Netdata Agent has a [notification system](#netdata-agent) that supports more than a dozen services, such as email,
22
-Slack, PagerDuty, Twilio, Amazon SNS, Discord, and much more.
23
-
24
-For example, use centralized alert notifications in Netdata Cloud for immediate, zero-configuration alert notifications
25
-for your team, then configure individual nodes send notifications to a PagerDuty endpoint for an automated incident
26
-response process.
27
-
28
-## Netdata Cloud
29
-
30
-Netdata Cloud's [centralized alert
31
-notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md) is a zero-configuration way to
32
-get notified when an anomaly or incident strikes any node or application in your infrastructure. The advantage of using
33
-centralized alert notifications from Netdata Cloud is that you don't have to worry about configuring each node in your
34
-infrastructure.
35
-
36
-To enable centralized alert notifications for a Space, click on **Manage Space** in the left-hand menu, then click on
37
-the **Notifications** tab. Click the toggle switch next to **E-mail** to enable this notification method.
38
-
39
-Next, enable notifications on a user level by clicking on your profile icon, then **Profile** in the dropdown. The
40
-**Notifications** tab reveals rich management settings, including the ability to enable/disable methods entirely or
41
-choose what types of notifications to receive from each War Room.
42
-
43
-
45
-
46
-See the [centralized alert notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
47
-reference doc for further details about what information is conveyed in an email notification, flood protection, and
48
-more.
49
-
50
-## Netdata Agent
51
-
52
-The Netdata Agent's [notification system](https://github.com/netdata/netdata/blob/master/src/health/notifications/README.md) runs on every node and dispatches
53
-notifications based on configured endpoints and roles. You can enable multiple endpoints on any one node _and_ use Agent
54
-notifications in parallel with centralized alert notifications in Netdata Cloud.
55
-
56
-> ❗ If you want to enable notifications from multiple nodes in your infrastructure, each running the Netdata Agent, you
57
-> must configure each node individually.
58
-
59
-Below, we'll use [Slack notifications](#enable-slack-notifications) as an example of the process of enabling any
60
-notification platform.
61
-
62
-### Supported notification endpoints
63
-
64
-- [**alerta.io**](https://github.com/netdata/netdata/blob/master/src/health/notifications/alerta/README.md)
65
-- [**Amazon SNS**](https://github.com/netdata/netdata/blob/master/src/health/notifications/awssns/README.md)
66
-- [**Custom endpoint**](https://github.com/netdata/netdata/blob/master/src/health/notifications/custom/README.md)
67
-- [**Discord**](https://github.com/netdata/netdata/blob/master/src/health/notifications/discord/README.md)
68
-- [**Dynatrace**](https://github.com/netdata/netdata/blob/master/src/health/notifications/dynatrace/README.md)
69
-- [**Email**](https://github.com/netdata/netdata/blob/master/src/health/notifications/email/README.md)
70
-- [**Flock**](https://github.com/netdata/netdata/blob/master/src/health/notifications/flock/README.md)
71
-- [**Gotify**](https://github.com/netdata/netdata/blob/master/src/health/notifications/gotify/README.md)
72
-- [**IRC**](https://github.com/netdata/netdata/blob/master/src/health/notifications/irc/README.md)
73
-- [**Kavenegar**](https://github.com/netdata/netdata/blob/master/src/health/notifications/kavenegar/README.md)
74
-- [**Matrix**](https://github.com/netdata/netdata/blob/master/src/health/notifications/matrix/README.md)
75
-- [**Messagebird**](https://github.com/netdata/netdata/blob/master/src/health/notifications/messagebird/README.md)
76
-- [**Microsoft Teams**](https://github.com/netdata/netdata/blob/master/src/health/notifications/msteams/README.md)
77
-- [**Netdata Agent dashboard**](https://github.com/netdata/netdata/blob/master/src/health/notifications/web/README.md)
78
-- [**Opsgenie**](https://github.com/netdata/netdata/blob/master/src/health/notifications/opsgenie/README.md)
79
-- [**PagerDuty**](https://github.com/netdata/netdata/blob/master/src/health/notifications/pagerduty/README.md)
80
-- [**Prowl**](https://github.com/netdata/netdata/blob/master/src/health/notifications/prowl/README.md)
81
-- [**PushBullet**](https://github.com/netdata/netdata/blob/master/src/health/notifications/pushbullet/README.md)
82
-- [**PushOver**](https://github.com/netdata/netdata/blob/master/src/health/notifications/pushover/README.md)
83
-- [**Rocket.Chat**](https://github.com/netdata/netdata/blob/master/src/health/notifications/rocketchat/README.md)
84
-- [**Slack**](https://github.com/netdata/netdata/blob/master/src/health/notifications/slack/README.md)
85
-- [**SMS Server Tools 3**](https://github.com/netdata/netdata/blob/master/src/health/notifications/smstools3/README.md)
86
-- [**Syslog**](https://github.com/netdata/netdata/blob/master/src/health/notifications/syslog/README.md)
87
-- [**Telegram**](https://github.com/netdata/netdata/blob/master/src/health/notifications/telegram/README.md)
88
-- [**Twilio**](https://github.com/netdata/netdata/blob/master/src/health/notifications/twilio/README.md)
3
+This section includes the documentation of the integrations for both of Netdata's notification methods.
4
5
+- Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.
6
7
+- The Netdata Agent offers a [wider range of notification options](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.
src/health/README.md
+15
-12
@@ -1,14 +1,17 @@
1
# Alerts and notifications
2
3
-The Netdata Agent is a health watchdog for the health and performance of your systems, services, and applications. We've
4
-worked closely with our community of DevOps engineers, SREs, and developers to define hundreds of production-ready
5
-alerts that work without any configuration.
6
-
7
-The Agent's health monitoring system is also dynamic and fully customizable. You can write entirely new alerts, tune the
8
-community-configured alerts for every app/service [the Agent collects metrics from](https://github.com/netdata/netdata/blob/master/src/collectors/COLLECTORS.md), or
9
-silence anything you're not interested in. You can even power complex lookups by running statistical algorithms against
10
-your metrics.
11
-
12
-You can [use various alert notification methods](https://github.com/netdata/netdata/edit/master/docs/monitor/enable-notifications.md),
13
-[customize alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md), and
14
-[disable/silence](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#disable-or-silence-alerts) alerts.
3
+Netdata offers two ways to receive alert notifications on external integrations. These methods work independently, which means you can enable both at the same time to send alert notifications to any number of endpoints.
4
+
5
+Both methods use a node's health alerts to generate the content of a notification.
6
+
7
+Read our documentation on [configuring alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) to change the preconfigured thresholds or to create tailored alerts for your infrastructure.
8
+
9
+- Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.
10
+
11
+- The Netdata Agent offers a [wider range of notification options](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.
12
+
13
+The Netdata Agent is a health watchdog for the health and performance of your systems, services, and applications. We've worked closely with our community of DevOps engineers, SREs, and developers to define hundreds of production-ready alerts that work without any configuration.
14
+
15
+The Agent's health monitoring system is also dynamic and fully customizable. You can write entirely new alerts, tune the pre-configured alerts for every app/service [the Agent collects metrics from](https://github.com/netdata/netdata/blob/master/src/collectors/COLLECTORS.md), or silence anything you're not interested in. You can even power complex lookups by running statistical algorithms against your metrics.
16
+
17
+You can [use various alert notification methods](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md), [customize alerts](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md), and [disable/silence](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#disable-or-silence-alerts) alerts.