fix(customresourcestate): log when configured CRD is not installed in cluster by maksimp13 · Pull Request #2903 · kubernetes/kube-state-metrics

maksimp13 · 2026-03-19T20:16:24Z

What happened

When a resource is listed in the custom resource state config but its CRD is not installed in the cluster, ResolveGVKToGVKPs returns an empty list with no error. Previously this was silently skipped with no indication to the user.

What this PR does

Adds an InfoS log when a configured CRD is not found in the cluster, so users understand why metrics are not being collected for that resource.

How to test

Create a CRS config referencing a CRD that is not installed in the cluster
Run KSM with --custom-resource-state-config-file pointing to that config
Observe the log: CRD for resource is not installed in the cluster, skipping

Ref #2354

… cluster

k8s-ci-robot · 2026-03-19T20:16:33Z

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Details

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-sigs/prow repository.

k8s-ci-robot · 2026-03-19T20:16:34Z

Welcome @maksimp13!

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. 😃

nmn3m · 2026-03-20T02:31:24Z

 			resolvedSet /* GVKPs */, err := discovererInstance.ResolveGVKToGVKPs(schema.GroupVersionKind(resource.GroupVersionKind))
 			if err != nil {
 				klog.ErrorS(err, "failed to resolve GVK", "gvk", resource.GroupVersionKind)
+			} else if len(resolvedSet) == 0 {


The change looks good to me — adding visibility for silently skipped CRDs is a nice improvement.

One note: this PR adds a log line, but issue #2354 reports that /metrics goes down entirely when non-existent CRDs are listed. A log doesn't fix that behavior, so Fixes #2354 might be inaccurate.
Consider changing it to Ref #2354 unless the endpoint issue has already been resolved separately.

/cc @rexagod

Hmm.. I wasn't able to reproduce the /metrics crash locally - it seems it was already fixed in a previous versions. The endpoint returns 200 OK even when a configured CRD is not installed in the cluster.

Updated Fixes #2354 → Ref #2354.

nmn3m · 2026-03-20T19:15:55Z

/lgtm
/assign @mrueg

k8s-ci-robot · 2026-03-20T19:16:03Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: maksimp13, nmn3m
Once this PR has been reviewed and has the lgtm label, please assign rexagod for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

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

mrueg · 2026-03-20T21:09:41Z

 			if err != nil {
 				klog.ErrorS(err, "failed to resolve GVK", "gvk", resource.GroupVersionKind)
+			} else if len(resolvedSet) == 0 {
+				klog.InfoS("CRD for resource is not installed in the cluster, skipping", "gvk", resource.GroupVersionKind)


How often does this log? Only at the start up of ksm or regularly?

The log fires once per CRD informer event (add/update/delete), not on every poll tick. generateMetrics() only runs when WasUpdated == true - set by the informer on any CRD change, reset after each run. So it runs once at startup, then only if the cluster CRD state changes.

Copilot

Pull request overview

This PR improves observability for Custom Resource State (CRS) config processing by logging when a configured resource can’t be resolved via CRD discovery, helping users understand why metrics aren’t being produced for that resource.

Changes:

Add an InfoS log when ResolveGVKToGVKPs returns an empty resolution set for a configured GVK.
Preserve existing error logging behavior when GVK resolution fails.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-09T12:26:14Z

 			if err != nil {
 				klog.ErrorS(err, "failed to resolve GVK", "gvk", resource.GroupVersionKind)
+			} else if len(resolvedSet) == 0 {
+				klog.InfoS("CRD for resource is not installed in the cluster, skipping", "gvk", resource.GroupVersionKind)


len(resolvedSet) == 0 can also happen when the configured G/V/K doesn’t match what’s in discovery (e.g., wrong version or kind), not only when the CRD is missing. Consider rewording this log to “no matching CRD found for configured GVK, skipping” (or similar) so it stays accurate.

Suggested change

klog.InfoS("CRD for resource is not installed in the cluster, skipping", "gvk", resource.GroupVersionKind)

klog.InfoS("no matching CRD found for configured GVK, skipping", "gvk", resource.GroupVersionKind)

@maksimp13 can you address this comment?

fix(customresourcestate): log when configured CRD is not installed in…

758d48e

… cluster

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 19, 2026

github-project-automation Bot added this to SIG Instrumentation Mar 19, 2026

k8s-ci-robot requested review from mrueg and nmn3m March 19, 2026 20:16

github-project-automation Bot moved this to Needs Triage in SIG Instrumentation Mar 19, 2026

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 19, 2026

nmn3m reviewed Mar 20, 2026

View reviewed changes

k8s-ci-robot requested a review from rexagod March 20, 2026 02:31

k8s-ci-robot assigned nmn3m Mar 20, 2026

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 20, 2026

mrueg reviewed Mar 20, 2026

View reviewed changes

mrueg requested a review from Copilot April 9, 2026 12:23

Copilot started reviewing on behalf of mrueg April 9, 2026 12:24 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(customresourcestate): log when configured CRD is not installed in cluster#2903

fix(customresourcestate): log when configured CRD is not installed in cluster#2903
maksimp13 wants to merge 1 commit into
kubernetes:mainfrom
maksimp13:fix/log-missing-crd-issue-2354

maksimp13 commented Mar 19, 2026 •

edited

Loading

Uh oh!

k8s-ci-robot commented Mar 19, 2026

Uh oh!

k8s-ci-robot commented Mar 19, 2026

Uh oh!

nmn3m Mar 20, 2026

Uh oh!

maksimp13 Mar 20, 2026 •

edited

Loading

Uh oh!

nmn3m commented Mar 20, 2026

Uh oh!

k8s-ci-robot commented Mar 20, 2026

Uh oh!

mrueg Mar 20, 2026

Uh oh!

maksimp13 Mar 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 9, 2026

Uh oh!

mrueg Apr 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	klog.InfoS("CRD for resource is not installed in the cluster, skipping", "gvk", resource.GroupVersionKind)
	klog.InfoS("no matching CRD found for configured GVK, skipping", "gvk", resource.GroupVersionKind)

Conversation

maksimp13 commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What happened

What this PR does

How to test

Uh oh!

k8s-ci-robot commented Mar 19, 2026

Uh oh!

k8s-ci-robot commented Mar 19, 2026

Uh oh!

nmn3m Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

maksimp13 Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nmn3m commented Mar 20, 2026

Uh oh!

k8s-ci-robot commented Mar 20, 2026

Uh oh!

mrueg Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

maksimp13 Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

mrueg Apr 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

maksimp13 commented Mar 19, 2026 •

edited

Loading

maksimp13 Mar 20, 2026 •

edited

Loading