mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
115 lines
6.8 KiB
Plaintext
115 lines
6.8 KiB
Plaintext
:_content-type: ASSEMBLY
|
|
[id="managing-alerts"]
|
|
= Managing alerts
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: managing-alerts
|
|
|
|
toc::[]
|
|
|
|
In {product-title} {product-version}, the Alerting UI enables you to manage alerts, silences, and alerting rules.
|
|
|
|
* *Alerting rules*. Alerting rules contain a set of conditions that outline a particular state within a cluster. Alerts are triggered when those conditions are true. An alerting rule can be assigned a severity that defines how the alerts are routed.
|
|
* *Alerts*. An alert is fired when the conditions defined in an alerting rule are true. Alerts provide a notification that a set of circumstances are apparent within an {product-title} cluster.
|
|
* *Silences*. A silence can be applied to an alert to prevent notifications from being sent when the conditions for an alert are true. You can mute an alert after the initial notification, while you work on resolving the underlying issue.
|
|
|
|
[NOTE]
|
|
====
|
|
The alerts, silences, and alerting rules that are available in the Alerting UI relate to the projects that you have access to. For example, if you are logged in with `cluster-admin` privileges, you can access all alerts, silences, and alerting rules.
|
|
|
|
If you are a non-administator user, you can create and silence alerts if you are assigned the following user roles:
|
|
|
|
* The `cluster-monitoring-view` 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` role, which permits you to create and silence alerts in the *Developer* perspective in the web console
|
|
====
|
|
|
|
// Accessing the Alerting UI in the Administrator and Developer perspectives
|
|
include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1]
|
|
|
|
// Searching and filtering alerts, silences, and alerting rules
|
|
include::modules/monitoring-searching-alerts-silences-and-alerting-rules.adoc[leveloffset=+1]
|
|
|
|
// Getting information about alerts, silences and alerting rules
|
|
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* See the link:https://github.com/openshift/runbooks/tree/master/alerts/cluster-monitoring-operator[Cluster Monitoring Operator runbooks] to help diagnose and resolve issues that trigger specific {product-title} monitoring alerts.
|
|
|
|
// Managing silences
|
|
include::modules/monitoring-managing-silences.adoc[leveloffset=+1]
|
|
include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2]
|
|
include::modules/monitoring-editing-silences.adoc[leveloffset=+2]
|
|
include::modules/monitoring-expiring-silences.adoc[leveloffset=+2]
|
|
|
|
// Managing alerting rules for user-defined projects
|
|
include::modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc[leveloffset=+1]
|
|
include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
|
|
ifndef::openshift-rosa,openshift-dedicated[]
|
|
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
|
|
endif::[]
|
|
|
|
include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
|
include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
|
|
|
|
ifndef::openshift-rosa,openshift-dedicated[]
|
|
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
|
endif::[]
|
|
|
|
include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
|
|
include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
|
|
include::modules/monitoring-removing-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation]
|
|
|
|
// Managing core platform alerting rules
|
|
include::modules/monitoring-managing-core-platform-alerting-rules.adoc[leveloffset=+1]
|
|
include::modules/monitoring-modifying-core-platform-alerting-rules.adoc[leveloffset=+2]
|
|
include::modules/monitoring-creating-new-alerting-rules.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
ifndef::openshift-rosa,openshift-dedicated[]
|
|
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
|
endif::[]
|
|
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation] for information about alerting rules.
|
|
* See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabeling documentation] for information about how relabeling works.
|
|
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts.
|
|
|
|
|
|
|
|
// Sending notifications to external systems
|
|
include::modules/monitoring-sending-notifications-to-external-systems.adoc[leveloffset=+1]
|
|
include::modules/monitoring-configuring-alert-receivers.adoc[leveloffset=+2]
|
|
// Creating alert routing for user-defined projects
|
|
include::modules/monitoring-creating-alert-routing-for-user-defined-projects.adoc[leveloffset=+2]
|
|
|
|
// Applying a custom Alertmanager configuration
|
|
include::modules/monitoring-applying-custom-alertmanager-configuration.adoc[leveloffset=+1]
|
|
// Applying a custom configuration to Alertmanager for user-defined alert routing
|
|
include::modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc[leveloffset=+1]
|
|
|
|
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* See link:https://www.pagerduty.com/[the PagerDuty official site] for more information on PagerDuty.
|
|
* See link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[the PagerDuty Prometheus Integration Guide] to learn how to retrieve the `service_key`.
|
|
* See link:https://prometheus.io/docs/alerting/configuration/[Alertmanager configuration] for configuring alerting through different alert receivers.
|
|
ifndef::openshift-rosa,openshift-dedicated[]
|
|
* See xref:../monitoring/enabling-alert-routing-for-user-defined-projects.adoc#enabling-alert-routing-for-user-defined-projects[Enabling alert routing for user-defined projects] to learn how to enable a dedicated instance of Alertmanager for user-defined alert routing.
|
|
|
|
|
|
== Next steps
|
|
|
|
* xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
|
endif::[]
|