Update "View active alerts" documentation (#14766)
* initial commit, formatting comes next * format and spell check the file * Change headings --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
Mar 20, 2023 at 19:16 UTC
550b681f272edc3f4fdd4c43bb03f50fc6f4514d
1 file changed
+33
-29
docs/monitor/view-active-alarms.md
+33
-29
@@ -1,33 +1,46 @@
1
# View active alerts
2
3
-Every Netdata Agent comes with hundreds of pre-installed health alarms designed to notify you when an anomaly or
4
-performance issue affects your node or the applications it runs.
3
+Netdata comes with hundreds of pre-configured health alerts designed to notify you when an anomaly or performance issue affects your node or the applications it runs.
4
6
-## Netdata Cloud
5
+From the Alerts tab you can see all the active alerts in your War Room. You will be presented with a table having information about each alert that is in warning and critical state.
6
+You can always sort the table by a certain column by clicking on the name of that column, and use the gear icon on the top right to control which columns are visible at any given time.
7
8
-A War Room's [indicator](https://learn.netdata.cloud/docs/cloud/war-rooms#indicators) displays the number of
9
-active `critical` (red) and `warning` (yellow) alerts for the nodes in this War Room. Click on either the critical or
10
-warning badges to open a pre-filtered modal displaying only those types of active alerts.
8
+
9
12
-
10
+### Filter alerts
11
14
-The Alarms panel lists all active alarms for nodes within that War Room, and tells you which chart triggered the alarm,
15
-what that chart's current value is, the alarm that triggered it, and when the alarm status first began.
12
+From this view, you can also filter alerts with the right hand bar. More specifically you can filter:
13
17
-Use the input field in the Alarms panel to filter active alarms. You can sort by the node's name, alarm, status, chart
18
-that triggered the alarm, or the operating system. Read more about the [filtering
19
-syntax](https://learn.netdata.cloud/docs/cloud/war-rooms#node-filter) to build valuable filters for your infrastructure.
14
+- Alert status
15
+ - Filter based on the status of the alerts (e.g. Warning, Critical)
16
+- Alert class
17
+ - Filter based on the class of the alert (e.g. Latency, Utilization, Workload etc.)
18
+- Alert type & component
19
+ - Filter based on the alert's type (e.g. System, Web Server) and component (e.g. CPU, Disk, Load)
20
+- Alert role
21
+ - Filter by the role that the alert is set to notify (e.g. Sysadmin, Webmaster etc.)
22
+- Nodes
23
+ - Filter the alerts based on the nodes that are online, next to each node's name you can see how many alerts the node has, "critical" colored in red and "warning" colored in yellow
24
21
-Click on the 3-dot icon (`⋮`) to view active alarm information or navigate directly to the offending chart in that
22
-node's Cloud dashboard with the **Go to chart** button.
25
+### View alert details
26
24
-The active alarm information gives you details about the alarm that's been triggered. You can see the alarm's
25
-configuration, how it calculates warning or critical alarms, and which configuration file you could edit on that node if
26
-you want to tweak or disable the alarm to better suit your needs.
27
+By clicking on the name of an entry of the table you can access that alert's details page, providing you with:
28
28
-
29
+- Latest and Triggered time values
30
+- The alert's description
31
+- A link to the Community forum's alert page
32
+- The chart at the time frame that the alert was triggered
33
+- The alert's information: Node name, chart ID, type, component and class
34
+- Configuration section
35
+- Instance values - Node Instances
36
37
+
38
+
39
+At the bottom of the panel you can click the green button "View dedicated alert page" to open a [dynamic tab](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md#dynamic-tabs) containing all the info for this alert in a tab format, where you can also run correlations and go to the node's chart that raised the particular alert.
40
+
41
+
42
+
43
+<!--
44
## Local Netdata Agent dashboard
45
46
Find the alarms icon .
57
-
58
-## What's next?
59
-
60
-With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to match your infrastructure's needs or your team's goals.
61
-
62
-If you're happy with the pre-configured alarms, skip ahead to [enable
63
-notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
64
-per-node notifications to endpoints like Slack, PagerDuty, Twilio, and more.
65
-
66
-
70
+ -->