fixup! Adhere to OTel-Prometheus standard for labels

kubernetes · Apr 14, 2023 · d2bb619 · d2bb619
1 parent 82ddca0
commit d2bb619
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 40 deletions.
diff --git a/internal/store/node.go b/internal/store/node.go
@@ -290,7 +290,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
 				case v1.ResourceCPU:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitCore),
 						},
 						Value: float64(val.MilliValue()) / 1000,
@@ -302,15 +302,15 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
 				case v1.ResourceMemory:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitByte),
 						},
 						Value: float64(val.MilliValue()) / 1000,
 					})
 				case v1.ResourcePods:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitInteger),
 						},
 						Value: float64(val.MilliValue()) / 1000,
@@ -319,7 +319,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
 					if isHugePageResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitByte),
 							},
 							Value: float64(val.MilliValue()) / 1000,
@@ -328,7 +328,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
 					if isAttachableVolumeResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitByte),
 							},
 							Value: float64(val.MilliValue()) / 1000,
@@ -337,7 +337,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
 					if isExtendedResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitInteger),
 							},
 							Value: float64(val.MilliValue()) / 1000,
@@ -373,7 +373,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
 				case v1.ResourceCPU:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitCore),
 						},
 						Value: float64(val.MilliValue()) / 1000,
@@ -385,15 +385,15 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
 				case v1.ResourceMemory:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitByte),
 						},
 						Value: float64(val.MilliValue()) / 1000,
 					})
 				case v1.ResourcePods:
 					ms = append(ms, &metric.Metric{
 						LabelValues: []string{
-							sanitizeLabelName(string(resourceName)),
+							SanitizeLabelName(string(resourceName)),
 							string(constant.UnitInteger),
 						},
 						Value: float64(val.MilliValue()) / 1000,
@@ -402,7 +402,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
 					if isHugePageResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitByte),
 							},
 							Value: float64(val.MilliValue()) / 1000,
@@ -411,7 +411,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
 					if isAttachableVolumeResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitByte),
 							},
 							Value: float64(val.MilliValue()) / 1000,
@@ -420,7 +420,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
 					if isExtendedResourceName(resourceName) {
 						ms = append(ms, &metric.Metric{
 							LabelValues: []string{
-								sanitizeLabelName(string(resourceName)),
+								SanitizeLabelName(string(resourceName)),
 								string(constant.UnitInteger),
 							},
 							Value: float64(val.MilliValue()) / 1000,

diff --git a/internal/store/pod.go b/internal/store/pod.go
@@ -177,7 +177,7 @@ func createPodContainerResourceLimitsFamilyGenerator() generator.FamilyGenerator
 					switch resourceName {
 					case v1.ResourceCPU:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
 							Value:       float64(val.MilliValue()) / 1000,
 						})
 					case v1.ResourceStorage:
@@ -186,26 +186,26 @@ func createPodContainerResourceLimitsFamilyGenerator() generator.FamilyGenerator
 						fallthrough
 					case v1.ResourceMemory:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							Value:       float64(val.Value()),
 						})
 					default:
 						if isHugePageResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isAttachableVolumeResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
 								Value:       float64(val.Value()),
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							})
 						}
 						if isExtendedResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
 								Value:       float64(val.Value()),
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
 							})
 
 						}
@@ -241,7 +241,7 @@ func createPodContainerResourceRequestsFamilyGenerator() generator.FamilyGenerat
 					switch resourceName {
 					case v1.ResourceCPU:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
 							Value:       float64(val.MilliValue()) / 1000,
 						})
 					case v1.ResourceStorage:
@@ -250,25 +250,25 @@ func createPodContainerResourceRequestsFamilyGenerator() generator.FamilyGenerat
 						fallthrough
 					case v1.ResourceMemory:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							Value:       float64(val.Value()),
 						})
 					default:
 						if isHugePageResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isAttachableVolumeResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isExtendedResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
 								Value:       float64(val.Value()),
 							})
 						}
