diff --git a/managing-alerts/managing-alerts-as-a-developer.adoc b/managing-alerts/managing-alerts-as-a-developer.adoc index 0e2b47a14a5c..96704253423d 100644 --- a/managing-alerts/managing-alerts-as-a-developer.adoc +++ b/managing-alerts/managing-alerts-as-a-developer.adoc @@ -15,7 +15,7 @@ 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 @@ -23,7 +23,7 @@ include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1,tags=* * 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 @@ -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 diff --git a/managing-alerts/managing-alerts-as-an-administrator.adoc b/managing-alerts/managing-alerts-as-an-administrator.adoc index 5adca6a0bbb3..9beae2403ba9 100644 --- a/managing-alerts/managing-alerts-as-an-administrator.adoc +++ b/managing-alerts/managing-alerts-as-an-administrator.adoc @@ -15,7 +15,7 @@ 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 @@ -23,7 +23,7 @@ include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1,tags=* * 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 @@ -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 diff --git a/modules/monitoring-4-17-release-notes.adoc b/modules/monitoring-4-17-release-notes.adoc index 949ee0816bef..55fab0cccab2 100644 --- a/modules/monitoring-4-17-release-notes.adoc +++ b/modules/monitoring-4-17-release-notes.adoc @@ -6,6 +6,7 @@ [id="monitoring-4-17-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-2024:3718[RHSA-2024:3718] diff --git a/modules/monitoring-accessing-the-alerting-ui-adm.adoc b/modules/monitoring-accessing-the-alerting-ui-adm.adoc new file mode 100644 index 000000000000..395410f99c53 --- /dev/null +++ b/modules/monitoring-accessing-the-alerting-ui-adm.adoc @@ -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. diff --git a/modules/monitoring-accessing-the-alerting-ui-dev.adoc b/modules/monitoring-accessing-the-alerting-ui-dev.adoc new file mode 100644 index 000000000000..323e607f055c --- /dev/null +++ b/modules/monitoring-accessing-the-alerting-ui-dev.adoc @@ -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: * 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. +==== diff --git a/modules/monitoring-accessing-the-alerting-ui.adoc b/modules/monitoring-accessing-the-alerting-ui.adoc deleted file mode 100644 index 1c109ea20b95..000000000000 --- a/modules/monitoring-accessing-the-alerting-ui.adoc +++ /dev/null @@ -1,46 +0,0 @@ -// Module included in the following assemblies: -// -// * observability/monitoring/managing-alerts.adoc -// * logging/logging_alerts/log-storage-alerts.adoc - -:_mod-docs-content-type: PROCEDURE -// tag::ADM[] -[id="monitoring-accessing-the-alerting-ui-adm_{context}"] -= Accessing the Alerting UI from the Administrator perspective -// end::ADM[] -// tag::DEV[] -[id="monitoring-accessing-the-alerting-ui-dev_{context}"] -= Accessing the Alerting UI from the Developer perspective -// end::DEV[] - -// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples - -// tag::ADM[] -:perspective: Administrator -// end::ADM[] - -// tag::DEV[] -:perspective: Developer -// end::DEV[] - -[role="_abstract"] -The Alerting UI is accessible through the *{perspective}* perspective of the {ocp} web console. - -// tag::ADM[] -* 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. -// end::ADM[] - -// tag::DEV[] -* 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: * 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. -==== -// end::DEV[] - -// Unset the source code block attributes just to be safe. -:!perspective: diff --git a/modules/monitoring-editing-silences-adm.adoc b/modules/monitoring-editing-silences-adm.adoc new file mode 100644 index 000000000000..b8f564d66591 --- /dev/null +++ b/modules/monitoring-editing-silences-adm.adoc @@ -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. diff --git a/modules/monitoring-editing-silences.adoc b/modules/monitoring-editing-silences-dev.adoc similarity index 76% rename from modules/monitoring-editing-silences.adoc rename to modules/monitoring-editing-silences-dev.adoc index f021705f8ffc..9e866949359c 100644 --- a/modules/monitoring-editing-silences.adoc +++ b/modules/monitoring-editing-silences-dev.adoc @@ -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. @@ -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. - - - - - diff --git a/modules/monitoring-expiring-silences-adm.adoc b/modules/monitoring-expiring-silences-adm.adoc new file mode 100644 index 000000000000..c709e9c63799 --- /dev/null +++ b/modules/monitoring-expiring-silences-adm.adoc @@ -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 __ silences* to expire multiple selected silences, where __ 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. diff --git a/modules/monitoring-expiring-silences.adoc b/modules/monitoring-expiring-silences-dev.adoc similarity index 80% rename from modules/monitoring-expiring-silences.adoc rename to modules/monitoring-expiring-silences-dev.adoc index c1a0046367bb..3b55990b9187 100644 --- a/modules/monitoring-expiring-silences.adoc +++ b/modules/monitoring-expiring-silences-dev.adoc @@ -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. @@ -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 __ silences* to expire multiple selected silences, where __ 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. - - diff --git a/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc b/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-adm.adoc similarity index 71% rename from modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc rename to modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-adm.adoc index e4010443e224..e70287caeda7 100644 --- a/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc +++ b/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-adm.adoc @@ -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. @@ -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. @@ -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* -> ** -> *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[] diff --git a/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-dev.adoc b/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-dev.adoc new file mode 100644 index 000000000000..21fbb67c938e --- /dev/null +++ b/modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules-dev.adoc @@ -0,0 +1,39 @@ +// Module included in the following assemblies: +// +// * observability/monitoring/managing-alerts.adoc + +:_mod-docs-content-type: PROCEDURE +[id="getting-information-about-alerts-silences-and-alerting-rules-dev_{context}"] += Getting information about alerts, silences, and alerting rules from the Developer perspective + +[role="_abstract"] +The Alerting UI provides detailed information about alerts and their governing alerting rules and silences. + +.Prerequisites + +* You have access to the cluster as a user with view permissions for the project that you are viewing alerts for. + +.Procedure + +* To obtain information about alerts, silences, and alerting rules: + +. From the *Developer* perspective of the {ocp} web console, go to the *Observe* -> ** -> *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. +==== diff --git a/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc b/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc index 8d4c1ab08b7b..00ca999ed836 100644 --- a/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc +++ b/modules/monitoring-setting-scrape-sample-and-label-limits-for-user-defined-projects.adoc @@ -6,6 +6,7 @@ [id="setting-scrape-sample-and-label-limits-for-user-defined-projects_{context}"] = Setting scrape sample and label limits for user-defined projects +[role="_abstract"] You can limit the number of samples that can be accepted per target scrape in user-defined projects. You can also limit the number of scraped labels, the length of label names, and the length of label values. [WARNING] diff --git a/modules/monitoring-silencing-alerts-adm.adoc b/modules/monitoring-silencing-alerts-adm.adoc new file mode 100644 index 000000000000..e9626a76d483 --- /dev/null +++ b/modules/monitoring-silencing-alerts-adm.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * observability/monitoring/managing-alerts.adoc + +:_mod-docs-content-type: PROCEDURE +[id="silencing-alerts-adm_{context}"] += Silencing alerts from the Administrator perspective + +[role="_abstract"] +You can silence a specific alert or silence alerts that match a specification that you define. + +.Prerequisites + +* You have access to the cluster as a user with the `cluster-admin` role. + +.Procedure + +* To silence a specific alert: + +. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Alerts*. + +. For the alert that you want to silence, click {kebab} and select *Silence alert* to open the *Silence alert* page with a default configuration for the chosen alert. + +. Optional: Change the default configuration details for the silence. ++ +[NOTE] +==== +You must add a comment before saving a silence. +==== + +. To save the silence, click *Silence*. + +* To silence a set of alerts: + +. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Silences*. + +. Click *Create silence*. + +. On the *Create silence* page, set the schedule, duration, and label details for an alert. ++ +[NOTE] +==== +You must add a comment before saving a silence. +==== + +. To create silences for alerts that match the labels that you entered, click *Silence*. diff --git a/modules/monitoring-silencing-alerts.adoc b/modules/monitoring-silencing-alerts-dev.adoc similarity index 66% rename from modules/monitoring-silencing-alerts.adoc rename to modules/monitoring-silencing-alerts-dev.adoc index 8e3402b45f71..096275c04d3c 100644 --- a/modules/monitoring-silencing-alerts.adoc +++ b/modules/monitoring-silencing-alerts-dev.adoc @@ -3,25 +3,14 @@ // * observability/monitoring/managing-alerts.adoc :_mod-docs-content-type: PROCEDURE -// tag::ADM[] -[id="silencing-alerts-adm_{context}"] -= Silencing alerts from the Administrator perspective -// end::ADM[] -// tag::DEV[] [id="silencing-alerts-dev_{context}"] = Silencing alerts from the Developer perspective -// end::DEV[] [role="_abstract"] You can silence a specific alert or silence alerts that match a specification that you define. .Prerequisites -// tag::ADM[] -* You have access to the cluster as a user with the `cluster-admin` role. -// end::ADM[] - -// tag::DEV[] 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[] @@ -32,43 +21,9 @@ endif::openshift-dedicated,openshift-rosa[] ** 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. ** 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[] -* To silence a specific alert: - -. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Alerts*. - -. For the alert that you want to silence, click {kebab} and select *Silence alert* to open the *Silence alert* page with a default configuration for the chosen alert. - -. Optional: Change the default configuration details for the silence. -+ -[NOTE] -==== -You must add a comment before saving a silence. -==== - -. To save the silence, click *Silence*. - -* To silence a set of alerts: - -. From the *Administrator* perspective of the {ocp} web console, go to *Observe* -> *Alerting* -> *Silences*. - -. Click *Create silence*. - -. On the *Create silence* page, set the schedule, duration, and label details for an alert. -+ -[NOTE] -==== -You must add a comment before saving a silence. -==== - -. To create silences for alerts that match the labels that you entered, click *Silence*. -// end::ADM[] - -// tag::DEV[] * To silence a specific alert: . From the *Developer* perspective of the {ocp} web console, go to *Observe* and go to the *Alerts* tab. @@ -106,4 +61,3 @@ You must add a comment before saving a silence. ==== . To create silences for alerts that match the labels that you entered, click *Silence*. -// end::DEV[] \ No newline at end of file