Skip to content

Commit ab836ea

Browse files
committed
Updates to the "Managing cluster alerts" section
Several small fixes Improve interface descriptions Note that Alerting UI is only accessible via admin perspective Two language corrections Add a note that only cluster alerts appear in Alerting UI Improve wording of a note
1 parent 86035db commit ab836ea

9 files changed

+57
-33
lines changed
71.9 KB
Loading
-22.8 KB
Loading
-12.3 KB
Loading
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * monitoring/cluster_monitoring/managing-cluster-alerts.adoc
4+
5+
[id="monitoring-changing-alertmanager-configuration_{context}"]
6+
= Changing Alertmanager configuration
7+
8+
You can change the Alertmanager configuration by editing the YAML configuration file using the {product-title} web console.
9+
10+
.Procedure
11+
12+
To change the Alertmanager configuration:
13+
14+
. Navigate to the *Administration* -> *Cluster Settings* -> *Global Configuration* -> *Alertmanager* -> *YAML* page of the web console.
15+
. Modify the YAML configuration file.
16+
. Click *Save*.

modules/monitoring-contents-of-the-alerting-ui.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,43 @@
77

88
This section shows and explains the contents of the Alerting UI, a web interface to the Alertmanager.
99

10-
The main three pages of the Alerting UI are the *Alerts*, the *Silences*, and the *YAML* pages.
10+
The Alerting UI is accessible by clicking *Monitoring* -> *Alerting* in the {product-title} web console.
1111

12-
The *Alerts* page is accessible by clicking *Monitoring* -> *Alerting* -> *Alerts* in the {product-title} web console.
12+
The three main pages of the Alerting UI are the *Alerts*, the *Silences*, and the *Alerting rules* pages.
13+
14+
The *Alerts* page:
1315

1416
image::monitoring-alerts-screen.png[]
1517

1618
. Filtering alerts by their names.
1719
. Filtering the alerts by their states. To fire, some alerts need a certain condition to be true for the duration of a timeout. If a condition of an alert is currently true, but the timeout has not been reached, such an alert is in the *Pending* state.
1820
. Alert name.
1921
. Description of an alert.
20-
. Current state of the alert and when the alert went into this state.
2122
. Value of the Severity label of the alert.
23+
. Current state of the alert and when the alert went into this state.
2224
. Actions you can do with the alert.
2325

24-
The *Silences* page is accessible by clicking *Monitoring* -> *Alerting* -> *Silences* in the {product-title} web console.
26+
The *Silences* page:
2527

2628
image::monitoring-silences-screen.png[]
2729

2830
. Creating a silence for an alert.
2931
. Filtering silences by their name.
3032
. Filtering silences by their states. If a silence is pending, it is currently not active because it is scheduled to start at a later time. If a silence expired, it is no longer active because it has reached its end time.
31-
. Description of a silence. It includes the specification of alerts that it matches.
32-
. Current state of the silence. For active silences, it shows when it ends, and for pending silences, it shows when it starts.
33+
. Description of a silence. It includes the silence name and the specification of alerts that it matches.
3334
. Number of alerts that are being silenced by the silence.
35+
. Current state of the silence. For active silences, it shows when the silence ends. For pending silences, it shows when the silence starts.
36+
. User that created the silence.
3437
. Actions you can do with a silence.
3538

36-
The *YAML* page is accessible by clicking *Monitoring* -> *Alerting* -> *YAML* in the {product-title} web console.
37-
38-
image::monitoring-yaml-screen.png[]
39-
40-
. Upload a file with Alertmanager configuration.
41-
. Examine and edit the current Alertmanager configuration.
42-
. Save the updated Alertmanager configuration.
39+
The *Alerting Rules* page:
4340

44-
Also, next to the title of each of these pages is a link to the old Alertmanager interface.
41+
image::monitoring-alerting-rules-screen.png[]
4542

46-
.Additional resources
43+
. Filtering Alerting Rules by their name.
44+
. Filtering Alerting Rules by their states.
45+
. Alerting Rule name.
46+
. Value of the Severity label of the Alerting Rule.
47+
. State of the Alert defined by the Alerting Rule.
4748

48-
* See link:https://docs.openshift.com/container-platform/4.2/monitoring/cluster_monitoring/configuring-the-monitoring-stack.html#configuring-alertmanager[Configuring Alertmanager] for more information on changing Alertmanager configuration.
49-
// FIXME Change to a proper link
49+
Also, next to the title of each of these pages is a link to the Alertmanager interface.

