Skip to content

Commit 74a1a0f

Browse files
committed
fixup! Adhere to OTel-Prometheus standard for labels
1 parent 1398a90 commit 74a1a0f

File tree

5 files changed

+39
-42
lines changed

5 files changed

+39
-42
lines changed

internal/store/node.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
290290
case v1.ResourceCPU:
291291
ms = append(ms, &metric.Metric{
292292
LabelValues: []string{
293-
sanitizeLabelName(string(resourceName)),
293+
SanitizeLabelName(string(resourceName)),
294294
string(constant.UnitCore),
295295
},
296296
Value: float64(val.MilliValue()) / 1000,
@@ -302,15 +302,15 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
302302
case v1.ResourceMemory:
303303
ms = append(ms, &metric.Metric{
304304
LabelValues: []string{
305-
sanitizeLabelName(string(resourceName)),
305+
SanitizeLabelName(string(resourceName)),
306306
string(constant.UnitByte),
307307
},
308308
Value: float64(val.MilliValue()) / 1000,
309309
})
310310
case v1.ResourcePods:
311311
ms = append(ms, &metric.Metric{
312312
LabelValues: []string{
313-
sanitizeLabelName(string(resourceName)),
313+
SanitizeLabelName(string(resourceName)),
314314
string(constant.UnitInteger),
315315
},
316316
Value: float64(val.MilliValue()) / 1000,
@@ -319,7 +319,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
319319
if isHugePageResourceName(resourceName) {
320320
ms = append(ms, &metric.Metric{
321321
LabelValues: []string{
322-
sanitizeLabelName(string(resourceName)),
322+
SanitizeLabelName(string(resourceName)),
323323
string(constant.UnitByte),
324324
},
325325
Value: float64(val.MilliValue()) / 1000,
@@ -328,7 +328,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
328328
if isAttachableVolumeResourceName(resourceName) {
329329
ms = append(ms, &metric.Metric{
330330
LabelValues: []string{
331-
sanitizeLabelName(string(resourceName)),
331+
SanitizeLabelName(string(resourceName)),
332332
string(constant.UnitByte),
333333
},
334334
Value: float64(val.MilliValue()) / 1000,
@@ -337,7 +337,7 @@ func createNodeStatusAllocatableFamilyGenerator() generator.FamilyGenerator {
337337
if isExtendedResourceName(resourceName) {
338338
ms = append(ms, &metric.Metric{
339339
LabelValues: []string{
340-
sanitizeLabelName(string(resourceName)),
340+
SanitizeLabelName(string(resourceName)),
341341
string(constant.UnitInteger),
342342
},
343343
Value: float64(val.MilliValue()) / 1000,
@@ -373,7 +373,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
373373
case v1.ResourceCPU:
374374
ms = append(ms, &metric.Metric{
375375
LabelValues: []string{
376-
sanitizeLabelName(string(resourceName)),
376+
SanitizeLabelName(string(resourceName)),
377377
string(constant.UnitCore),
378378
},
379379
Value: float64(val.MilliValue()) / 1000,
@@ -385,15 +385,15 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
385385
case v1.ResourceMemory:
386386
ms = append(ms, &metric.Metric{
387387
LabelValues: []string{
388-
sanitizeLabelName(string(resourceName)),
388+
SanitizeLabelName(string(resourceName)),
389389
string(constant.UnitByte),
390390
},
391391
Value: float64(val.MilliValue()) / 1000,
392392
})
393393
case v1.ResourcePods:
394394
ms = append(ms, &metric.Metric{
395395
LabelValues: []string{
396-
sanitizeLabelName(string(resourceName)),
396+
SanitizeLabelName(string(resourceName)),
397397
string(constant.UnitInteger),
398398
},
399399
Value: float64(val.MilliValue()) / 1000,
@@ -402,7 +402,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
402402
if isHugePageResourceName(resourceName) {
403403
ms = append(ms, &metric.Metric{
404404
LabelValues: []string{
405-
sanitizeLabelName(string(resourceName)),
405+
SanitizeLabelName(string(resourceName)),
406406
string(constant.UnitByte),
407407
},
408408
Value: float64(val.MilliValue()) / 1000,
@@ -411,7 +411,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
411411
if isAttachableVolumeResourceName(resourceName) {
412412
ms = append(ms, &metric.Metric{
413413
LabelValues: []string{
414-
sanitizeLabelName(string(resourceName)),
414+
SanitizeLabelName(string(resourceName)),
415415
string(constant.UnitByte),
416416
},
417417
Value: float64(val.MilliValue()) / 1000,
@@ -420,7 +420,7 @@ func createNodeStatusCapacityFamilyGenerator() generator.FamilyGenerator {
420420
if isExtendedResourceName(resourceName) {
421421
ms = append(ms, &metric.Metric{
422422
LabelValues: []string{
423-
sanitizeLabelName(string(resourceName)),
423+
SanitizeLabelName(string(resourceName)),
424424
string(constant.UnitInteger),
425425
},
426426
Value: float64(val.MilliValue()) / 1000,

internal/store/pod.go

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ func createPodContainerResourceLimitsFamilyGenerator() generator.FamilyGenerator
177177
switch resourceName {
178178
case v1.ResourceCPU:
179179
ms = append(ms, &metric.Metric{
180-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
180+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
181181
Value: float64(val.MilliValue()) / 1000,
182182
})
183183
case v1.ResourceStorage:
@@ -186,26 +186,26 @@ func createPodContainerResourceLimitsFamilyGenerator() generator.FamilyGenerator
186186
fallthrough
187187
case v1.ResourceMemory:
188188
ms = append(ms, &metric.Metric{
189-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
189+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
190190
Value: float64(val.Value()),
191191
})
192192
default:
193193
if isHugePageResourceName(resourceName) {
194194
ms = append(ms, &metric.Metric{
195-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
195+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
196196
Value: float64(val.Value()),
197197
})
198198
}
199199
if isAttachableVolumeResourceName(resourceName) {
200200
ms = append(ms, &metric.Metric{
201201
Value: float64(val.Value()),
202-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
202+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
203203
})
204204
}
205205
if isExtendedResourceName(resourceName) {
206206
ms = append(ms, &metric.Metric{
207207
Value: float64(val.Value()),
208-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
208+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
209209
})
210210

211211
}
@@ -241,7 +241,7 @@ func createPodContainerResourceRequestsFamilyGenerator() generator.FamilyGenerat
241241
switch resourceName {
242242
case v1.ResourceCPU:
243243
ms = append(ms, &metric.Metric{
244-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
244+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
245245
Value: float64(val.MilliValue()) / 1000,
246246
})
247247
case v1.ResourceStorage:
@@ -250,25 +250,25 @@ func createPodContainerResourceRequestsFamilyGenerator() generator.FamilyGenerat
250250
fallthrough
251251
case v1.ResourceMemory:
252252
ms = append(ms, &metric.Metric{
253-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
253+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
254254
Value: float64(val.Value()),
255255
})
256256
default:
257257
if isHugePageResourceName(resourceName) {
258258
ms = append(ms, &metric.Metric{
259-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
259+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
260260
Value: float64(val.Value()),
261261
})
262262
}
263263
if isAttachableVolumeResourceName(resourceName) {
264264
ms = append(ms, &metric.Metric{
265-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
265+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
266266
Value: float64(val.Value()),
267267
})
268268
}
269269
if isExtendedResourceName(resourceName) {
270270
ms = append(ms, &metric.Metric{
271-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
271+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
272272
Value: float64(val.Value()),
273273
})
274274
}
@@ -713,7 +713,7 @@ func createPodInitContainerResourceLimitsFamilyGenerator() generator.FamilyGener
713713
switch resourceName {
714714
case v1.ResourceCPU:
715715
ms = append(ms, &metric.Metric{
716-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
716+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
717717
Value: float64(val.MilliValue()) / 1000,
718718
})
719719
case v1.ResourceStorage:
@@ -722,26 +722,26 @@ func createPodInitContainerResourceLimitsFamilyGenerator() generator.FamilyGener
722722
fallthrough
723723
case v1.ResourceMemory:
724724
ms = append(ms, &metric.Metric{
725-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
725+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
726726
Value: float64(val.Value()),
727727
})
728728
default:
729729
if isHugePageResourceName(resourceName) {
730730
ms = append(ms, &metric.Metric{
731-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
731+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
732732
Value: float64(val.Value()),
733733
})
734734
}
735735
if isAttachableVolumeResourceName(resourceName) {
736736
ms = append(ms, &metric.Metric{
737737
Value: float64(val.Value()),
738-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
738+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
739739
})
740740
}
741741
if isExtendedResourceName(resourceName) {
742742
ms = append(ms, &metric.Metric{
743743
Value: float64(val.Value()),
744-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
744+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
745745
})
746746

747747
}
@@ -777,7 +777,7 @@ func createPodInitContainerResourceRequestsFamilyGenerator() generator.FamilyGen
777777
switch resourceName {
778778
case v1.ResourceCPU:
779779
ms = append(ms, &metric.Metric{
780-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
780+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
781781
Value: float64(val.MilliValue()) / 1000,
782782
})
783783
case v1.ResourceStorage:
@@ -786,25 +786,25 @@ func createPodInitContainerResourceRequestsFamilyGenerator() generator.FamilyGen
786786
fallthrough
787787
case v1.ResourceMemory:
788788
ms = append(ms, &metric.Metric{
789-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
789+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
790790
Value: float64(val.Value()),
791791
})
792792
default:
793793
if isHugePageResourceName(resourceName) {
794794
ms = append(ms, &metric.Metric{
795-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
795+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
796796
Value: float64(val.Value()),
797797
})
798798
}
799799
if isAttachableVolumeResourceName(resourceName) {
800800
ms = append(ms, &metric.Metric{
801-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
801+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
802802
Value: float64(val.Value()),
803803
})
804804
}
805805
if isExtendedResourceName(resourceName) {
806806
ms = append(ms, &metric.Metric{
807-
LabelValues: []string{c.Name, p.Spec.NodeName, sanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
807+
LabelValues: []string{c.Name, p.Spec.NodeName, SanitizeLabelName(string(resourceName)), string(constant.UnitInteger)},
808808
Value: float64(val.Value()),
809809
})
810810
}

internal/store/utils.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@ func mapToPrometheusLabels(labels map[string]string, prefix string) ([]string, [
123123
}
124124

125125
func labelName(prefix, labelName string) string {
126-
return prefix + "_" + lintLabelName(sanitizeLabelName(labelName))
126+
return prefix + "_" + lintLabelName(SanitizeLabelName(labelName))
127127
}
128128

129-
func sanitizeLabelName(s string) string {
129+
func SanitizeLabelName(s string) string {
130130
return invalidLabelCharRE.ReplaceAllString(s, "_")
131131
}
132132

internal/store/verticalpodautoscaler.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ func vpaResourcesToMetrics(containerName string, resources v1.ResourceList) []*m
262262
switch resourceName {
263263
case v1.ResourceCPU:
264264
ms = append(ms, &metric.Metric{
265-
LabelValues: []string{containerName, sanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
265+
LabelValues: []string{containerName, SanitizeLabelName(string(resourceName)), string(constant.UnitCore)},
266266
Value: float64(val.MilliValue()) / 1000,
267267
})
268268
case v1.ResourceStorage:
@@ -271,7 +271,7 @@ func vpaResourcesToMetrics(containerName string, resources v1.ResourceList) []*m
271271
fallthrough
272272
case v1.ResourceMemory:
273273
ms = append(ms, &metric.Metric{
274-
LabelValues: []string{containerName, sanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
274+
LabelValues: []string{containerName, SanitizeLabelName(string(resourceName)), string(constant.UnitByte)},
275275
Value: float64(val.Value()),
276276
})
277277
}

pkg/customresourcestate/registry_factory.go

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ import (
2828
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
2929
"k8s.io/klog/v2"
3030

31+
"k8s.io/kube-state-metrics/v2/internal/store"
3132
"k8s.io/kube-state-metrics/v2/pkg/metric"
3233
generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
33-
34-
otelprom "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/prometheus"
3534
)
3635

3736
func compile(resource Resource) ([]compiledFamily, error) {
@@ -505,8 +504,7 @@ func addPathLabels(obj interface{}, labels map[string]valuePath, result map[stri
505504
m := labels[k].Get(obj)
506505
if kv, ok := m.(map[string]interface{}); ok {
507506
for k, v := range kv {
508-
otelCompatPromLabelName := otelprom.NormalizeLabel(k)
509-
result[otelCompatPromLabelName] = fmt.Sprintf("%v", v)
507+
result[store.SanitizeLabelName(k)] = fmt.Sprintf("%v", v)
510508
}
511509
}
512510
}
@@ -519,8 +517,7 @@ func addPathLabels(obj interface{}, labels map[string]valuePath, result map[stri
519517
if value == nil {
520518
continue
521519
}
522-
otelCompatPromLabelName := otelprom.NormalizeLabel(k)
523-
result[otelCompatPromLabelName] = fmt.Sprintf("%v", value)
520+
result[store.SanitizeLabelName(k)] = fmt.Sprintf("%v", value)
524521
}
525522
}
526523

0 commit comments

Comments
 (0)