✨ Add webhook total and in-flight metrics #944

boekkooi-fresh · 2020-05-12T13:14:43Z

Add a gauge for requests currently being handled and a counter for the total amount of requests processed.

I used prometheus/promhttp package which provides nice decorators for Http.Handler to handle the metrics instead of the custom code.

k8s-ci-robot · 2020-05-12T13:14:47Z

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: [email protected]

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 · 2020-05-12T13:14:51Z

Welcome @boekkooi-fresh!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. 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-sigs/controller-runtime 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 · 2020-05-12T13:14:51Z

Hi @boekkooi-fresh. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

Add a gauge for requests currently being handled and a counter for the total amount of requests processed. Used [prometheus/promhttp](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus/promhttp?tab=doc) package which provides nice decorators for `Http.Handler` to handle the metrics instead of the custom code.

pkg/webhook/internal/metrics/metrics.go

This created to much noise and broke BC.

boekkooi-fresh · 2020-05-13T10:45:23Z

/assign @vincepri

alvaroaleman · 2020-05-14T17:20:22Z

pkg/webhook/internal/metrics/metrics.go

+				Name: "controller_runtime_webhook_requests_total",
+				Help: "Total number of admission requests by HTTP status code.",
+			},
+			[]string{"webhook", "code"},


I think path would be the more sensible name than webhook.

Also, please use const for the label keys.

I think path would be the more sensible name than webhook.

This maybe a better name but I preferred to sick with the naming convention introduced by RequestLatency.
In my opinion have the labels consistent across metrics and avoiding a BC break was more important.

Also, please use const for the label keys.

Using const here could be done but would not fit within the current code based. See for example pkg/webhook/internal/metrics/metrics.go, pkg/metrics/client_go_adapter.go, pkg/metrics/workqueue.go etc.
From my point of view I prefer to sick with the current code style.
Would you like me to open a separate PR to ensure const's are used for all metrics within controller-runtime?

alvaroaleman · 2020-05-14T17:24:44Z

pkg/webhook/server.go

+	gge := metrics.RequestInFlight.With(lbl)
+
+	// Initialize the most likely HTTP status codes.
+	cnt.WithLabelValues("200")


What value does initialization here add?

It adds the metric to the /metrics endpoint with the count set to 0.
In my experience this allows the user of the metrics just this little more insight about which data they can work with, (used prometheus/client_golang/prometheus/promhttp/http.go as my example here)

alvaroaleman · 2020-05-14T17:26:07Z

pkg/webhook/internal/metrics/metrics.go

+	RequestInFlight = func() *prometheus.GaugeVec {
+		return prometheus.NewGaugeVec(
+			prometheus.GaugeOpts{
+				Name: "controller_runtime_webhook_requests_in_flight",


technically a conversion hook is also a webhook, would it maybe make sense to add the admission somewhere in the name to avoid name clashes?

I'm honestly not sure what the best name here but the controller_runtime_webhook_ prefixed used I got from RequestLatency since these metrics apply for the same piece of code.

It maybe better to change these names in a follow up PR to avoid a BC break within this PR?

Yeah, makes sense

alvaroaleman

/lgtm

DirectXMan12 · 2020-06-01T23:18:02Z

/approve

k8s-ci-robot · 2020-06-01T23:18:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: boekkooi-fresh, DirectXMan12

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:

~~OWNERS~~ [DirectXMan12]

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

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label May 12, 2020

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 12, 2020

k8s-ci-robot requested review from alenkacz and DirectXMan12 May 12, 2020 13:14

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 12, 2020

boekkooi-fresh added 2 commits May 12, 2020 15:34

Initialize the most likely HTTP status codes.

96e2b22

boekkooi-fresh force-pushed the webhook-metrics branch from aafa8b0 to 96e2b22 Compare May 12, 2020 13:38

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 May 12, 2020

boekkooi-fresh commented May 12, 2020

View reviewed changes

pkg/webhook/internal/metrics/metrics.go Outdated Show resolved Hide resolved

Do not include "code" for latency

374972f

This created to much noise and broke BC.

boekkooi-fresh force-pushed the webhook-metrics branch from 5f17acc to 374972f Compare May 13, 2020 10:40

k8s-ci-robot assigned vincepri May 13, 2020

alvaroaleman reviewed May 14, 2020

View reviewed changes

alvaroaleman approved these changes May 15, 2020

View reviewed changes

k8s-ci-robot assigned alvaroaleman May 15, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 15, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 1, 2020

k8s-ci-robot merged commit 587ca7c into kubernetes-sigs:master Jun 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Add webhook total and in-flight metrics #944

✨ Add webhook total and in-flight metrics #944

Uh oh!

boekkooi-fresh commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

Uh oh!

boekkooi-fresh commented May 13, 2020

Uh oh!

alvaroaleman May 14, 2020

Uh oh!

boekkooi-fresh May 15, 2020

Uh oh!

alvaroaleman May 14, 2020

Uh oh!

boekkooi-fresh May 15, 2020

Uh oh!

alvaroaleman May 14, 2020

Uh oh!

boekkooi-fresh May 15, 2020

Uh oh!

alvaroaleman May 15, 2020

Uh oh!

alvaroaleman left a comment

Uh oh!

DirectXMan12 commented Jun 1, 2020

Uh oh!

k8s-ci-robot commented Jun 1, 2020

Uh oh!

Uh oh!

✨ Add webhook total and in-flight metrics #944

✨ Add webhook total and in-flight metrics #944

Uh oh!

Conversation

boekkooi-fresh commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

k8s-ci-robot commented May 12, 2020

Uh oh!

Uh oh!

boekkooi-fresh commented May 13, 2020

Uh oh!

alvaroaleman May 14, 2020

Choose a reason for hiding this comment

Uh oh!

boekkooi-fresh May 15, 2020

Choose a reason for hiding this comment

Uh oh!

alvaroaleman May 14, 2020

Choose a reason for hiding this comment

Uh oh!

boekkooi-fresh May 15, 2020

Choose a reason for hiding this comment

Uh oh!

alvaroaleman May 14, 2020

Choose a reason for hiding this comment

Uh oh!

boekkooi-fresh May 15, 2020

Choose a reason for hiding this comment

Uh oh!

alvaroaleman May 15, 2020

Choose a reason for hiding this comment

Uh oh!

alvaroaleman left a comment

Choose a reason for hiding this comment

Uh oh!

DirectXMan12 commented Jun 1, 2020

Uh oh!

k8s-ci-robot commented Jun 1, 2020

Uh oh!

Uh oh!