Allow optional VK in CR metrics #1851

rexagod · 2022-10-07T19:23:36Z

What this PR does / why we need it: Allow optional VK in CR metrics, while only requiring the group to be fixed. This would allow users to define custom metrics for:

a specific API version: version is fixed, kind varies.
all the API versions of a resource: version varies, kind is fixed.
all the APIs part of an API group: version varies, kind varies.

How does this change affect the cardinality of KSM: Increases, or stays the same, depending on the cardinality of the version(s) and/or kind(s), present under a group.

Which issue(s) this PR fixes: Fixes #1848

pkg/customresourcestate/config.go

logicalhan · 2022-11-08T19:30:55Z

There seems to be angry bots yelling about things in the integration tests.

rexagod · 2022-11-08T20:10:48Z

@logicalhan Yes, checks were passing with the older implementation (till the first fixup commit), but due to the half-baked rewrite they are failing now (support for multi-valued VKs is not yet fully implemented here). I wanted to reach a consensus first on the approach we should be going with (in the thread above), as I wasn't fully sure, before going futher with the code changes.

rexagod · 2022-11-17T17:29:42Z

After proposing the following plan to @mrueg in order to have a much more performant implementation in place, I'm reworking this PR to adhere to the following:

We watch CRDs.
Whenever a CRD is created, edited, or removed, we update the CRD store, always knowing which CRDs are present on the cluster.
CRs will always be created based on those CRDs, which in turn have the GVK for those resources.
So ultimately, we always know the exhaustive list of GVKs for CRs, at any point of time in the cluster.
We pass that information to the existing mechanism (as mentioned in the comment above) and from there onwards, things would be the same as they were.

However, currently, we have the CRD types to implement this feature, but if I'm not mistaken client-go's clientset seems to lack apiextension support.

~~I suppose we can go ahead with releasing v2.7.0, because this could take some time, as some of the implementation details are uncertain at the moment.~~

False alarm, I missed this, resuming work on this.

internal/store/builder.go

logicalhan · 2023-05-19T16:03:57Z

(for other reviewers)

logicalhan · 2023-05-19T19:52:50Z

/lgtm
/hold cancel

k8s-ci-robot · 2023-05-19T19:53:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: logicalhan, rexagod

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

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

rexagod · 2023-05-19T19:53:39Z

FYI @\reviewers, just pushed #1851 (comment) and #1851 (comment) in the latest commit, nothing else.

Add support for variable VKs in CRS config, while maintaining a cache of discovered GVKs in the cluster, and updating it every 30s. Signed-off-by: Pranshu Srivastava <rexagod@gmail.com>

k8s-ci-robot · 2023-05-19T19:56:13Z

New changes are detected. LGTM label has been removed.

mrueg · 2023-05-21T18:08:25Z

🥳 thanks for your work on this @rexagod

rexagod · 2023-05-22T08:01:28Z

Thank you for the all the top-notch reviews that helped shape this PR, @mrueg @logicalhan @dgrisonnet! 🥳

PR#1851 introduced accidental breakage for custom metrics on resources with an empty empty, e.g. Node. Fix it, and add tests to catch the next breakage. Reference: kubernetes#1851 Signed-off-by: Robin H. Johnson <rjohnson@coreweave.com> Fixes: kubernetes#2434

PR#1851 introduced accidental breakage for custom metrics on resources with an empty empty, e.g. Node. Fix it, and add tests to catch the next breakage. Reference: kubernetes#1851 Reference: kubernetes#2434 Signed-off-by: Robin H. Johnson <rjohnson@coreweave.com>

PR#1851 introduced accidental breakage for custom metrics on resources with an empty empty, e.g. Node. Fix it, and add tests to catch the next breakage. ``` demo_timestamp{customresource_group="",customresource_kind="Node",customresource_version="v1",node="kind-control-plane"} 1.719618433e+09 ``` Reference: kubernetes#1851 Reference: kubernetes#2434 Signed-off-by: Robin H. Johnson <rjohnson@coreweave.com>

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 7, 2022

k8s-ci-robot requested review from dgrisonnet and fpetkovski October 7, 2022 19:23

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 7, 2022

rexagod changed the title ~~Represent GVK information as labels~~ Allow optional VK in CR metrics Oct 7, 2022

rexagod force-pushed the 1848 branch 2 times, most recently from 91acc37 to 09bec65 Compare October 7, 2022 21:25

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 7, 2022

