Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add summary and description for prometheus alerts #2361

Merged
merged 4 commits into from
Sep 21, 2021

Conversation

tylerslaton
Copy link
Contributor

Description of the change:

Adding a summary annotation and replace the message annotation with description for prometheus alerts.

Motivation for the change:
Fixing Bug 1992510 which references the Open Shift alerting standards.

Reviewer Checklist

  • Implementation matches the proposed design, or proposal is updated to match implementation
  • Sufficient unit test coverage
  • Sufficient end-to-end test coverage
  • Docs updated or added to /doc
  • Commit messages sensible and descriptive

@tylerslaton tylerslaton changed the title Add summary and replace message with description for alerts Add summary and description for prometheus alerts Sep 16, 2021
Signed-off-by: Tyler Slaton <tyslaton@redhat.com>
Signed-off-by: Tyler Slaton <tyslaton@redhat.com>
Copy link
Member

@njhale njhale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, thanks!

/approve

@openshift-ci
Copy link

openshift-ci bot commented Sep 20, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: njhale, tylerslaton

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 20, 2021
@awgreene
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 21, 2021
@openshift-merge-robot openshift-merge-robot merged commit 54f954b into operator-framework:master Sep 21, 2021
Copy link
Contributor

@timflannagan timflannagan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add any tests that ensure this behavior for any of the metrics present in that PrometheusRule resource in the e2e suite to ensure we don't regress?

/lgtm

@tylerslaton
Copy link
Contributor Author

Do we need to add any tests that ensure this behavior for any of the metrics present in that PrometheusRule resource in the e2e suite to ensure we don't regress?

/lgtm

It wouldn't hurt to have a test case that checks that those alerts fire when we expect and adhere to the standards linked above (with the summary and description being present). That would also make sure, like you said, that we don't remove this in the future.

@tylerslaton tylerslaton changed the title Add summary and description for prometheus alerts Bug 1992510: Add summary and description for prometheus alerts Sep 21, 2021
@openshift-ci
Copy link

openshift-ci bot commented Sep 21, 2021

@tylerslaton: All pull requests linked via external trackers have merged:

Bugzilla bug 1992510 has been moved to the MODIFIED state.

In response to this:

Bug 1992510: Add summary and description for prometheus alerts

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@timflannagan timflannagan changed the title Bug 1992510: Add summary and description for prometheus alerts Add summary and description for prometheus alerts Sep 21, 2021
@timflannagan
Copy link
Contributor

Removing "Bug 1992510:" as this is the upstream repository and automation will pick up this PR and move it into the incorrect state.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants