Skip to content

Conversation

@bison
Copy link

@bison bison commented Sep 23, 2021

The Alerting Consistency enhancement, and the proposed updates to
it in openshift/enhancements #897, define a style-guide for the
alerts shipped as part of OpenShift. This adds a test validating some
of the guidelines considered required.

This builds on and replaces #26016. There are currently a lot of failures due to non-conformant rules. We'll be filing bugs for these, and will add exceptions here until they are fixed.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 23, 2021
@bison
Copy link
Author

bison commented Sep 23, 2021

/assign @simonpasquier

Copy link
Contributor

@simonpasquier simonpasquier left a comment

Choose a reason for hiding this comment

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

Neat!

@bison
Copy link
Author

bison commented Sep 28, 2021

/retest

@bison bison changed the title WIP: test/extended/prometheus: Validate alerting rules test/extended/prometheus: Validate alerting rules Sep 28, 2021
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 28, 2021
@bison
Copy link
Author

bison commented Sep 28, 2021

/retest

1 similar comment
@bison
Copy link
Author

bison commented Sep 28, 2021

/retest

Copy link
Member

@dgrisonnet dgrisonnet left a comment

Choose a reason for hiding this comment

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

Awesome, I just have a few comments, but it looks good to me overall.

}

if alertingRules == nil {
var err error
Copy link
Member

Choose a reason for hiding this comment

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

nit: we could have fetchAlertingRules initializing the error variable since it isn't used anywhere else.

Copy link
Author

Choose a reason for hiding this comment

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

I was trying to avoid fetching these each time, while still being able to separate each check into its own g.It("should..") block. So alertingRules is actually defined in the outer scope, and it only does the fetch if it hasn't been initialized. Having the call to fetchAlertingRules() initialize err would shadow alertingRules. Let me know if I'm misunderstanding though.

Copy link
Member

Choose a reason for hiding this comment

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

Ah indeed, I missed that alertingRules was defined in the outer scope, makes sense now 👍

The [Alerting Consistency][1] enhancement, and the proposed updates to
it in [openshift/enhancements #897][2], define a style-guide for the
alerts shipped as part of OpenShift.  This adds a test validating some
of the guidelines considered required.

[1]: https://github.com/openshift/enhancements/blob/master/enhancements/monitoring/alerting-consistency.md
[2]: openshift/enhancements#897
@bison
Copy link
Author

bison commented Sep 29, 2021

/retest

@dgrisonnet
Copy link
Member

/lgtm
/assign @smarterclayton

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 29, 2021
@bison
Copy link
Author

bison commented Sep 30, 2021

I guess we need someone from the OWNERS file to approve this. Could maybe @bparees or @smarterclayton have a look if you have a minute?

@bparees
Copy link
Contributor

bparees commented Sep 30, 2021

/approve

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 30, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bison, bparees, dgrisonnet

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

The pull request process is described here

Details 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 30, 2021
@dgrisonnet
Copy link
Member

/retest-required

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

5 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

18 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 1, 2021

@bison: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-agnostic-cmd 097e7a6 link false /test e2e-agnostic-cmd

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

3 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-merge-robot openshift-merge-robot merged commit 7e8c994 into openshift:master Oct 1, 2021
@bison bison deleted the alerting-guidelines branch October 1, 2021 10:21
@stbenjam
Copy link
Member

stbenjam commented Oct 4, 2021

TRT had to revert this today because it was causing a large number of jobs to fail. In the unrevert, please fix or add exceptions for the jobs that were failing. A list of job runs that contained this failure is available here: https://sippy.ci.openshift.org/sippy-ng/jobs/4.10/runs?filters=%7B%22items%22%3A%5B%7B%22columnField%22%3A%22failedTestNames%22%2C%22operatorValue%22%3A%22contains%22%2C%22value%22%3A%22OpenShift%20alerting%20rules%20should%20have%20description%20and%20summary%20annotations%22%7D%5D%2C%22linkOperator%22%3A%22and%22%7D&sort=desc&sortField=timestamp

It appears to be all OVN and vsphere jobs.

jsafrane pushed a commit to jsafrane/origin that referenced this pull request Nov 11, 2021
The [OpenShift Alerting Consistency][1] enhancement defines a style
guide for the alerts shipped as part of OpenShift.  This adds a test
validating some of the guidelines considered required.

This was originally added in openshift#26476, but was reverted in openshift#26499 due to
failures with OVN and vSphere clusters.  This adds the tests back, but
adds exceptions for the non-compliant alerts as well as marking the
failing tests as flakes for now.  We'll gather data and make the tests
required once we're reasonably sure things are passing with all the
existing alerts.

[1]: https://github.com/openshift/enhancements/blob/master/enhancements/monitoring/alerting-consistency.md
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.

8 participants