@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 192 lines 7.6 KB
Rendered Raw
1 # Manage Notification Methods
2
3 From the Cloud interface, you can manage your Space's notification settings as well as allow users to personalize their notification settings.
4
5 ## Notification Types Reference
6
7 Netdata supports five types of notifications that you can configure:
8
9 | **Notification Type** | **Description** |
10 |:----------------------|:--------------------------------------------------------------|
11 | **Critical** | Alerts indicating serious problems requiring immediate action |
12 | **Warning** | Alerts showing concerning behavior that requires attention |
13 | **Clear** | Notifications when alerts return to normal state |
14 | **Reachable** | Notifications when nodes come back online |
15 | **Unreachable** | Notifications when nodes go offline or become unreachable |
16
17 ## Manage Space Notification Settings
18
19 ### Prerequisites
20
21 To manage Space notification settings, you will need the following:
22
23 - A Netdata Cloud account
24 - Access to Space as an **administrator**
25
26 ### Available Actions per Notification Method Based on Service Level
27
28 | **Action** | **Personal Service Level** | **System Service Level** |
29 |:------------------------------------------------|:--------------------------:|:------------------------:|
30 | Enable / Disable | X | X |
31 | Edit | | X |
32 | Delete | X | X |
33 | Add multiple configurations for the same method | | X |
34
35 :::note
36
37 - For Netdata provided ones, you can't delete the existing notification method configuration
38 - Enable, Edit, and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-classification))
39
40 :::
41
42 ### Steps to Configure Space Notifications
43
44 1. Click **Space Settings** (⚙️) on the left sidebar below the spaces list.
45 2. Click on the **Alerts & Notifications** tab on the left-hand side.
46 3. Click on the **Notification Methods** tab.
47
48 <details>
49 <summary>4. <strong>Manage Notification Methods</strong></summary><br/>
50
51 You will be presented with a table of the configured notification methods for the Space. You will be able to:
52
53 - **Add a new** notification method configuration:
54 - Choose the service from the list of available ones. The available options will depend on your subscription plan.
55
56 :::tip
57
58 - You can optionally provide a name for the configuration so you can refer to it.
59 - You can define the filtering criteria, regarding which Rooms the method will apply, and what notifications you want to receive (Critical, Warning, Clear, Reachable and Unreachable).
60
61 :::
62
63 - Depending on the service, different inputs will be present.
64
65 :::note
66
67 Please note that there are mandatory and optional inputs.
68
69 :::
70
71 :::tip
72
73 - If you have 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.
74
75 :::
76
77 - **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:
78 - The name provided for it
79 - Filtering criteria
80 - Service-specific inputs
81
82 - **Enable/Disable** a given notification method configuration:
83 - Use the toggle to enable or disable the notification method configuration
84
85 - **Delete an existing** notification method configuration. Netdata provided ones can't be deleted, e.g., Email:
86 - Use the trash icon to delete your configuration
87
88 </details>
89
90 ## Testing Your Notification Setup
91
92 You can verify that your Cloud notification setup is working correctly by using the Agent's test functionality on any connected node:
93
94 <details>
95 <summary><strong>Basic Test Commands</strong></summary><br/>
96
97 ```bash
98 # Switch to the Netdata user
99 sudo su -s /bin/bash netdata
100
101 # Enable debugging
102 export NETDATA_ALARM_NOTIFY_DEBUG=1
103
104 # Test default role (sysadmin)
105 ./plugins.d/alarm-notify.sh test
106
107 # Test specific role
108 ./plugins.d/alarm-notify.sh test "webmaster"
109 ```
110
111 </details>
112
113 ## What Happens After Configuration
114
115 When you complete your notification setup:
116
117 1. **Configuration takes effect immediately** - Changes are applied as soon as you save them
118 2. **All matching alerts will trigger notifications** - Based on your filtering criteria
119 3. **You can monitor notification delivery** - Check your configured channels for test messages
120 4. **Flood protection activates automatically** - To prevent notification overload from frequently changing nodes
121
122 ## Manage User Notification Settings
123
124 ### Prerequisites
125
126 To manage user-specific notification settings, you will need the following:
127
128 - A Cloud account
129 - Access to at least one Space
130
131 :::note
132
133 If an administrator has disabled a Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification method, this will override any user-specific setting.
134
135 :::
136
137 ### Steps to Configure Personal Notifications
138
139 <details>
140 <summary><strong>Access User Settings</strong></summary><br/>
141
142 Click on your profile picture and navigate to **Settings** → **Notifications**
143 </details>
144
145 <details>
146 <summary><strong>Review Available Options</strong></summary><br/>
147
148 You are presented with:
149
150 - The Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification methods you can manage
151 - The list of Spaces and Rooms you have access to
152
153 </details>
154
155 <details>
156 <summary><strong>Configure Your Notifications</strong></summary><br/>
157
158 On this modal you will be able to:
159
160 - **Enable/Disable** the notification method on a personal scope, this applies across all Spaces and Rooms
161 - **Define what notifications you want to receive** per Space/Room: Critical, Warning, Clear, Reachable and Unreachable
162 - **Join a Room and activate notifications**:
163 - From the **All Rooms** tab, click on the Join button for the Room(s) you want
164
165 </details>
166
167 ## Best Practices
168
169 Based on Netdata's documentation, here are recommended practices:
170
171 ### Filtering Strategy
172
173 - Use **Room-based filtering** to organize notifications by infrastructure components
174 - Apply **severity filtering** to route Critical alerts to immediate channels (like PagerDuty) and Warning alerts to monitoring channels (like Slack)
175 - Utilize **host labels** for granular targeting of specific infrastructure segments
176
177 ### Avoiding Alert Fatigue
178
179 - Netdata includes built-in **flood protection** that limits notifications when nodes frequently change state
180
181 :::tip
182
183 - Configure different notification methods for different severity levels
184 - Use **silencing rules** during planned maintenance windows
185
186 :::
187
188 ## Related Documentation
189
190 - [Alert notification silencing rules](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md)
191 - [Service classification reference](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-classification)
192 - [Agent notification testing](/src/health/notifications/README.md#testing-your-notification-setup)