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

✨ Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). #2986

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fengruotj
Copy link

@fengruotj fengruotj commented Oct 15, 2024

Currently the controller-runtime only expose client-go metrics with requestLatency. In a production environment, we need to expose more client-go Metrics, such as requestLatency and rateLimiterLatency.

This PR adds more client-go metrics with rest_client_request_duration_seconds & rest_client_rate_limiter_duration_seconds.

Copy link

linux-foundation-easycla bot commented Oct 15, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: fengruotj / name: Master.TJ (0d89471)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 15, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @fengruotj!

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 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 Oct 15, 2024
@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 15, 2024
@fengruotj fengruotj force-pushed the kube-client-go-metrics branch from ecaffdc to c0a7e6d Compare October 15, 2024 07:11
@k8s-ci-robot 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 Oct 15, 2024
@fengruotj fengruotj changed the title Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). :sparkles Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). Oct 15, 2024
@fengruotj fengruotj changed the title :sparkles Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). ✨ Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). Oct 15, 2024
@fengruotj fengruotj changed the title ✨ Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). ✨ Support RateLimiterLatency & RequestLatency for client-go metrics (client, workqueue, reflector). Oct 15, 2024
@fengruotj fengruotj force-pushed the kube-client-go-metrics branch 2 times, most recently from 5001dca to 73ce1ee Compare October 15, 2024 13:04
…ient, workqueue, reflector)

Signed-off-by: tanjie.master <[email protected]>
@fengruotj fengruotj force-pushed the kube-client-go-metrics branch from 73ce1ee to 0d89471 Compare October 16, 2024 02:56
@fengruotj
Copy link
Author

Hi @varshaprasad96 @vincepri this is the pr feature: Support RateLimiterLatency & RequestLatency for client-go metrics.

prometheus.HistogramOpts{
Name: "rest_client_rate_limiter_duration_seconds",
Help: "Client side rate limiter latency in seconds. Broken down by verb and URL.",
Buckets: []float64{0.005, 0.01, 0.025, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0,
Copy link
Member

Choose a reason for hiding this comment

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

These have a ton of buckets and dimensions that include the path which means things like object names will be in there, this will result in a huge cardinality, we can not include something like this by default

Copy link
Author

@fengruotj fengruotj Oct 17, 2024

Choose a reason for hiding this comment

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

My primary requirement is to register some custom metrics for client-go/tools/metrics. However, when using controller-runtime, I am unable to customize the registration of client-go metrics because registerClientMetrics() has a higher precedence. Therefore, I need to add some additional metrics. Perhaps we could reduce the number of buckets and some tags metrics in this case, or using prometheus Summary metrics instead?

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. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants