Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions managing-alerts/managing-alerts-as-a-developer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ The alerts, silences, and alerting rules that are available in the Alerting UI r
====

// Accessing the Alerting UI from the Developer perspective
include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1,tags=**;DEV;!ADM]
include::modules/monitoring-accessing-the-alerting-ui-dev.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../key-concepts/key-concepts.adoc#searching-alerts-silences-and-alerting-rules_key-concepts[Searching and filtering alerts, silences, and alerting rules]

// Getting information about alerts, silences and alerting rules from the Developer perspective
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc[leveloffset=+1,tags=**;DEV;!ADM]
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-dev.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
Expand All @@ -46,11 +46,11 @@ When you create silences, they are replicated across Alertmanager pods. However,
* xref:../key-concepts/key-concepts.adoc#managing-silences_key-concepts[Managing silences]
* xref:../configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage]

include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2,tags=**;DEV;!ADM]
include::modules/monitoring-silencing-alerts-dev.adoc[leveloffset=+2]

include::modules/monitoring-editing-silences.adoc[leveloffset=+2,tags=**;DEV;!ADM]
include::modules/monitoring-editing-silences-dev.adoc[leveloffset=+2]

include::modules/monitoring-expiring-silences.adoc[leveloffset=+2,tags=**;DEV;!ADM]
include::modules/monitoring-expiring-silences-dev.adoc[leveloffset=+2]

[id="managing-alerting-rules-for-user-defined-projects-uwm_{context}"]
== Managing alerting rules for user-defined projects
Expand Down
10 changes: 5 additions & 5 deletions managing-alerts/managing-alerts-as-an-administrator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ The alerts, silences, and alerting rules that are available in the Alerting UI r
====

// Accessing the Alerting UI from the Administrator perspective
include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1,tags=**;ADM;!DEV]
include::modules/monitoring-accessing-the-alerting-ui-adm.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../key-concepts/key-concepts.adoc#searching-alerts-silences-and-alerting-rules_key-concepts[Searching and filtering alerts, silences, and alerting rules]

// Getting information about alerts, silences and alerting rules from the Administrator perspective
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc[leveloffset=+1,tags=**;ADM;!DEV]
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-adm.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
Expand All @@ -46,11 +46,11 @@ When you create silences, they are replicated across Alertmanager pods. However,
* xref:../key-concepts/key-concepts.adoc#managing-silences_key-concepts[Managing silences]
* xref:../configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage]

include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2,tags=**;ADM;!DEV]
include::modules/monitoring-silencing-alerts-adm.adoc[leveloffset=+2]

include::modules/monitoring-editing-silences.adoc[leveloffset=+2,tags=**;ADM;!DEV]
include::modules/monitoring-editing-silences-adm.adoc[leveloffset=+2]

include::modules/monitoring-expiring-silences.adoc[leveloffset=+2,tags=**;ADM;!DEV]
include::modules/monitoring-expiring-silences-adm.adoc[leveloffset=+2]

[id="managing-alerting-rules-for-core-platform-monitoring_{context}"]
== Managing alerting rules for core platform monitoring
Expand Down
1 change: 1 addition & 0 deletions modules/monitoring-4-15-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="monitoring-4-15-release-notes_{context}"]
= {ocp} {product-version} monitoring release notes

[role="_abstract"]
The changes for {ocp} {product-version} monitoring are included in the following errata advisory:

* link:https://access.redhat.com/errata/RHSA-2023:7198[RHSA-2023:7198]
Expand Down
15 changes: 15 additions & 0 deletions modules/monitoring-accessing-the-alerting-ui-adm.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * observability/monitoring/managing-alerts.adoc
// * logging/logging_alerts/log-storage-alerts.adoc

:_mod-docs-content-type: PROCEDURE
[id="monitoring-accessing-the-alerting-ui-adm_{context}"]
= Accessing the Alerting UI from the Administrator perspective

[role="_abstract"]
The Alerting UI is accessible through the *Administrator* perspective of the {ocp} web console.

.Procedure

* From the *Administrator* perspective, go to *Observe* -> *Alerting*. The three main pages in the Alerting UI in this perspective are the *Alerts*, *Silences*, and *Alerting rules* pages.
21 changes: 21 additions & 0 deletions modules/monitoring-accessing-the-alerting-ui-dev.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Module included in the following assemblies:
//
// * observability/monitoring/managing-alerts.adoc
// * logging/logging_alerts/log-storage-alerts.adoc

:_mod-docs-content-type: PROCEDURE
[id="monitoring-accessing-the-alerting-ui-dev_{context}"]
= Accessing the Alerting UI from the Developer perspective

[role="_abstract"]
The Alerting UI is accessible through the *Developer* perspective of the {ocp} web console.

.Procedure

. From the *Developer* perspective, go to *Observe* and go to the *Alerts* tab.
. Select the project that you want to manage alerts for from the *Project:* list. In this perspective, alerts, silences, and alerting rules are all managed from the *Alerts* tab. The results shown in the *Alerts* tab are specific to the selected project.
+
[NOTE]
====
In the *Developer* perspective, you can select from core {ocp} and user-defined projects that you have access to in the *Project: <project_name>* list. However, alerts, silences, and alerting rules relating to core {ocp} projects are not displayed if you are not logged in as a cluster administrator.
====
44 changes: 0 additions & 44 deletions modules/monitoring-accessing-the-alerting-ui.adoc

This file was deleted.

32 changes: 32 additions & 0 deletions modules/monitoring-editing-silences-adm.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Module included in the following assemblies:
//
// * observability/monitoring/managing-alerts.adoc

:_mod-docs-content-type: PROCEDURE
[id="editing-silences-adm_{context}"]
= Editing silences from the Administrator perspective

[role="_abstract"]
You can edit a silence, which expires the existing silence and creates a new one with the changed configuration.

.Prerequisites

ifndef::openshift-dedicated,openshift-rosa[]
* If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role.
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
* If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role.
endif::openshift-dedicated,openshift-rosa[]
* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.

.Procedure

. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Silences*.

. For the silence you want to modify, click {kebab} and select *Edit silence*.
+
Alternatively, you can click *Actions* and select *Edit silence* on the *Silence details* page for a silence.

. On the *Edit silence* page, make changes and click *Silence*. Doing so expires the existing silence and creates one with the updated configuration.
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,8 @@
// * observability/monitoring/managing-alerts.adoc

:_mod-docs-content-type: PROCEDURE
// tag::ADM[]
[id="editing-silences-adm_{context}"]
= Editing silences from the Administrator perspective
// end::ADM[]
// tag::DEV[]
[id="editing-silences-dev_{context}"]
= Editing silences from the Developer perspective
// end::DEV[]

[role="_abstract"]
You can edit a silence, which expires the existing silence and creates a new one with the changed configuration.
Expand All @@ -25,31 +19,16 @@ ifdef::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa[]
* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
// tag::ADM[]
** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.
// end::ADM[]
// tag::DEV[]
** The `monitoring-rules-edit` cluster role, which permits you to create and silence alerts in the *Developer* perspective in the web console.
// end::DEV[]

.Procedure

// tag::ADM[]
. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Silences*.
// end::ADM[]

// tag::DEV[]
. From the *Developer* perspective of the {ocp} web console, go to *Observe* and go to the *Silences* tab.

. Select the project that you want to edit silences for from the *Project:* list.
// end::DEV[]

. For the silence you want to modify, click {kebab} and select *Edit silence*.
+
Alternatively, you can click *Actions* and select *Edit silence* on the *Silence details* page for a silence.

. On the *Edit silence* page, make changes and click *Silence*. Doing so expires the existing silence and creates one with the updated configuration.





38 changes: 38 additions & 0 deletions modules/monitoring-expiring-silences-adm.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Module included in the following assemblies:
//
// * observability/monitoring/managing-alerts.adoc

:_mod-docs-content-type: PROCEDURE
[id="expiring-silences-adm_{context}"]
= Expiring silences from the Administrator perspective

[role="_abstract"]
You can expire a single silence or multiple silences. Expiring a silence deactivates it permanently.

[NOTE]
====
You cannot delete expired, silenced alerts.
Expired silences older than 120 hours are garbage collected.
====

.Prerequisites

ifndef::openshift-dedicated,openshift-rosa[]
* If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role.
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
* If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role.
endif::openshift-dedicated,openshift-rosa[]
* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.

