Bump k8s.io/kube-state-metrics/v2

[keisku]

What does this PR do?

Address two breaking changes in k8s.io/kube-state-metrics/v2 to update from v2.8.2 to v2.12.0

kubernetes/kube-state-metrics#1851

pkg/customresource/registry_factory.go

type RegistryFactory interface {
	// ...
-	MetricFamilyGenerators(allowAnnotationsList, allowLabelsList []string) []generator.FamilyGenerator
+	MetricFamilyGenerators() []generator.FamilyGenerator
	// ...
}

kubernetes/kube-state-metrics#2017

pkg/builder/types/interfaces.go

type BuilderInterface interface {
	// ...
-	WithVPAClient(c vpaclientset.Interface)
	// ...
}

Motivation

• Bump k8s.io/kube-state-metrics/v2.
• https://github.com/DataDog/datadog-agent/pull/25103/files#r1586257750

Additional Notes

Currently, we don't filter by MetricFamilyGenerators(allowAnnotationsList, allowLabelsList) since any annotations/labels can be used for label joins, which is hardcode.

• datadog-agent/pkg/collector/corechecks/cluster/ksm/kubernetes_state.go

  Lines 266 to 274 in 95cd819

  	// Enable exposing resource annotations explicitly for kube_<resource>_annotations metadata metrics.
  	// Equivalent to configuring --metric-annotations-allowlist.
  	allowedAnnotations := map[string][]string{}
  	for _, collector := range collectors {
  	// Any annotation can be used for label joins.
  	allowedAnnotations[collector] = []string{"*"}
  	}
  	builder.WithAllowAnnotations(allowedAnnotations)

• datadog-agent/pkg/collector/corechecks/cluster/ksm/kubernetes_state.go

  Lines 320 to 330 in 95cd819

  	// Enable exposing resource labels explicitly for kube_<resource>_labels metadata metrics.
  	// Equivalent to configuring --metric-labels-allowlist.
  	allowedLabels := map[string][]string{}
  	for _, collector := range collectors {
  	// Any label can be used for label joins.
  	allowedLabels[collector] = []string{"*"}
  	}
  	if err = builder.WithAllowLabels(allowedLabels); err != nil {
  	return err
  	}

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

[cit-pr-commenter]

Go Package Import Differences

Baseline: 3628de0
Comparison: a3bea1c

binary	os	arch	change
agent	linux	amd64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
agent	linux	arm64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
agent	windows	amd64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
agent	darwin	amd64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
agent	darwin	arm64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
cluster-agent	linux	amd64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1
cluster-agent	linux	arm64	+3, -0 +k8s.io/kube-state-metrics/v2/pkg/util +k8s.io/sample-controller/pkg/apis/samplecontroller +k8s.io/sample-controller/pkg/apis/samplecontroller/v1alpha1

[pr-commenter]

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=38219158 --os-family=ubuntu

Note: This applies to commit a3bea1c

[pr-commenter]

Regression Detector

Regression Detector Results

Run ID: ca9bd4ab-274d-47aa-8391-8c5ca0b7c366 Metrics dashboard Target profiles

Baseline: 44d4770
Comparison: c66a3a0

Performance changes are noted in the perf column of each table:

• ✅ = significantly better comparison variant performance
• ❌ = significantly worse comparison variant performance
• ➖ = no significant change in performance

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	links
➖	file_tree	memory utilization	+2.26	[+2.14, +2.38]	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.00, +0.00]	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.01, +0.01]	Logs
➖	idle	memory utilization	-0.35	[-0.40, -0.30]	Logs
➖	otel_to_otel_logs	ingress throughput	-0.55	[-1.36, +0.26]	Logs
➖	pycheck_1000_100byte_tags	% cpu utilization	-0.65	[-5.45, +4.15]	Logs
➖	basic_py_check	% cpu utilization	-0.80	[-3.68, +2.09]	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-1.03	[-1.91, -0.15]	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	-2.35	[-14.94, +10.25]	Logs

Explanation

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

3. Its configuration does not mark it "erratic".

[AliDatadog]

This PR requires an upstream contribution as a bug was introduced in 2.9.x.

[keisku]

@AliDatadog can you share related issue URLs of the bug?

[AliDatadog]

@AliDatadog can you share related issue URLs of the bug?

This is the issue I mentioned kubernetes/kube-state-metrics#2202

It should be fixed by kubernetes/kube-state-metrics@main...AliDatadog:kube-state-metrics:ali/fix-interface but I didn't propose the change yet

[keisku]

Thanks for sharing. I will keep an eye on the issue and hope your changes get merged soon!

[keisku]

@AliDatadog

It should be fixed by kubernetes/kube-state-metrics@main...AliDatadog:kube-state-metrics:ali/fix-interface but I didn't propose the change yet

What is blocking you from proposing the change?

[L3n41c]

Superseded by #30061.