Update the notifications/integrations docs (#14335)
* Add the docs for the newly added notification/integrations methods of the cloud. Notifications: Discord/PagerDuty/Slack/Generic WebHook * Update docs related to; Managing notification with the new methods. Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud>
Hugo Valente committed
Jan 31, 2023 at 18:22 UTC
e21c42a8ddc05836684fd4ddc710d897851876a4
11 files changed
+453
-36
docs/cloud/alerts-notifications/add-discord-notification.md
new
+59
@@ -0,0 +1,59 @@
1
+<!--
2
+title: "Add Discord notification configuration"
3
+sidebar_label: "Add Discord notification configuration"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md"
5
+sidebar_position: "1"
6
+learn_status: "Published"
7
+learn_topic_type: "Tasks"
8
+learn_rel_path: "Operations/Alerts"
9
+learn_docs_purpose: "Instructions on how to add notification configuration for Discord"
10
+-->
11
+
12
+From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord.
13
+
14
+#### Prerequisites
15
+
16
+To enable Discord notifications you need:
17
+
18
+- A Netdata Cloud account
19
+- Access to the space as an **administrator**
20
+- Have a Discord server able to receive webhook integrations. For mode details check [how to configure this on Discord](#settings-on-discord)
21
+
22
+#### Steps
23
+
24
+1. Click on the **Space settings** cog (located above your profile icon)
25
+1. Click on the **Notification** tab
26
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
27
+1. On the **Discord** card click on **+ Add**
28
+1. A modal will be presented to you to enter the required details to enable the configuration:
29
+ 1. **Notification settings** are Netdata specific settings
30
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
31
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
32
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
33
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
34
+ - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
35
+ - Webhook URL - URL provided on Discord for the channel you want to receive your notifications. For more details check [how to configure this on Discord](#settings-on-discord)
36
+ - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
37
+
38
+#### Settings on Discord
39
+
40
+#### Enable webhook integrations on Discord server
41
+
42
+To enable the webhook integrations on Discord you need:
43
+1. Go to *Integrations** under your **Server Settings
44
+
45
+ 
46
+
47
+1. **Create Webhook** or **View Webhooks** if you already have some defined
48
+1. When you create a new webhook you specify: Name and Channel
49
+1. Once you have this configured you will need the Webhook URL to add your notification configuration on Netdata UI
50
+
51
+ 
52
+
53
+For more details please read this article from Discord: [Intro to Webhooks](https://support.discord.com/hc/en-us/articles/228383668).
54
+
55
+#### Related topics
56
+
57
+- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
58
+- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
59
+- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md
new
+60
@@ -0,0 +1,60 @@
1
+<!--
2
+title: "Add PagerDuty notification configuration"
3
+sidebar_label: "Add PagerDuty notification configuration"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md"
5
+sidebar_position: "1"
6
+learn_status: "Published"
7
+learn_topic_type: "Tasks"
8
+learn_rel_path: "Operations/Alerts"
9
+learn_docs_purpose: "Instructions on how to add notification configuration for PagerDuty"
10
+-->
11
+
12
+From the Cloud interface, you can manage your space's notification settings and from these you can add specific configuration to get notifications delivered on PagerDuty.
13
+
14
+#### Prerequisites
15
+
16
+To add PagerDuty notification configurations you need
17
+
18
+- A Cloud account
19
+- Access to the space as and **administrator**
20
+- Space will needs to be on **Business** plan or higher
21
+- Have a PagerDuty service to receive events, for mode details check [how to configure this on PagerDuty](#settings-on-pagerduty)
22
+
23
+#### Steps
24
+
25
+1. Click on the **Space settings** cog (located above your profile icon)
26
+1. Click on the **Notification** tab
27
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
28
+1. On the **PagerDuty** card click on **+ Add**
29
+1. A modal will be presented to you to enter the required details to enable the configuration:
30
+ 1. **Notification settings** are Netdata specific settings
31
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
32
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
33
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
34
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
35
+ - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service. For more details check [how to configure this on PagerDuty](#settings-on-pagerduty)
36
+
37
+#### Settings on PagerDuty
38
+
39
+#### Enable webhook integrations on PagerDuty
40
+
41
+To enable the webhook integrations on PagerDuty you need:
42
+1. Create a service to receive events from your services directory page:
43
+
44
+ 
45
+
46
+1. At step 3, select `Events API V2` Integration:or **View Webhooks** if you already have some defined
47
+
48
+ 
49
+
50
+1. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI:
51
+
52
+
53
+ 
54
+
55
+
56
+#### Related topics
57
+
58
+- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
59
+- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
60
+- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-slack-notification-configuration.md
new
+63
@@ -0,0 +1,63 @@
1
+<!--
2
+title: "Add Slack notification configuration"
3
+sidebar_label: "Add Slack notification configuration"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md"
5
+sidebar_position: "1"
6
+learn_status: "Published"
7
+learn_topic_type: "Tasks"
8
+learn_rel_path: "Operations/Alerts"
9
+learn_docs_purpose: "Instructions on how to add notification configuration for Slack"
10
+-->
11
+
12
+From the Cloud interface, you can manage your space's notification settings and from these you can add specific configuration to get notifications delivered on Slack.
13
+
14
+#### Prerequisites
15
+
16
+To add discord notification configurations you need
17
+
18
+- A Netdata Cloud account
19
+- Access to the space as an **administrator**
20
+- Space will needs to be on **Business** plan or higher
21
+- Have a Slack app on your workspace to receive the webhooks, for mode details check [how to configure this on Slack](#settings-on-slack)
22
+
23
+#### Steps
24
+
25
+1. Click on the **Space settings** cog (located above your profile icon)
26
+1. Click on the **Notification** tab
27
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
28
+1. On the **Slack** card click on **+ Add**
29
+1. A modal will be presented to you to enter the required details to enable the configuration:
30
+ 1. **Notification settings** are Netdata specific settings
31
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
32
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
33
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
34
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
35
+ - Webhook URL - URL provided on Slack for the channel you want to receive your notifications. For more details check [how to configure this on Slack](#settings-on-slack)
36
+
37
+#### Settings on Slack
38
+
39
+To enable the webhook integrations on Slack you need:
40
+1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details
41
+1. Install the app on your workspace
42
+1. Configure Webhook URLs for your workspace
43
+ - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
44
+
45
+ 
46
+
47
+ - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
48
+ - After pressing that specify the channel where you want your notifications to be delivered
49
+
50
+ 
51
+
52
+ - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI
53
+
54
+ 
55
+
56
+For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
57
+
58
+
59
+#### Related topics
60
+
61
+- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
62
+- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
63
+- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
\ No newline at end of file
docs/cloud/alerts-notifications/add-webhook-notification-configuration.md
new
+105
@@ -0,0 +1,105 @@
1
+<!--
2
+title: "Add webhook notification configuration"
3
+sidebar_label: "Add webhook notification configuration"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md"
5
+sidebar_position: "1"
6
+learn_status: "Published"
7
+learn_topic_type: "Tasks"
8
+learn_rel_path: "Operations/Alerts"
9
+learn_docs_purpose: "Instructions on how to add notification configuration for webhook"
10
+-->
11
+
12
+From the Cloud interface, you can manage your space's notification settings and from these you can add specific configuration to get notifications delivered on a webhook using a predefined schema.
13
+
14
+#### Prerequisites
15
+
16
+To add discord notification configurations you need
17
+
18
+- A Netdata Cloud account
19
+- Access to the space as an **administrator**
20
+- Space will needs to be on **Pro** plan or higher
21
+- Have an app that allows you to receive webhooks following a predefined schema, for mode details check [how to create the webhook service](#webhook-service)
22
+
23
+#### Steps
24
+
25
+1. Click on the **Space settings** cog (located above your profile icon)
26
+1. Click on the **Notification** tab
27
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
28
+1. On the **webhook** card click on **+ Add**
29
+1. A modal will be presented to you to enter the required details to enable the configuration:
30
+ 1. **Notification settings** are Netdata specific settings
31
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
32
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
33
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
34
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For webhook:
35
+ - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls. Check [how to create the webhook service](#webhook-service).
36
+ - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. For mode details check [Extra headers](#extra-headers)
37
+ - Authorization Mechanism - Netdata webhook integration supports 3 different authorization mechanisms. For mode details check [Authorization mechanism](#authorization-mechanism):
38
+ - Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.
39
+ - Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
40
+ - Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
41
+
42
+#### Webhook service
43
+
44
+A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms.
45
+
46
+##### Netdata webhook integration
47
+
48
+A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs.
49
+
50
+Netdata webhook integration service will send alert notifications to the destination service as soon as they are detected.
51
+
52
+The notification content sent to the destination service will be a JSON object having these properties:
53
+
54
+| field | type | description |
55
+| :-- | :-- | :-- |
56
+| message | string | A summary message of the alert. |
57
+| alarm | string | The alarm the notification is about. |
58
+| info | string | Additional info related with the alert. |
59
+| chart | string | The chart associated with the alert. |
60
+| context | string | The chart context. |
61
+| space | string | The space where the node that raised the alert is assigned. |
62
+| family | string | Context family. |
63
+| class | string | Classification of the alert, e.g. "Error". |
64
+| severity | string | Alert severity, can be one of "warning", "critical" or "clear". |
65
+| date | string | Date of the alert in ISO8601 format. |
66
+| duration | string | Duration the alert has been raised. |
67
+| critical_count | integer | umber of critical alerts currently existing on the same node. |
68
+| warning_count | integer | Number of warning alerts currently existing on the same node. |
69
+| alarm_url | string | Netdata Cloud URL for this alarm. |
70
+
71
+##### Extra headers
72
+
73
+When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
74
+
75
+By default, the following headers will be sent in the HTTP request
76
+
77
+| **Header** | **Value** |
78
+|:-------------------------------:|-----------------------------|
79
+| Content-Type | application/json |
80
+
81
+##### Authorization mechanism
82
+
83
+Netdata webhook integration supports 3 different authorization mechanisms:
84
+
85
+1. Mutual TLS (recommended)
86
+
87
+In mutual Transport Layer Security (mTLS) authorization, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.
88
+
89
+To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. To do that you need to download our [CA certificate file](http://localhost) and configure your server to use it as the
90
+
91
+This is the default authentication mechanism used if no other method is selected.
92
+
93
+2. Basic
94
+
95
+In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.
96
+
97
+3. Bearer
98
+
99
+In bearer token authorization, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
100
+
101
+#### Related topics
102
+
103
+- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
104
+- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
105
+- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
docs/cloud/alerts-notifications/manage-notification-methods.md
new
+88
@@ -0,0 +1,88 @@
1
+<!--
2
+title: "Manage notification methods"
3
+sidebar_label: "Manage notification methods"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Operations/Alerts"
8
+learn_docs_purpose: "Instructions on how to manage notification methods"
9
+-->
10
+
11
+From the Cloud interface, you can manage your space's notification settings as well as allow users to personalize their notifications setting
12
+
13
+### Manage space notification settings
14
+
15
+#### Prerequisites
16
+
17
+To manage space notification settings, you will need the following:
18
+
19
+- A Netdata Cloud account
20
+- Access to the space as an **administrator**
21
+
22
+#### Available actions per notification methods based on service level
23
+
24
+| **Action** | **Personal service level** | **System service level** |
25
+| :- | :-: | :-: |
26
+| Enable / Disable | X | X |
27
+| Edit | | X | |
28
+| Delete | X | X |
29
+| Add multiple configurations for same method | | X |
30
+
31
+Notes:
32
+* For Netadata provided ones you can't delete the existing notification method configuration.
33
+* Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx#service-classification))
34
+
35
+#### Steps
36
+
37
+1. Click on the **Space settings** cog (located above your profile icon)
38
+1. Click on the **Notification** tab
39
+1. You will be presented with a table of the configured notification methods for the space. You will be able to:
40
+ 1. **Add a new** notification method configuration.
41
+ - Choose the service from the list of the available ones, you'll may see a list of unavailable options if your plan doesn't allow some of them (you will see on the
42
+ card the plan level that allows a specific service)
43
+ - You can optionally provide a name for the configuration so you can easily refer to what it
44
+ - Define filtering criteria. To which Rooms will this apply? What notifications I want to receive? (All Alerts and unreachable, All Alerts, Critical only)
45
+ - Depending on the service different inputs will be present, please note that there are mandatory and optional inputs
46
+ - If you doubts on how to configure the service you can find a link at the top of the modal that takes you to the specific documentation page to help you
47
+ 1. **Edit an existing** notification method configuration. Personal level ones can't be edited here, see [Manage user notification settings](#manage-user-notification-settings). You will be able to change:
48
+ - The name provided for it
49
+ - Filtering criteria
50
+ - Service specific inputs
51
+ 1. **Enable/Disable** a given notification method configuration.
52
+ - Use the toggle to enable or disable the notification method configuration
53
+ 1. **Delete an existing** notification method configuartion. Netdata provided ones can't be deleted, e.g. Email
54
+ - Use the trash icon to delete your configuration
55
+
56
+### Manage user notification settings
57
+
58
+#### Prerequisites
59
+
60
+To manage user specific notification settings, you will need the following:
61
+
62
+- A Cloud account
63
+- Have access to, at least, a space
64
+
65
+Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification method this will override any user specific setting.
66
+
67
+#### Steps
68
+
69
+1. Click on the **User notification settings** shortcut on top of the help button
70
+1. You are presented with:
71
+ - The Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification methods you can manage
72
+ - The list spaces and rooms inside those where you have access to
73
+ - If you're an administrator, Manager or Troubleshooter you'll also see the Rooms from a space you don't have access to on **All Rooms** tab and you can activate notifications for them by joining the room
74
+1. On this modal you will be able to:
75
+ 1. **Enable/Disable** the notification method for you, this applies accross all spaces and rooms
76
+ - Use the the toggle enable or disable the notification method
77
+ 1. **Define what notifications you want** to per space/room: All Alerts and unreachable, All Alerts, Critical only or No notifications
78
+ 1. **Activate notifications** for a room you aren't a member of
79
+ - From the **All Rooms** tab click on the Join button for the room(s) you want
80
+
81
+#### Related topics
82
+
83
+- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
84
+- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
85
+- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
86
+- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
87
+- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
88
+- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
docs/cloud/alerts-notifications/notifications.mdx
+73
-31
@@ -5,7 +5,7 @@ custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/aler
5
sidebar_label: "Alert notifications"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
8
+learn_rel_path: "Operations/Alerts"
9
---
10
11
import Callout from '@site/src/components/Callout'
@@ -14,61 +14,88 @@ Netdata Cloud can send centralized alert notifications to your team whenever a n
14
unreachable state. By enabling notifications, you ensure no alert, on any node in your infrastructure, goes unnoticed by
15
you or your team.
16
17
+Having this information centralized helps you:
18
+* Have a clear view of the health across your infrastructure, [seeing all a alerts in one place](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
19
+* Easily [setup your alert notification process](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md):
20
+methods to use and where to use them, filtering rules, etc.
21
+* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
22
+or [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
23
+
24
If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
25
you a flood protection notification. Getting one of these notifications is a good signal of health or performance issues
26
on that node.
27
21
-Netdata Cloud currently supports email notifications. We're working on additional endpoints and functionality.
22
-
23
-Admins must enable alert notifications for their [Space(s)](#manage-alert-notifications-for-a-space). All users in a
28
+Admins must enable alert notifications for their [Space(s)](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#manage-space-notification-settings). All users in a
29
Space can then personalize their notifications settings from within their [account
25
-menu](#manage-alert-notifications-per-user).
30
+menu](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/#manage-user-notification-settings).
31
32
<Callout type="notice">
33
34
Centralized alert notifications from Netdata Cloud is a independent process from [notifications from
30
-Netdata](/docs/monitor/enable-notifications). You can enable one or the other, or both, based on your needs. However,
35
+Netdata](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md). You can enable one or the other, or both, based on your needs. However,
36
the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
37
or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
33
-[configure](/docs/monitor/configure-alarms) each node's alert watchdog.
38
+[configure](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) each node's alert watchdog.
39
40
</Callout>
41
37
-## Manage alert notifications for a Space
42
+### Alert notifications
43
+
44
+Netdata Cloud can send centralized alert notifications to your team whenever a node enters a warning, critical, or unreachable state. By enabling notifications,
45
+you ensure no alert, on any node in your infrastructure, goes unnoticed by you or your team.
46
+
47
+If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending you a flood protection notification.
48
+Getting one of these notifications is a good signal of health or performance issues on that node.
49
+
50
+Alert notifications can be delivered through different methods, these can go from an Email sent from Netdata to the use of a 3rd party tool like PagerDuty.
51
+
52
+Notification methods are classified on two main attributes:
53
+* Service level: Personal or System
54
+* Service classification: Community or Business
55
+
56
+Only administrators are able to manage the space's alert notification settings.
57
+All users in a Space can personalize their notifications settings, for Personal service level notification methods, from within their profile menu.
58
39
-To enable notifications for a Space, click **Manage Space** in the [Space](/docs/cloud/spaces) management area.
59
+> ⚠️ Netdata Cloud supports different notification methods and their availability will depend on the plan you are at.
60
+> For more details check [Service classification](#service-classification) or [netdata.cloud/pricing](https://www.netdata.cloud/pricing).
61
41
-
62
+#### Service level
63
44
-In the modal, click on the **Notifications** tab. This menu option is visible only to administrators.
64
+##### Personal
65
46
-
66
+The notifications methods classified as **Personal** are what we consider generic, meaning that these can't have specific rules for them set by the administrators.
67
49
-Click on the toggle to enable or disable a notification method.
68
+These notifications are sent to the destination of the channel which is a user-specific attribute, e.g. user's e-mail, and the users are the ones that will then be able to
69
+manage what specific configurations they want for the Space / Room(s) and the desired Notification level, they can achieve this from their User Profile page under
70
+**Notifications**.
71
51
-## Manage alert notifications per user
72
+One example of such a notification method is the E-mail.
73
53
-You, and other individual users in your Space, can also enable and disable notification methods.
74
+##### System
75
55
-Click on your profile icon at the top-right of the Cloud UI to open your account menu, then **Profile** in the dropdown.
56
-Click on the **Notifications** tab in the panel that appears.
76
+For **System** notification methods, the destination of the channel will be a target that usually isn't specific to a single user, e.g. slack channel.
77
58
-
78
+These notification methods allow for fine-grain rule settings to be done by administrators and more than one configuration can exist for them since. You can specify
79
+different targets depending on Rooms or Notification level settings.
80
61
-Enable or disable notification methods with the toggle buttons.
81
+Some examples of such notification methods are: Webhook, PagerDuty, slack.
82
63
-Select which the notifications you want to receive from each War Room:
83
+#### Service classification
84
65
-- **All alerts and unreachable**: Receive notifications for all changes in alert status: critical, warning, and
66
- cleared. In addition, receive notifications for any node that enters an unreachable state.
67
-- **All alerts**: Receive notifications for all changes in alert status: critical, warning, and cleared.
68
-- **Critical only**: Receive notifications only for critical alerts.
69
-- **No notifications**: Receive no notifications for nodes in this War Room.
85
+##### Community
86
71
-If a Space's administrator has disabled notifications, you will see a mesage similar to, "E-mail notifications for this space has been disabled by admin," and your settings have no effect.
87
+Notification methods classified as Community can be used by everyone independent on the plan your space is at.
88
+These are: Email and discord
89
+
90
+##### Pro
91
+
92
+Notification methods classified as Pro are only available for **Pro** and **Business** plans
93
+These are: webhook
94
+
95
+##### Business
96
+
97
+Notification methods classified as Business are only available for **Business** plans
98
+These are: PagerDuty, slack
99
100
## Flood protection
101
@@ -106,7 +133,22 @@ Cloud](https://user-images.githubusercontent.com/1153921/87461878-e933c480-c5c3-
133
134
Netdata Cloud's alarm notifications feature leverages the alarms configuration on each node in your infrastructure. If
135
you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [health
109
-quickstart](/docs/monitor/configure-alarms).
136
+quickstart](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
137
111
-You can also [view active alarms](/docs/cloud/alerts-notifications/view-active-alerts) in Netdata Cloud for an instant
138
+You can also [view active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx) in Netdata Cloud for an instant
139
visualization of the health of your infrastructure.
140
+
141
+### Related Topics
142
+
143
+#### **Related Concepts**
144
+- [Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
145
+- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
146
+- [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
147
+
148
+#### Related Tasks
149
+- [View Active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
150
+- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
151
+- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
152
+- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
153
+- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
154
+- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
\ No newline at end of file
docs/cloud/alerts-notifications/smartboard.mdx
+1
-1
@@ -6,7 +6,7 @@ custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/aler
6
sidebar_label: "Alerts smartboard"
7
learn_status: "Published"
8
learn_topic_type: "Tasks"
9
-learn_rel_path: "Operations"
9
+learn_rel_path: "Operations/Alerts"
10
---
11
12
The Alerts view gives you a high level of availability and performance information for every node you're
docs/cloud/alerts-notifications/view-active-alerts.mdx
+1
-1
@@ -6,7 +6,7 @@ custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/aler
6
sidebar_label: "View active alerts"
7
learn_status: "Published"
8
learn_topic_type: "Tasks"
9
-learn_rel_path: "Operations"
9
+learn_rel_path: "Operations/Alerts"
10
---
11
12
Netdata Cloud receives information about active alerts on individual nodes in your infrastructure and updates the
docs/monitor/view-active-alarms.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/monitor/vi
5
sidebar_label: "View active health alarms"
6
learn_status: "Published"
7
learn_topic_type: "Concepts"
8
-learn_rel_path: "Operations"
8
+learn_rel_path: "Operations/Alerts"
9
-->
10
11
# View active health alarms
health/REFERENCE.md
+1
-1
@@ -4,7 +4,7 @@ sidebar_label: "Health"
4
custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/REFERENCE.md"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Operations"
7
+learn_rel_path: "Operations/Alerts"
8
-->
9
10
# Health configuration reference
health/notifications/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifica
5
sidebar_label: "Notifications Reference"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
8
+learn_rel_path: "Operations/Alerts"
9
-->
10
11
# Alarm notifications