rexagod force-pushed the 1848 branch 2 times, most recently from 8a8d82c to 7bc684a Compare October 10, 2022 06:23

logicalhan reviewed Oct 11, 2022

View reviewed changes

pkg/customresourcestate/config.go Outdated Show resolved Hide resolved

rexagod force-pushed the 1848 branch 2 times, most recently from b5d4b01 to f973b82 Compare November 4, 2022 23:55

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 4, 2022

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 17, 2022

dashpole assigned logicalhan and dgrisonnet Nov 17, 2022

dashpole added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 17, 2022

rexagod force-pushed the 1848 branch from f973b82 to ad64bc0 Compare November 17, 2022 18:12

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 17, 2022

rexagod force-pushed the 1848 branch 3 times, most recently from c9bea21 to 6e2e65f Compare November 17, 2022 18:26

mrueg reviewed Nov 17, 2022

View reviewed changes

internal/store/builder.go Outdated Show resolved Hide resolved

rexagod force-pushed the 1848 branch from d6cefa8 to 650216e Compare May 19, 2023 19:52

rexagod requested a review from mrueg May 19, 2023 19:52

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 19, 2023

rexagod requested a review from logicalhan May 19, 2023 19:52

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 May 19, 2023

Add support for variable VKs in CRS config

25a1d8d

Add support for variable VKs in CRS config, while maintaining a cache of discovered GVKs in the cluster, and updating it every 30s. Signed-off-by: Pranshu Srivastava <rexagod@gmail.com>

rexagod force-pushed the 1848 branch from 650216e to 25a1d8d Compare May 19, 2023 19:56

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 19, 2023

k8s-ci-robot merged commit 5010c4a into kubernetes:main May 19, 2023
6 checks passed

rexagod mentioned this pull request May 23, 2023

*: Cut v2.9.0 release #2077

Merged

chrischdi mentioned this pull request Aug 10, 2023

CustomResource: no metrics if no resource exists for CRD when ksm starts #2142

Closed

AliDatadog mentioned this pull request Sep 19, 2023

[Bug] Inconsistency between customresource interface and customresource causes panic #2202

Open

CatherineF-dev mentioned this pull request Dec 13, 2023

fix: fix the issue that duplicated CR metrics are generated when CRD is deleted/applied multiple times #2257

Open

keisku mentioned this pull request May 1, 2024

Add reason tag to kubernetes_state.job.failed DataDog/datadog-agent#25103

Merged

keisku mentioned this pull request Jun 15, 2024

Bump k8s.io/kube-state-metrics/v2 DataDog/datadog-agent#26756

Draft

robbat2 mentioned this pull request Jun 28, 2024

custom metrics for resources w/ group="" broken, e.g. Node #2434

Open

robbat2 mentioned this pull request Jun 28, 2024

fix: support empty groups again, e.g. Node #2435

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow optional VK in CR metrics #1851

Allow optional VK in CR metrics #1851

rexagod commented Oct 7, 2022 •

edited

Loading

logicalhan commented Nov 8, 2022

rexagod commented Nov 8, 2022 •

edited

Loading

rexagod commented Nov 17, 2022 •

edited

Loading

logicalhan commented May 19, 2023

logicalhan commented May 19, 2023

k8s-ci-robot commented May 19, 2023

rexagod commented May 19, 2023 •

edited

Loading

k8s-ci-robot commented May 19, 2023

mrueg commented May 21, 2023

rexagod commented May 22, 2023

Allow optional VK in CR metrics #1851

Allow optional VK in CR metrics #1851

Conversation

rexagod commented Oct 7, 2022 • edited Loading

logicalhan commented Nov 8, 2022

rexagod commented Nov 8, 2022 • edited Loading

rexagod commented Nov 17, 2022 • edited Loading

logicalhan commented May 19, 2023

logicalhan commented May 19, 2023

k8s-ci-robot commented May 19, 2023

rexagod commented May 19, 2023 • edited Loading

k8s-ci-robot commented May 19, 2023

mrueg commented May 21, 2023

rexagod commented May 22, 2023

rexagod commented Oct 7, 2022 •

edited

Loading

rexagod commented Nov 8, 2022 •

edited

Loading

rexagod commented Nov 17, 2022 •

edited

Loading

rexagod commented May 19, 2023 •

edited

Loading