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

Add arg use-api-server-cache to set resourceVersion=0 for ListWatch #1548

Merged

Conversation

liangyuanpeng
Copy link
Contributor

@liangyuanpeng liangyuanpeng commented Aug 13, 2021

What this PR does / why we need it:

ref #1518

The ability to specify whether or not to use the k8s api server by setting the resourceVersion parameter (docs).

This would be immensely helpful for us as we run this application at quite a large scale (about 8mil total timeseries, 37k pods / cluster).

We constantly get these errors, which we presume is the cause for many of our metrics to not reflect reality (e.g. terminated pods that still exist as Running in metrics):

W0630 18:02:48.644785       1 reflector.go:302] k8s.io/kube-state-metrics/internal/store/builder.go:314: watch of *v1.ConfigMap ended with: too old resource version: 2066904261 (2099124935)

(not just with ConfigMaps but every resource type)

We don't need to be so strongly consistent, thus it would be nice to allow expose this option.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1518

@k8s-ci-robot
Copy link
Contributor

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.


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 k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 13, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @liangyuanpeng!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. 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/kube-state-metrics 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 size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 13, 2021
@liangyuanpeng
Copy link
Contributor Author

Had sign the CLA.
Checked git commit for email.
Checked github for email.

@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 Aug 13, 2021
pkg/options/options.go Outdated Show resolved Hide resolved
docs/cli-arguments.md Outdated Show resolved Hide resolved
@mrueg
Copy link
Member

mrueg commented Aug 18, 2021

/lgtm
/hold
for another day to give @kubernetes/kube-state-metrics-maintainers the possibility to review as well.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 18, 2021
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 18, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liangyuanpeng, mrueg

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:

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 18, 2021
@mrueg
Copy link
Member

mrueg commented Aug 19, 2021

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 19, 2021
@k8s-ci-robot k8s-ci-robot merged commit 583d8c9 into kubernetes:master Aug 19, 2021
@mrueg
Copy link
Member

mrueg commented Aug 19, 2021

Thanks for your contribution @liangyuanpeng !

mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Aug 19, 2021
* [FEATURE] Add --use-apiserver-cache flag to set resourceVersion=0 for ListWatch requests kubernetes#1548
* [FEATURE] Introduce metrics for Kubernetes object annotations kubernetes#1468
* [FEATURE] Introduce start time metric for containers in terminated state kubernetes#1519
* [FEATURE] Introduce metrics for cronjob job history limits kubernetes#1535
* [FEATURE] Add system_uuid dimension to kube_node_info metric kubernetes#1535
* [FEATURE] Add available replica metric for statefulsets kubernetes#1532
* [FEATURE] Add ready replica metric for deployments kubernetes#1534
* [CHANGE]  Update go clients for Kubernetes to support 1.22 kubernetes#1545
* [CHANGE]  Use new promlint package and update prometheus cli to 2.28.1 kubernetes#1531
@mrueg mrueg mentioned this pull request Aug 19, 2021
@jpdstan
Copy link

jpdstan commented Aug 24, 2021

Thanks so much for working on this @liangyuanpeng !

jan--f added a commit to jan--f/cluster-monitoring-operator that referenced this pull request Oct 12, 2021
This cli arg was added in
kubernetes/kube-state-metrics#1548 and is
available since KSM v2.2.0.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
jan--f added a commit to jan--f/cluster-monitoring-operator that referenced this pull request Oct 21, 2021
This cli arg was added in
kubernetes/kube-state-metrics#1548 and is
available since KSM v2.2.0.

Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

Support returning cached results from api server (resourceVersion=0)
4 participants