diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/_index.md index 3abcea08ed0..da627e8e719 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/_index.md @@ -38,7 +38,7 @@ For more information about upgrading the Monitoring app in Rancher 2.5, please r - [Grafana UI](#grafana-ui) - [Prometheus UI](#prometheus-ui) - [Viewing the Prometheus Targets](#viewing-the-prometheus-targets) - - [Viewing the Prometheus Rules](#viewing-the-prometheus-rules) + - [Viewing the PrometheusRules](#viewing-the-prometheus-rules) - [Viewing Active Alerts in Alertmanager](#viewing-active-alerts-in-alertmanager) - [Uninstall Monitoring](#uninstall-monitoring) - [Setting Resource Limits and Requests](#setting-resource-limits-and-requests) @@ -129,14 +129,14 @@ To see the Prometheus Targets, install `rancher-monitoring`. Then go to the **Cl
Targets in the Prometheus UI
![Prometheus Targets UI]({{}}/img/rancher/prometheus-targets-ui.png) -### Viewing the Prometheus Rules +### Viewing the PrometheusRules -To see the Prometheus Rules, install `rancher-monitoring`. Then go to the **Cluster Explorer.** In the top left corner, click **Cluster Explorer > Monitoring.** Then click **Prometheus Rules.** +To see the PrometheusRules, install `rancher-monitoring`. Then go to the **Cluster Explorer.** In the top left corner, click **Cluster Explorer > Monitoring.** Then click **Prometheus Rules.**
Rules in the Prometheus UI
-![Prometheus Rules UI]({{}}/img/rancher/prometheus-rules-ui.png) +![PrometheusRules UI]({{}}/img/rancher/prometheus-rules-ui.png) -For more information on Prometheus Rules in Rancher, see [this page.](./configuration/prometheusrules) +For more information on PrometheusRules in Rancher, see [this page.](./configuration/prometheusrules) ### Viewing Active Alerts in Alertmanager @@ -146,7 +146,7 @@ The Alertmanager handles alerts sent by client applications such as the Promethe In the Alertmanager UI, you can view your alerts and the current Alertmanager configuration. -To see the Prometheus Rules, install `rancher-monitoring`. Then go to the **Cluster Explorer.** In the top left corner, click **Cluster Explorer > Monitoring.** Then click **Alertmanager.** +To see the PrometheusRules, install `rancher-monitoring`. Then go to the **Cluster Explorer.** In the top left corner, click **Cluster Explorer > Monitoring.** Then click **Alertmanager.** **Result:** The Alertmanager UI opens in a new tab. For help with configuration, refer to the [official Alertmanager documentation.](https://prometheus.io/docs/alerting/latest/alertmanager/) diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/_index.md index 2479ff2314c..8f7ae53ca05 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/_index.md @@ -49,7 +49,7 @@ This CRD declaratively specifies how group of pods should be monitored. Any Pods This CRD defines a group of Prometheus alerting and/or recording rules. -For information on configuring Prometheus rules, refer to [this page.](./prometheusrules) +For information on configuring PrometheusRules, refer to [this page.](./prometheusrules) # Alertmanager Config @@ -85,9 +85,11 @@ An example PodMonitor can be found [here.](https://github.com/prometheus-operato ### PrometheusRule -Prometheus rule files are held in PrometheusRule custom resources. For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -Use the label selector field ruleSelector in the Prometheus object to define the rule files that you want to be mounted into Prometheus. An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. + +An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) ### Alertmanager Config diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md index f306902e888..1862398d06e 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/alertmanager/_index.md @@ -42,7 +42,7 @@ For more information, refer to the [official Prometheus documentation about conf ### Connecting Routes and PrometheusRules -When you define a Rule within a RuleGroup of a PrometheusRule, the spec of the Rule itself contains labels that are used by Prometheus to figure out which Route should receive this Alert. For example, an Alert with the label `team: front-end` will be sent to all Routes that match on that label. +When you define a Rule (which is declared within a RuleGroup in a PrometheusRule resource), the [spec of the Rule itself](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#rule) contains labels that are used by Prometheus to figure out which Route should receive this Alert. For example, an Alert with the label `team: front-end` will be sent to all Routes that match on that label. # Creating Receivers in the Rancher UI _Available as of v2.5.4_ diff --git a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/prometheusrules/_index.md b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/prometheusrules/_index.md index 5ba169f87f3..6e249101c48 100644 --- a/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/prometheusrules/_index.md +++ b/content/rancher/v2.x/en/monitoring-alerting/v2.5/configuration/prometheusrules/_index.md @@ -17,7 +17,7 @@ A PrometheusRule defines a group of Prometheus alerting and/or recording rules. Prometheus rule files are held in PrometheusRule custom resources. -A PrometheusRule allows you to define one or more RuleGroups. Each RuleGroup consists of a set of alerting or recording rules with the following fields: +A PrometheusRule allows you to define one or more RuleGroups. Each RuleGroup consists of a set of Rule objects that can each represent either an alerting or a recording rule with the following fields: - The name of the new alert or record - A PromQL (Prometheus query language) expression for the new alert or record @@ -34,7 +34,7 @@ For examples, refer to the Prometheus documentation on [recording rules](https:/ ### Connecting Routes and PrometheusRules -When you define a Rule within a RuleGroup of a PrometheusRule, the spec of the Rule itself contains labels that are used by Prometheus to figure out which Route should receive this Alert. For example, an Alert with the label `team: front-end` will be sent to all Routes that match on that label. +When you define a Rule (which is declared within a RuleGroup in a PrometheusRule resource), the [spec of the Rule itself](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#rule) contains labels that are used by Prometheus to figure out which Route should receive this Alert. For example, an Alert with the label `team: front-end` will be sent to all Routes that match on that label. ### Creating PrometheusRules in the Rancher UI @@ -75,7 +75,7 @@ Rancher v2.5.4 introduced the capability to configure PrometheusRules by filling |-------|----------------| | Alert Name | The name of the alert. Must be a valid label value. | | Wait To Fire For | Duration in seconds. Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. | -| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../expression) | +| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and all resultant time series will become pending/firing alerts. For more information, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../expression) | | Labels | Labels to add or overwrite for each alert. | | Severity | When enabled, labels are attached to the alert or record that identify it by the severity level. | | Severity Label Value | Critical, warning, or none | @@ -88,7 +88,7 @@ Rancher v2.5.4 introduced the capability to configure PrometheusRules by filling | Field | Description | |-------|----------------| | Time Series Name | The name of the time series to output to. Must be a valid metric name. | -| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../expression) | +| PromQL Expression | The PromQL expression to evaluate. Prometheus will evaluate the current value of this PromQL expression on every evaluation cycle and the result will be recorded as a new set of time series with the metric name as given by 'record'. For more information about expressions, refer to the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/) or our [example PromQL expressions.](../expression) | | Labels | Labels to add or overwrite before storing the result. | {{% /tab %}}