builder/main: allow collectors not enabled by default #793

milesbxf · 2019-06-18T14:27:58Z

What this PR does / why we need it:

This fixes an issue where it was impossible to specify a collector that
was available but not selected by default.

Instead of checking whether chosen collectors are valid at flag parse
time, this moves the check into the builder, where we can reference it
against the availableStores in the builder. As a bonus, the error
message also prints out a list of available collectors:

kube-state-metrics --collectors non-existent-collector
I0618 15:23:34.517532   50719 main.go:88] Using collectors non-existent-collector
F0618 15:23:34.519132   50719 main.go:90] Error: collector non-existent-collector does not exist. Available collectors: persistentvolumeclaims,configmaps,limitranges,nodes,namespaces,persistentvolumes,pods,replicasets,services,cronjobs,deployments,ingresses,horizontalpodautoscalers,jobs,poddisruptionbudgets,secrets,certificatesigningrequests,daemonsets,endpoints,storageclasses,replicationcontrollers,resourcequotas,statefulsets

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 #

brancz · 2019-06-18T14:31:43Z

internal/store/builder.go

+
+func availableCollectors() []string {
+	c := []string{}
+	for name, _ := range availableStores {


this is a map already, so we can just check on existance of the collector key in this map directly in collectorExists

brancz

one more than lgtm

brancz · 2019-06-18T14:38:13Z

main.go

@@ -86,7 +86,9 @@ func main() {
 		storeBuilder.WithEnabledResources(options.DefaultCollectors.AsSlice())


even if it should be impossible, we should check the error here as well

tariq1890 · 2019-06-18T14:47:37Z

main.go

 	} else {
 		klog.Infof("Using collectors %s", opts.Collectors.String())
-		storeBuilder.WithEnabledResources(opts.Collectors.AsSlice())
+		err = storeBuilder.WithEnabledResources(opts.Collectors.AsSlice())


Can you remove the code duplication in L86 and L89? We could assign a variable to hold either options.DefaultCollectors or ops.Collectors and then call storeBuilder.WithEnabledResources . once.

brancz · 2019-06-18T14:47:58Z

Thanks for the fix!

/lgtm
/approve

tariq1890 · 2019-06-18T14:48:45Z

main.go

+		err = storeBuilder.WithEnabledResources(opts.Collectors.AsSlice())
+	}
+	if err != nil {
+		klog.Fatalf("Error: %s", err)


Something more descriptive here? and you should be using %v instead of %s.

brancz · 2019-06-18T14:49:36Z

/hold

@tariq1890 comment on the error message is valid

tariq1890 · 2019-06-18T14:55:16Z

Thanks @milesbxf. Once the review comments are addressed, please squash the commit history :).

milesbxf · 2019-06-18T14:56:53Z

@tariq1890 @brancz done - thanks for looking at it!

tariq1890 · 2019-06-18T14:57:42Z

go.sum

@@ -10,13 +10,10 @@ github.com/dgrijalva/jwt-go v0.0.0-20160705203006-01aeca54ebda h1:NyywMz59neOoVR
 github.com/dgrijalva/jwt-go v0.0.0-20160705203006-01aeca54ebda/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
 github.com/evanphx/json-patch v4.1.0+incompatible h1:K1MDoo4AZ4wU0GIU/fPmtZg7VpzLjCxu+UwBD1FvwOc=
 github.com/evanphx/json-patch v4.1.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
-github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=


Not relevant to this PR. Looks like the current go modules CI check is not working as expected. That might need fixing. FYI @brancz .

agreed, let's handle separately

Whoops spoke too soon. The CI checks are working as expected :). Can you run go mod tidy and go mod vendor @milesbxf ?

brancz · 2019-06-18T14:59:15Z

/hold cancel
/lgtm
/approve

This fixes an issue where it was impossible to specify a collector that was available but not selected by default. Instead of checking whether chosen collectors are valid at flag parse time, this moves the check into the builder, where we can reference it against the availableStores in the builder. As a bonus, the error message also prints out a list of available collectors: ``` kube-state-metrics --collectors non-existent-collector I0618 15:23:34.517532 50719 main.go:88] Using collectors non-existent-collector F0618 15:23:34.519132 50719 main.go:90] Error: collector non-existent-collector does not exist. Available collectors: persistentvolumeclaims,configmaps,limitranges,nodes,namespaces,persistentvolumes,pods,replicasets,services,cronjobs,deployments,ingresses,horizontalpodautoscalers,jobs,poddisruptionbudgets,secrets,certificatesigningrequests,daemonsets,endpoints,storageclasses,replicationcontrollers,resourcequotas,statefulsets ```

brancz · 2019-06-18T15:38:20Z

/lgtm

k8s-ci-robot · 2019-06-18T15:38:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brancz, milesbxf

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~~ [brancz]

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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 18, 2019

k8s-ci-robot requested review from mxinden and zouyee June 18, 2019 14:28

milesbxf mentioned this pull request Jun 18, 2019

store: add metrics for VerticalPodAutoscaler objects #791

Merged

4 tasks

brancz reviewed Jun 18, 2019

View reviewed changes

tariq1890 reviewed Jun 18, 2019

View reviewed changes

k8s-ci-robot assigned brancz Jun 18, 2019

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 18, 2019

tariq1890 reviewed Jun 18, 2019

View reviewed changes

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jun 18, 2019

milesbxf force-pushed the fix-default-available-collectors branch from e18cf74 to 21c8293 Compare June 18, 2019 14:56

tariq1890 reviewed Jun 18, 2019

View reviewed changes

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 18, 2019

tariq1890 approved these changes Jun 18, 2019

View reviewed changes

milesbxf force-pushed the fix-default-available-collectors branch from 21c8293 to 14fd017 Compare June 18, 2019 15:26

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 18, 2019

milesbxf force-pushed the fix-default-available-collectors branch from 14fd017 to e1b45de Compare June 18, 2019 15:28

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 18, 2019

k8s-ci-robot merged commit 82ab559 into kubernetes:master Jun 18, 2019

milesbxf deleted the fix-default-available-collectors branch June 18, 2019 16:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

builder/main: allow collectors not enabled by default #793

builder/main: allow collectors not enabled by default #793

milesbxf commented Jun 18, 2019 •

edited

Loading

brancz Jun 18, 2019

milesbxf Jun 18, 2019

brancz left a comment

brancz Jun 18, 2019

tariq1890 Jun 18, 2019

brancz commented Jun 18, 2019

tariq1890 Jun 18, 2019

brancz commented Jun 18, 2019

tariq1890 commented Jun 18, 2019

milesbxf commented Jun 18, 2019

tariq1890 Jun 18, 2019

brancz Jun 18, 2019

tariq1890 Jun 18, 2019

brancz commented Jun 18, 2019

brancz commented Jun 18, 2019

k8s-ci-robot commented Jun 18, 2019

		@@ -86,7 +86,9 @@ func main() {
		storeBuilder.WithEnabledResources(options.DefaultCollectors.AsSlice())

builder/main: allow collectors not enabled by default #793

builder/main: allow collectors not enabled by default #793

Conversation

milesbxf commented Jun 18, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brancz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brancz commented Jun 18, 2019

Choose a reason for hiding this comment

brancz commented Jun 18, 2019

tariq1890 commented Jun 18, 2019

milesbxf commented Jun 18, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brancz commented Jun 18, 2019

brancz commented Jun 18, 2019

k8s-ci-robot commented Jun 18, 2019

milesbxf commented Jun 18, 2019 •

edited

Loading