Skip to content

✨ Allow overriding REST client latency histogram buckets - #3573

Open
wieghx wants to merge 1 commit into
kubernetes-sigs:mainfrom
wieghx:feat/rest-client-metric-buckets
Open

✨ Allow overriding REST client latency histogram buckets#3573
wieghx wants to merge 1 commit into
kubernetes-sigs:mainfrom
wieghx:feat/rest-client-metric-buckets

Conversation

@wieghx

@wieghx wieghx commented Aug 18, 2026

Copy link
Copy Markdown

What

Make classic histogram buckets for the opt-in REST client duration metrics overridable at registration time.

RegisterRESTClientMetrics is unchanged and still uses the Kubernetes-default buckets (starting at 5ms). Callers that scrape only classic buckets and need sub-5ms resolution can do:

metrics.RegisterRESTClientMetricsWithOptions(metrics.RESTClientMetricsOptions{
    DurationBuckets: []float64{0.001, 0.0025, 0.005, 0.025, 0.1, 0.25, 0.5, 1, 2, 4, 8, 15, 30, 60},
}, metrics.MetricRequestLatency, metrics.MetricRateLimiterLatency)

This applies to:

  • rest_client_request_duration_seconds
  • rest_client_dns_resolution_duration_seconds
  • rest_client_rate_limiter_duration_seconds

Native histogram settings (NativeHistogramBucketFactor etc.) are not changed. Size histograms are not changed. The first RegisterRESTClientMetrics* call wins so already-registered collectors are not replaced.

Why

Follow-up to #3510 / #3559. Fast controller hot-path PATCH/PUT latencies often sit in the 1–15ms range; with the default 5ms / 25ms buckets, p50/p90 on classic histograms is mostly quantization artifact. Changing the defaults would diverge from Kubernetes core, so this is opt-in only.

How to verify

go test ./pkg/metrics/ -count=1

This PR was written in part with the assistance of generative AI.

Fixes #3559

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Aug 18, 2026
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 18, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: wieghx / name: wieghx (65d8c00)

@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: wieghx
Once this PR has been reviewed and has the lgtm label, please assign joelanford for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @wieghx!

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. 😃

@kubernetes-prow kubernetes-prow Bot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 18, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Hi @wieghx. 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.

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-sigs/prow repository.

@kubernetes-prow kubernetes-prow Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 18, 2026
Add RegisterRESTClientMetricsWithOptions so callers can supply classic
Prometheus buckets for the opt-in REST client duration metrics without
changing the Kubernetes-default 5ms+ buckets.

Native histogram settings are unchanged. The first registration call
wins so collectors are not replaced.

Signed-off-by: wieghx <gudemail1991@gmail.com>
@wieghx
wieghx force-pushed the feat/rest-client-metric-buckets branch from 5f5cd86 to 65d8c00 Compare August 18, 2026 03:25
@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 18, 2026
@wieghx

wieghx commented Aug 18, 2026

Copy link
Copy Markdown
Author

CLA is signed (cncf-cla: yes). Happy to address review comments.

Could an org member please add /ok-to-test when you get a chance?

@sbueringer

Copy link
Copy Markdown
Member

/ok-to-test

@kubernetes-prow kubernetes-prow Bot 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 Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Opt-in REST client metrics: allow overriding histogram buckets (sub-5ms resolution for fast controllers)

2 participants