Reference closure scoped family generator

[jw-s]

Signed-off-by: Joel Whittaker-Smith jdws.dev@gmail.com

What this PR does / why we need it:

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 #1239

[lilic]

Hey, thanks for this! Will test this out. I changed the base to release-2.0 as per our release process. Do you mind rebasing with the release-2.0 branch as well, thanks!

There are some failing unit tests it seems, do you mind fixing those:

--- FAIL: TestFullScrapeCycle (1.01s)
main_test.go:379: expected:

    kube_pod_labels{namespace="default",pod="pod0"} 1, but got:
    
    kube_pod_labels{pod="pod0",namespace="default"} 1

[lilic]

Tested and this does fix the bug, thanks again! Just few things left from my previous comment after that we can merge 🎉

[jw-s]

Hey, thanks for this! Will test this out. I changed the base to release-2.0 as per our release process. Do you mind rebasing with the release-2.0 branch as well, thanks!

There are some failing unit tests it seems, do you mind fixing those:

--- FAIL: TestFullScrapeCycle (1.01s)
main_test.go:379: expected:

    kube_pod_labels{namespace="default",pod="pod0"} 1, but got:
    
    kube_pod_labels{pod="pod0",namespace="default"} 1

Seems like a flaky test. It's passing now...

[lilic]

Do you mind just for now only including only your patch, so the last commit in this PR against release-2.0, we can do the rest of the 2.0 merges from master as not all are relevant for the release-2.0 branch. Hope that makes sense? Thanks!

[jw-s]

@lilic done but the flaky test is failing again, it's weird as the order shouldn't matter since we sort the strings...

[lilic]

Seems like now the tests failed two times in a row, will rerun, if it passes will open an issue to look into it.

[lilic]

/lgtm

Thanks again!

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jw-s, lilic

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 [lilic]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jimmyseto]

@jw-s - thanks for this PR!

@jw-s @lilic - in testing the latest off the release-2.0 branch, i'm able to confirm that we now get tags/labels for most of the metrics. but, i notice that the kube_*_label metrics still don't have them. is this an expected change for v2.0 to reduce/limit cardinality?

[lilic]

@jimmyseto yes, this is expected. https://github.com/kubernetes/kube-state-metrics/releases/tag/v2.0.0-alpha let me know if its not clear from the changelog, this is the PR that introduces a flag to control this #1125 and issue #1047.

Help in testing the new flag is always appreciated!

@brancz to double-check as he helped that effort.

[jimmyseto]

@jimmyseto yes, this is expected. https://github.com/kubernetes/kube-state-metrics/releases/tag/v2.0.0-alpha let me know if its not clear from the changelog, this is the PR that introduces a flag to control this #1125 and issue #1047.

Help in testing the new flag is always appreciated!

@brancz to double-check as he helped that effort.

thanks for the pointer, @lilic. i tried using the flag, but it doesn't seem to be working. or, perhaps, i'm not using it correctly. here's an example:

kubectl describe pod kube-state-metrics-756fb7d894-x6f22
...
Labels: app.kubernetes.io/name=kube-state-metrics
app.kubernetes.io/version=2.0.0-alpha
pod-template-hash=3129638450
testlabel=foobar
...
Containers:
kube-state-metrics:
...
Args:
--resources=pods
--labels-allow-list=kube_pod_labels=[testlabel]
...

curl -s -X GET http://kube-state-metrics.kube-system.svc.cluster.local:8080/metrics |grep pod_labels
...
kube_pod_labels 1
...

also, with the new flag, is it possible to use wildcards to get all labels for a given metric?

[jw-s]

@jimmyseto labels are prefixed with label_ for labels and annotation_ for annotations. I can confirm it's working with --labels-allow-list=kube_pod_labels=[namespace, label_app] for example.
Wildcards are not currently supported for labels. By default all non _labels/_annotations metrics include all their labels.

[jimmyseto]

@jimmyseto labels are prefixed with label_ for labels and annotation_ for annotations. I can confirm it's working with --labels-allow-list=kube_pod_labels=[namespace, label_app] for example.
Wildcards are not currently supported for labels. By default all non _labels/_annotations metrics include all their labels.

thanks @jw-s . that did the trick. forgot about the prefix.

i do think it would be helpful to support wildcards. i can see scenarios in which users may just want to scrape all labels for a particular k8s resource, not knowing exactly what they are looking for. are there plans to add support for this?

[lilic]

i do think it would be helpful to support wildcards. i can see scenarios in which users may just want to scrape all labels for a particular k8s resource, not knowing exactly what they are looking for. are there plans to add support for this?

@jimmyseto sounds good, feel free to open an issue for it so we can discuss there! 🎉 Thanks!

[jimmyseto]

i do think it would be helpful to support wildcards. i can see scenarios in which users may just want to scrape all labels for a particular k8s resource, not knowing exactly what they are looking for. are there plans to add support for this?

@jimmyseto sounds good, feel free to open an issue for it so we can discuss there! 🎉 Thanks!

will do! thanks!

[jimmyseto]

i do think it would be helpful to support wildcards. i can see scenarios in which users may just want to scrape all labels for a particular k8s resource, not knowing exactly what they are looking for. are there plans to add support for this?

@jimmyseto sounds good, feel free to open an issue for it so we can discuss there! 🎉 Thanks!

will do! thanks!

created #1246