Adapt code for KSM stable metrics

kubernetes · Jan 2, 2024 · 44ee7e2 · 44ee7e2
1 parent 648a0eb
commit 44ee7e2
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 908 deletions.
diff --git a/internal/store/pod.go b/internal/store/pod.go
@@ -882,11 +882,12 @@ func createPodInitContainerStatusReadyFamilyGenerator() generator.FamilyGenerato
 }
 
 func createPodInitContainerStatusRestartsTotalFamilyGenerator() generator.FamilyGenerator {
-	return *generator.NewFamilyGeneratorWithStability(
+	return *generator.NewFamilyGeneratorWithStabilityV2(
 		"kube_pod_init_container_status_restarts_total",
 		"The number of restarts for the init container.",
 		metric.Counter, basemetrics.STABLE,
 		"",
+		[]string{"container"},
 		wrapPodFunc(func(p *v1.Pod) *metric.Family {
 			ms := make([]*metric.Metric, len(p.Status.InitContainerStatuses))
 

diff --git a/pkg/metric_generator/generator.go b/pkg/metric_generator/generator.go
@@ -39,6 +39,24 @@ type FamilyGenerator struct {
 	GenerateFunc      func(obj interface{}) *metric.Family
 }
 
+// NewFamilyGeneratorWithStabilityV2 creates new FamilyGenerator instances with metric
+// stabilityLevel and explicit labels. These explicit labels are used for verifying stable metrics.
+func NewFamilyGeneratorWithStabilityV2(name string, help string, metricType metric.Type, stabilityLevel basemetrics.StabilityLevel, deprecatedVersion string, labels []string, generateFunc func(obj interface{}) *metric.Family) *FamilyGenerator {
+	f := &FamilyGenerator{
+		Name:              name,
+		Type:              metricType,
+		Help:              help,
+		OptIn:             false,
+		StabilityLevel:    stabilityLevel,
+		DeprecatedVersion: deprecatedVersion,
+		GenerateFunc:      WrapLabels(generateFunc, labels),
+	}
+	if deprecatedVersion != "" {
+		f.Help = fmt.Sprintf("(Deprecated since %s) %s", deprecatedVersion, help)
+	}
+	return f
+}
+
 // NewFamilyGeneratorWithStability creates new FamilyGenerator instances with metric
 // stabilityLevel.
 func NewFamilyGeneratorWithStability(name string, help string, metricType metric.Type, stabilityLevel basemetrics.StabilityLevel, deprecatedVersion string, generateFunc func(obj interface{}) *metric.Family) *FamilyGenerator {
@@ -57,6 +75,19 @@ func NewFamilyGeneratorWithStability(name string, help string, metricType metric
 	return f
 }
 
+func WrapLabels(generateFunc func(obj interface{}) *metric.Family, labels []string) func(obj interface{}) *metric.Family {
+	return func(obj interface{}) *metric.Family {
+
+		metricFamily := generateFunc(obj)
+
+		for _, m := range metricFamily.Metrics {
+			m.LabelKeys = append(labels, m.LabelKeys...)
+		}
+
+		return metricFamily
+	}
+}
+
 // NewOptInFamilyGenerator creates new FamilyGenerator instances for opt-in metric families.
 func NewOptInFamilyGenerator(name string, help string, metricType metric.Type, stabilityLevel basemetrics.StabilityLevel, deprecatedVersion string, generateFunc func(obj interface{}) *metric.Family) *FamilyGenerator {
 	f := NewFamilyGeneratorWithStability(name, help, metricType, stabilityLevel,