Bug 2030556 - Don't display Description or Message fields for alerting rules if those annotations are missing
Summary: Don't display Description or Message fields for alerting rules if those annot...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Monitoring
Version: 4.10
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 4.10.0
Assignee: Andrew Pickering
QA Contact: Junqi Zhao
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-12-09 06:36 UTC by Andrew Pickering
Modified: 2022-03-10 16:33 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-03-10 16:32:55 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift console pull 10639 0 None open Bug 2030556: Monitoring: Don't assume rules have Description & Message annotations 2021-12-09 06:39:20 UTC
Red Hat Product Errata RHSA-2022:0056 0 None None None 2022-03-10 16:33:08 UTC

Description Andrew Pickering 2021-12-09 06:36:50 UTC
Go to the Observe > Alerting > Alerting Rules page, then click on a rule to navigate to its details page.

Some rules do not have a `description` annotation, but the Description field is always shown. Other rules do not have a `message` annotation, but the Message field is always shown.

This differs from the behavior on the alert details page, which hides those fields when the annotation is missing.

Comment 2 Junqi Zhao 2021-12-20 09:54:08 UTC
tested the following scenarios with 4.10.0-0.nightly-2021-12-18-034942, if the Description or Message fields are missing, the alert rule detail page won't show the missing fields
1. no message field, but has description field
***************
alert: Watchdog
expr: vector(1)
labels:
  namespace: openshift-monitoring
  severity: none
annotations:
  description: This is an alert meant to ensure that the entire alerting pipeline is functional. This alert is always firing, therefore it should always be firing in Alertmanager and always fire against a receiver. There are integrations with various notification mechanisms that send a notification when this alert is not firing. For example the "DeadMansSnitch" integration in PagerDuty.
summary: An alert that should always be firing to certify that Alertmanager is working properly.


2. no description filed, but has message field
alert: SamplesDegraded
expr: openshift_samples_degraded_info == 1
for: 2h
labels:
  severity: warning
annotations:
  message: Samples could not be deployed and the operator is degraded. Review the "openshift-samples" ClusterOperator object for further details.

3. has description and message fields
alert: HAProxyDown
expr: haproxy_up == 0
for: 5m
labels:
  severity: critical
annotations:
  description: This alert fires when metrics report that HAProxy is down.
  message: HAProxy metrics are reporting that HAProxy is down on pod {{ $labels.namespace }} / {{ $labels.pod }}
  summary: HAProxy is down

Comment 9 errata-xmlrpc 2022-03-10 16:32:55 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: OpenShift Container Platform 4.10.3 security update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:0056


Note You need to log in before you can comment on or make changes to this bug.