@@ -713,7 +713,7 @@ func createPodInitContainerResourceLimitsFamilyGenerator() generator.FamilyGener
 					switch resourceName {
 					case v1.ResourceCPU:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
 							Value:       float64(val.MilliValue()) / 1000,
 						})
 					case v1.ResourceStorage:
@@ -722,26 +722,26 @@ func createPodInitContainerResourceLimitsFamilyGenerator() generator.FamilyGener
 						fallthrough
 					case v1.ResourceMemory:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							Value:       float64(val.Value()),
 						})
 					default:
 						if isHugePageResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isAttachableVolumeResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
 								Value:       float64(val.Value()),
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							})
 						}
 						if isExtendedResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
 								Value:       float64(val.Value()),
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
 							})
 
 						}
@@ -777,7 +777,7 @@ func createPodInitContainerResourceRequestsFamilyGenerator() generator.FamilyGen
 					switch resourceName {
 					case v1.ResourceCPU:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
 							Value:       float64(val.MilliValue()) / 1000,
 						})
 					case v1.ResourceStorage:
@@ -786,25 +786,25 @@ func createPodInitContainerResourceRequestsFamilyGenerator() generator.FamilyGen
 						fallthrough
 					case v1.ResourceMemory:
 						ms = append(ms, &metric.Metric{
-							LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+							LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 							Value:       float64(val.Value()),
 						})
 					default:
 						if isHugePageResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isAttachableVolumeResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
 								Value:       float64(val.Value()),
 							})
 						}
 						if isExtendedResourceName(resourceName) {
 							ms = append(ms, &metric.Metric{
-								LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
+								LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
 								Value:       float64(val.Value()),
 							})
 						}

diff --git a/internal/store/utils.go b/internal/store/utils.go
@@ -123,10 +123,10 @@ func mapToPrometheusLabels(labels map[string]string, prefix string) ([]string, [
 }
 
 func labelName(prefix, labelName string) string {
-	return prefix + "_" + lintLabelName(sanitizeLabelName(labelName))
+	return prefix + "_" + lintLabelName(SanitizeLabelName(labelName))
 }
 
-func sanitizeLabelName(s string) string {
+func SanitizeLabelName(s string) string {
 	return invalidLabelCharRE.ReplaceAllString(s, "_")
 }
 

diff --git a/pkg/customresourcestate/registry_factory.go b/pkg/customresourcestate/registry_factory.go
@@ -30,10 +30,9 @@ import (
 	"k8s.io/apimachinery/pkg/util/validation"
 	"k8s.io/klog/v2"
 
+	"k8s.io/kube-state-metrics/v2/internal/store"
 	"k8s.io/kube-state-metrics/v2/pkg/metric"
 	generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
-
-	otelprom "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus"
 )
 
 func compile(resource Resource) ([]compiledFamily, error) {
@@ -509,8 +508,7 @@ func addPathLabels(obj interface{}, labels map[string]valuePath, result map[stri
 		m := labels[k].Get(obj)
 		if kv, ok := m.(map[string]interface{}); ok {
 			for k, v := range kv {
-				otelCompatPromLabelName := otelprom.NormalizeLabel(k)
-				result[otelCompatPromLabelName] = fmt.Sprintf("%v", v)
+				result[store.SanitizeLabelName(k)] = fmt.Sprintf("%v", v)
 			}
 		}
 	}
@@ -523,8 +521,7 @@ func addPathLabels(obj interface{}, labels map[string]valuePath, result map[stri
 		if value == nil {
 			continue
 		}
-		otelCompatPromLabelName := otelprom.NormalizeLabel(k)
-		result[otelCompatPromLabelName] = fmt.Sprintf("%v", value)
+		result[store.SanitizeLabelName(k)] = fmt.Sprintf("%v", value)
 	}
 }