.Procedure

. Go to *Observe* -> *Alerting* -> *Silences*.

. For the silence or silences you want to expire, select the checkbox in the corresponding row.

. Click *Expire 1 silence* to expire a single selected silence or *Expire _<n>_ silences* to expire multiple selected silences, where _<n>_ is the number of silences you selected.
+
Alternatively, to expire a single silence you can click *Actions* and select *Expire silence* on the *Silence details* page for a silence.
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,8 @@
// * observability/monitoring/managing-alerts.adoc

:_mod-docs-content-type: PROCEDURE
// tag::ADM[]
[id="expiring-silences-adm_{context}"]
= Expiring silences from the Administrator perspective
// end::ADM[]
// tag::DEV[]
[id="expiring-silences-dev_{context}"]
= Expiring silences from the Developer perspective
// end::DEV[]

[role="_abstract"]
You can expire a single silence or multiple silences. Expiring a silence deactivates it permanently.
Expand All @@ -31,29 +25,16 @@ ifdef::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa[]
* If you are a non-administrator user, you have access to the cluster as a user with the following user roles:
** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager.
// tag::ADM[]
** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts in the *Administrator* perspective in the web console.
// end::ADM[]
// tag::DEV[]
** The `monitoring-rules-edit` cluster role, which permits you to create and silence alerts in the *Developer* perspective in the web console.
// end::DEV[]

.Procedure

// tag::ADM[]
. Go to *Observe* -> *Alerting* -> *Silences*.
// end::ADM[]

// tag::DEV[]
. From the *Developer* perspective of the {ocp} web console, go to *Observe* and go to the *Silences* tab.

. Select the project that you want to expire a silence for from the *Project:* list.
// end::DEV[]

. For the silence or silences you want to expire, select the checkbox in the corresponding row.

. Click *Expire 1 silence* to expire a single selected silence or *Expire _<n>_ silences* to expire multiple selected silences, where _<n>_ is the number of silences you selected.
+
Alternatively, to expire a single silence you can click *Actions* and select *Expire silence* on the *Silence details* page for a silence.


Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,8 @@
// * observability/monitoring/managing-alerts.adoc

:_mod-docs-content-type: PROCEDURE
// tag::ADM[]
[id="getting-information-about-alerts-silences-and-alerting-rules-adm_{context}"]
= Getting information about alerts, silences, and alerting rules from the Administrator perspective
// end::ADM[]
// tag::DEV[]
[id="getting-information-about-alerts-silences-and-alerting-rules-dev_{context}"]
= Getting information about alerts, silences, and alerting rules from the Developer perspective
// end::DEV[]

[role="_abstract"]
The Alerting UI provides detailed information about alerts and their governing alerting rules and silences.
Expand All @@ -21,7 +15,6 @@ The Alerting UI provides detailed information about alerts and their governing a

.Procedure

// tag::ADM[]
* To obtain information about alerts:

. From the *Administrator* perspective of the {ocp} web console, go to the *Observe* -> *Alerting* -> *Alerts* page.
Expand Down Expand Up @@ -74,29 +67,3 @@ The Alerting UI provides detailed information about alerts and their governing a
** The time for which the condition should be true for an alert to fire.
** A graph for each alert governed by the alerting rule, showing the value with which the alert is firing.
** A table of all alerts governed by the alerting rule.
// end::ADM[]

// tag::DEV[]
* To obtain information about alerts, silences, and alerting rules:

. From the *Developer* perspective of the {ocp} web console, go to the *Observe* -> *<project_name>* -> *Alerts* page.

. View details for an alert, silence, or an alerting rule:

** *Alert details* can be viewed by clicking a greater than symbol (*>*) next to an alert name and then selecting the alert from the list.

** *Silence details* can be viewed by clicking a silence in the *Silenced by* section of the *Alert details* page. The *Silence details* page includes the following information:

*** Alert specification
*** Start time
*** End time
*** Silence state
*** Number and list of firing alerts

** *Alerting rule details* can be viewed by clicking the {kebab} menu next to an alert in the *Alerts* page and then clicking *View Alerting Rule*.

[NOTE]
====
Only alerts, silences, and alerting rules relating to the selected project are displayed in the *Developer* perspective.
====
// end::DEV[]
Loading