Merge pull request #23017 from rh-max/enterprise-4.5-monitoring-alerts-updates

Updates to the "Managing cluster alerts" section

Author: Kevin Lamenzo

images/monitoring-alerting-rules-screen.png

@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// * monitoring/cluster_monitoring/managing-cluster-alerts.adoc
+
+[id="monitoring-changing-alertmanager-configuration_{context}"]
+= Changing Alertmanager configuration
+
+You can change the Alertmanager configuration by editing the YAML configuration file using the {product-title} web console.
+
+.Procedure
+
+To change the Alertmanager configuration:
+
+. Navigate to the *Administration* -> *Cluster Settings* -> *Global Configuration* -> *Alertmanager* -> *YAML* page of the web console.
+. Modify the YAML configuration file.
+. Click *Save*.

images/monitoring-alerts-screen.png

@@ -7,43 +7,43 @@
 
 This section shows and explains the contents of the Alerting UI, a web interface to the Alertmanager.
 
-The main three pages of the Alerting UI are the *Alerts*, the *Silences*, and the *YAML* pages.
+The Alerting UI is accessible by clicking *Monitoring* -> *Alerting* in the {product-title} web console.
 
-The *Alerts* page is accessible by clicking *Monitoring* -> *Alerting* -> *Alerts* in the {product-title} web console.
+The three main pages of the Alerting UI are the *Alerts*, the *Silences*, and the *Alerting rules* pages.
+
+The *Alerts* page:
 
 image::monitoring-alerts-screen.png[]
 
 . Filtering alerts by their names.
 . 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.
 . Alert name.
 . Description of an alert.
-. Current state of the alert and when the alert went into this state.
 . Value of the Severity label of the alert.
+. Current state of the alert and when the alert went into this state.
 . Actions you can do with the alert.
 
-The *Silences* page is accessible by clicking *Monitoring* -> *Alerting* -> *Silences* in the {product-title} web console.
+The *Silences* page:
 
 image::monitoring-silences-screen.png[]
 
 . Creating a silence for an alert.
 . Filtering silences by their name.
 . 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.
-. Description of a silence. It includes the specification of alerts that it matches.
-. Current state of the silence. For active silences, it shows when it ends, and for pending silences, it shows when it starts.
+. Description of a silence. It includes the silence name and the specification of alerts that it matches.
 . Number of alerts that are being silenced by the silence.
+. Current state of the silence. For active silences, it shows when the silence ends. For pending silences, it shows when the silence starts.
+. User that created the silence.
 . Actions you can do with a silence.
 
-The *YAML* page is accessible by clicking *Monitoring* -> *Alerting* -> *YAML* in the {product-title} web console.
-
-image::monitoring-yaml-screen.png[]
-
-. Upload a file with Alertmanager configuration.
-. Examine and edit the current Alertmanager configuration.
-. Save the updated Alertmanager configuration.
+The *Alerting Rules* page:
 
-Also, next to the title of each of these pages is a link to the old Alertmanager interface.
+image::monitoring-alerting-rules-screen.png[]
 
-.Additional resources
+. Filtering Alerting Rules by their name.
+. Filtering Alerting Rules by their states.
+. Alerting Rule name.
+. Value of the Severity label of the Alerting Rule.
+. State of the Alert defined by the Alerting Rule.
 
-* 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.
-// FIXME Change to a proper link
+Also, next to the title of each of these pages is a link to the Alertmanager interface.

images/monitoring-silences-screen.png

@@ -13,28 +13,21 @@ You can find an alert and see information about it or its governing alerting rul
 
 . Optional: Filter the alerts by name using the *Filter Alerts by name* field.
 
-. Optional: Filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*, *Not firing*.
+. Optional: Filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*.
 
-. Optional: Sort the alerts by clicking one or more of the *Name*, *State*, and *Severity* column headers.
+. Optional: Sort the alerts by clicking one or more of the *Name*, *Severity*, and *State* column headers.
 
-. After you see the alert, you can see either details of the alert or details of its governing alerting rule.
+. After you see the alert you need, you can see either details of the alert or details of its governing alerting rule.
 +
-To see alert details, click on the name of the alert. This is the page with alert details:
-+
-image::monitoring-alert-overview.png[]
-+
-The page has the graph with timeseries of the alert. It also has information about the alert, including:
+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:
 +
 --
 * A link to its governing alerting rule
 * Description of the alert
+* Labels attached to the alert
 --
 +
-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:
-+
-image::monitoring-alerting-rule-overview.png[]
-+
-The page has information about the alerting rule, including:
+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:
 +
 * Alerting rule name, severity, and description
 * The expression that defines the condition for firing the alert

modules/monitoring-changing-alertmanager-configuration.adoc

@@ -15,7 +15,7 @@ You can find a silence and view its details.
 
 . Optional: Filter the silences by state using one or more of the state buttons *Active*, *Pending*, *Expired*.
 
-. Optional: Sort the silences by clicking one or more of the *Name*, *State*, and *Firing alerts* column headers.
+. Optional: Sort the silences by clicking one or more of the *Name*, *Firing Alerts*, *State*, and *Creator* column headers.
 
 . After you see the silence, you can click its name to see the details, including:
 +

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

@@ -17,7 +17,7 @@ To silence a set of alerts by creating an alert specification:
 
 . Populate the *Create Silence* form.
 
-. To create the silence, click *Create*.
+. To create the silence, click *Silence*.
 
 To silence a specific alert:
 
@@ -27,4 +27,4 @@ To silence a specific alert:
 
 . Optional: Modify the silence.
 
-. To create the silence, click *Create*.
+. To create the silence, click *Silence*.

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

@@ -7,12 +7,27 @@ toc::[]
 
 {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.
 
+[IMPORTANT]
+====
+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.
+====
+
+[NOTE]
+====
+The Alerting UI is only accessible through the Administrator Perspective and not through the Developer Perspective.
+====
+
 include::modules/monitoring-contents-of-the-alerting-ui.adoc[leveloffset=+1]
 include::modules/monitoring-getting-information-about-alerts-and-alerting-rules.adoc[leveloffset=+1]
 include::modules/monitoring-silencing-alerts.adoc[leveloffset=+1]
 include::modules/monitoring-getting-information-about-silences.adoc[leveloffset=+1]
 include::modules/monitoring-editing-silences.adoc[leveloffset=+1]
 include::modules/monitoring-expiring-silences.adoc[leveloffset=+1]
+include::modules/monitoring-changing-alertmanager-configuration.adoc[leveloffset=+1]
+
+.Additional resources
+
+* See xref:../../monitoring/cluster_monitoring/configuring-the-monitoring-stack.adoc#configuring-alertmanager[Configuring Alertmanager] for more information on changing Alertmanager configuration.
 
 .Next steps