modules/monitoring-getting-information-about-alerts-and-alerting-rules.adoc

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,21 @@ You can find an alert and see information about it or its governing alerting rul
1313

1414
. Optional: Filter the alerts by name using the *Filter Alerts by name* field.
1515

16-
. Optional: Filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*, *Not firing*.
16+
. Optional: Filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*.
1717

18-
. Optional: Sort the alerts by clicking one or more of the *Name*, *State*, and *Severity* column headers.
18+
. Optional: Sort the alerts by clicking one or more of the *Name*, *Severity*, and *State* column headers.
1919

20-
. After you see the alert, you can see either details of the alert or details of its governing alerting rule.
20+
. After you see the alert you need, you can see either details of the alert or details of its governing alerting rule.
2121
+
22-
To see alert details, click on the name of the alert. This is the page with alert details:
23-
+
24-
image::monitoring-alert-overview.png[]
25-
+
26-
The page has the graph with timeseries of the alert. It also has information about the alert, including:
22+
To see alert details, click on the name of the alert. The page that opens has the graph with timeseries of the alert. It also has information about the alert, including:
2723
+
2824
--
2925
* A link to its governing alerting rule
3026
* Description of the alert
27+
* Labels attached to the alert
3128
--
3229
+
33-
To see alerting rule details, click the button in the last column and select *View Alerting Rule*. This is the page with alerting rule details:
34-
+
35-
image::monitoring-alerting-rule-overview.png[]
36-
+
37-
The page has information about the alerting rule, including:
30+
To see alerting rule details, click the button in the last column and select *View Alerting Rule*. The page that opens has information about the alerting rule, including:
3831
+
3932
* Alerting rule name, severity, and description
4033
* The expression that defines the condition for firing the alert

modules/monitoring-getting-information-about-silences.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can find a silence and view its details.
1515

1616
. Optional: Filter the silences by state using one or more of the state buttons *Active*, *Pending*, *Expired*.
1717

18-
. Optional: Sort the silences by clicking one or more of the *Name*, *State*, and *Firing alerts* column headers.
18+
. Optional: Sort the silences by clicking one or more of the *Name*, *Firing Alerts*, *State*, and *Creator* column headers.
1919

2020
. After you see the silence, you can click its name to see the details, including:
2121
+

modules/monitoring-silencing-alerts.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To silence a set of alerts by creating an alert specification:
1717

1818
. Populate the *Create Silence* form.
1919

20-
. To create the silence, click *Create*.
20+
. To create the silence, click *Silence*.
2121

2222
To silence a specific alert:
2323

@@ -27,4 +27,4 @@ To silence a specific alert:
2727

2828
. Optional: Modify the silence.
2929

30-
. To create the silence, click *Create*.
30+
. To create the silence, click *Silence*.

monitoring/cluster_monitoring/managing-cluster-alerts.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,27 @@ toc::[]
77

88
{product-title} {product-version} provides a web interface to the Alertmanager, which enables you to manage alerts. This section demonstrates how to use the Alerting UI.
99

10+
[IMPORTANT]
11+
====
12+
Currently, the Alerting UI only displays alerts that come by default with the {product-title}. It does not list user-defined alerts. That will change in a future release.
13+
====
14+
15+
[NOTE]
16+
====
17+
The Alerting UI is only accessible through the Administrator Perspective and not through the Developer Perspective.
18+
====
19+
1020
include::modules/monitoring-contents-of-the-alerting-ui.adoc[leveloffset=+1]
1121
include::modules/monitoring-getting-information-about-alerts-and-alerting-rules.adoc[leveloffset=+1]
1222
include::modules/monitoring-silencing-alerts.adoc[leveloffset=+1]
1323
include::modules/monitoring-getting-information-about-silences.adoc[leveloffset=+1]
1424
include::modules/monitoring-editing-silences.adoc[leveloffset=+1]
1525
include::modules/monitoring-expiring-silences.adoc[leveloffset=+1]
26+
include::modules/monitoring-changing-alertmanager-configuration.adoc[leveloffset=+1]
27+
28+
.Additional resources
29+
30+
* See xref:../../monitoring/cluster_monitoring/configuring-the-monitoring-stack.adoc#configuring-alertmanager[Configuring Alertmanager] for more information on changing Alertmanager configuration.
1631

1732
.Next steps
1833

0 commit comments

Comments
 (0)