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.

Sign up for GitHub

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

Jump to bottom

Use BuilderInterface instead of internal/store.Builder in metricshandler #1537

Merged
merged 1 commit into from
Jul 23, 2021
Merged

Use BuilderInterface instead of internal/store.Builder in metricshandler #1537

merged 1 commit into from
Jul 23, 2021

Conversation

FillZpp
Copy link
Contributor

@FillZpp FillZpp commented Jul 22, 2021

Signed-off-by: FillZpp FillZpp.pub@gmail.com

What this PR does / why we need it:
Use BuilderInterface instead of internal/store.Builder in metricshandler package.

The MetricsHandler should only care about the interface, not the implementation behind. So that other 3rd party projects can use kube-state-metrics as the basic dependency of their state-metrics subprojects.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 22, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @FillZpp!

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 22, 2021
@fpetkovski
Copy link
Contributor

Nice one, this LGTM

@FillZpp
Copy link
Contributor Author

FillZpp commented Jul 22, 2021

Nice one, this LGTM

Thanks!
/cc @tariq1890 @lilic

@mrueg
Copy link
Member

mrueg commented Jul 22, 2021

/approve

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 22, 2021
@FillZpp
Copy link
Contributor Author

FillZpp commented Jul 23, 2021

PTAL @brancz @tariq1890 @lilic . I'm waiting for it in another 3rd party state-metrics project. Thanks.

lilic
lilic approved these changes Jul 23, 2021
View reviewed changes
Copy link
Member

@lilic lilic left a comment

Choose a reason for hiding this comment

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

We have a /lgtm

Thanks! Curious what project you are using this for? :)

pkg/metricshandler/metrics_handler.go
@@ -56,7 +56,7 @@ type MetricsHandler struct {
}

// New creates and returns a new MetricsHandler with the given options.
Copy link
Member

Choose a reason for hiding this comment

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

Thanks, makes sense, we even have a comment about it :D

kube-state-metrics/internal/store/builder.go

Line 54 in 1d61fc1

// New Builder methods should be added to the public BuilderInterface.

@mrueg
Copy link
Member

mrueg commented Jul 23, 2021 •
edited
Loading

/lgtm
(I believe @lilic /lgtm wasn't recognized)

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 23, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: FillZpp, lilic, 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 merged commit 58869f0 into kubernetes:master Jul 23, 2021
@FillZpp
Copy link
Contributor Author

FillZpp commented Jul 23, 2021 •
edited
Loading

Thanks! Curious what project you are using this for? :)

I'm creating openkruise/kruise-state-metrics, a component that generate and expose metrics for the custom resources in OpenKruise.

I try to bring kube-state-metrics as it's basic dependency. So that it only needs to implement metrics of the CRs in internal/store, and then registers the custom builder to the metrics handler of kube-state-metrics.

😄

mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
8860aef 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
2fa7238 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
7fb06ae 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
77a333f 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
1a87d93 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 28, 2021
@mrueg
*: Cut v2.1.1 release
c3350d1 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
mrueg added a commit to mrueg/kube-state-metrics that referenced this pull request Jul 29, 2021
@mrueg
*: Cut v2.1.1 release
1e65158 
* [CHANGE] Replace multiListWatcher with independent listWatchers per namespace kubernetes#1499
* [CHANGE] go.mod: Update and minimize dependencies kubernetes#1529
* [BUGFIX] Use BuilderInterface instead of internal/store.Builder in metricshandler kubernetes#1537
* [BUGFIX] Add WithAllowLabels to public BuilderInterface kubernetes#1514
@FillZpp FillZpp mentioned this pull request Nov 16, 2021
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lilic lilic lilic approved these changes

@brancz brancz Awaiting requested review from brancz

@mrueg mrueg Awaiting requested review from mrueg

@tariq1890 tariq1890 Awaiting requested review from tariq1890

Assignees

@mrueg mrueg

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@FillZpp @k8s-ci-robot @fpetkovski @mrueg @lilic