add failopen metric #107171

ltagliamonte-dd · 2021-12-21T22:26:22Z

What type of PR is this?

/kind feature
/kind api-change

What this PR does / why we need it:

Add a new metric to monitor webhooks that fail open

Which issue(s) this PR fixes:

Fixes #
#107146

Special notes for your reviewer:

N/A

Does this PR introduce a user-facing change?

add a new metric `webhook_fail_open_count` to monitor webhooks that fail open

linux-foundation-easycla · 2021-12-21T22:26:24Z

The committers are authorized under a signed CLA.

✅ Luigi Tagliamonte (6542f4b)

k8s-ci-robot · 2021-12-21T22:26:24Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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.

k8s-ci-robot · 2021-12-21T22:26:29Z

Welcome @ltagliamonte-dd!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2021-12-21T22:26:30Z

Hi @ltagliamonte-dd. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

aojea · 2021-12-21T22:53:06Z

/assign @sttts

k8s-triage-robot · 2021-12-21T23:16:32Z

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

roycaihw · 2021-12-22T00:06:06Z

staging/src/k8s.io/apiserver/pkg/admission/metrics/metrics.go

@@ -116,6 +116,7 @@ type AdmissionMetrics struct {
 	controller       *metricSet
 	webhook          *metricSet
 	webhookRejection *metrics.CounterVec
+	webhookFailOpen  *metrics.CounterVec


Please see my comment in #107146 (comment). I wonder if we can achieve the goal by reusing / extending the existing metrics.

roycaihw

/lgtm
/approve
/ok-to-test

roycaihw · 2021-12-28T19:30:42Z

staging/src/k8s.io/apiserver/pkg/admission/metrics/metrics.go

@@ -250,6 +262,11 @@ func (m *AdmissionMetrics) ObserveWebhookRejection(ctx context.Context, name, st
 	m.webhookRejection.WithContext(ctx).WithLabelValues(name, stepType, operation, string(errorType), strconv.Itoa(rejectionCode)).Inc()
 }

+// ObserveWebhookFailOpen records validating or mutating webhook that fail open.
+func (m *AdmissionMetrics) ObserveWebhookFailOpen(ctx context.Context, name, stepType string) {


Please add a unit test here

done with commit 0844891, thanks to point this out.

leilajal · 2022-01-04T21:08:18Z

/triage accepted

ltagliamonte-dd · 2022-01-05T00:13:05Z

"I signed it"

sttts · 2022-01-05T09:51:56Z

Sgtm. Waiting for @roycaihw to do a final pass.

roycaihw · 2022-01-06T19:39:25Z

/lgtm
Thanks!

sttts · 2022-01-07T09:58:08Z

/approve

k8s-ci-robot · 2022-01-07T09:58:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ltagliamonte-dd, roycaihw, sttts

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:

~~staging/src/k8s.io/apiserver/OWNERS~~ [sttts]

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

logicalhan · 2022-01-13T17:56:45Z

staging/src/k8s.io/apiserver/pkg/admission/metrics/metrics.go

+		&metrics.CounterOpts{
+			Namespace:      namespace,
+			Subsystem:      subsystem,
+			Name:           "webhook_fail_open_count",


This must be suffixed _total as per instrumentation guidelines.

@logicalhan let me fix that, will open a PR shortly adding you are reviewer

@logicalhan the file contains 2 counter metrics:

webhook_rejection_count (preexisting)

webhook_fail_open_count (new added by me)

Do you want me to address both? renaming them to:

webhook_rejection_total

webhook_fail_open_total

logicalhan · 2022-01-13T17:58:28Z

/triage accepted

Ah this ended up bypassing sig-instrumentation triage, can we agree on the protocol that to /remove-sig signame if there is more than one SIG attached to the PR?

roycaihw · 2022-01-19T01:12:59Z

#107171 (comment) IIRC the bot will add a SIG back when a new git push happens, based on the files in the PR. But I agree it would be nice if we can have a way to express triage per SIG.

add failopen metric

6542f4b

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. labels Dec 21, 2021

k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 21, 2021

k8s-ci-robot requested review from hzxuzhonghu and ncdc December 21, 2021 22:27

k8s-ci-robot assigned sttts Dec 21, 2021

roycaihw reviewed Dec 22, 2021

View reviewed changes

roycaihw reviewed Dec 28, 2021

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 28, 2021

k8s-ci-robot assigned roycaihw Dec 28, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 28, 2021

add tests for new metric

0844891

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 29, 2021

ltagliamonte-dd requested a review from roycaihw January 4, 2022 16:35

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 4, 2022

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 5, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 6, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 7, 2022

k8s-ci-robot merged commit 9d0d2e8 into kubernetes:master Jan 7, 2022

k8s-ci-robot added this to the v1.24 milestone Jan 7, 2022

logicalhan reviewed Jan 13, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add failopen metric #107171

add failopen metric #107171

ltagliamonte-dd commented Dec 21, 2021

linux-foundation-easycla bot commented Dec 21, 2021 •

edited

k8s-ci-robot commented Dec 21, 2021

k8s-ci-robot commented Dec 21, 2021

k8s-ci-robot commented Dec 21, 2021

aojea commented Dec 21, 2021

k8s-triage-robot commented Dec 21, 2021

roycaihw Dec 22, 2021

roycaihw left a comment

roycaihw Dec 28, 2021

ltagliamonte-dd Dec 29, 2021

leilajal commented Jan 4, 2022

ltagliamonte-dd commented Jan 5, 2022

sttts commented Jan 5, 2022

roycaihw commented Jan 6, 2022

sttts commented Jan 7, 2022

k8s-ci-robot commented Jan 7, 2022

logicalhan Jan 13, 2022

ltagliamonte-dd Jan 18, 2022

ltagliamonte-dd Jan 18, 2022 •

edited

logicalhan commented Jan 13, 2022

roycaihw commented Jan 19, 2022

add failopen metric #107171

add failopen metric #107171

Conversation

ltagliamonte-dd commented Dec 21, 2021

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

linux-foundation-easycla bot commented Dec 21, 2021 • edited

k8s-ci-robot commented Dec 21, 2021

k8s-ci-robot commented Dec 21, 2021

k8s-ci-robot commented Dec 21, 2021

aojea commented Dec 21, 2021

k8s-triage-robot commented Dec 21, 2021

roycaihw Dec 22, 2021

Choose a reason for hiding this comment

roycaihw left a comment

Choose a reason for hiding this comment

roycaihw Dec 28, 2021

Choose a reason for hiding this comment

ltagliamonte-dd Dec 29, 2021

Choose a reason for hiding this comment

leilajal commented Jan 4, 2022

ltagliamonte-dd commented Jan 5, 2022

sttts commented Jan 5, 2022

roycaihw commented Jan 6, 2022

sttts commented Jan 7, 2022

k8s-ci-robot commented Jan 7, 2022

logicalhan Jan 13, 2022

Choose a reason for hiding this comment

ltagliamonte-dd Jan 18, 2022

Choose a reason for hiding this comment

ltagliamonte-dd Jan 18, 2022 • edited

Choose a reason for hiding this comment

logicalhan commented Jan 13, 2022

roycaihw commented Jan 19, 2022

linux-foundation-easycla bot commented Dec 21, 2021 •

edited

ltagliamonte-dd Jan 18, 2022 •

edited