add custom type (consts) examples + tests

Author: amberpixels

prometheus/promsafe/labels_provider_test.go

@@ -21,11 +21,43 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 )
 
+// CustomType that will be stringified via String() method
+type CustomType int
+
+const (
+	CustomConst0 CustomType = iota
+	CustomConst1
+	CustomConst2
+)
+
+func (ct CustomType) String() string {
+	switch ct {
+	case CustomConst1:
+		return "c1"
+	case CustomConst2:
+		return "c2"
+
+	default:
+		return "c0"
+	}
+}
+
+// CustomTypeInt will remain as simple int
+type CustomTypeInt int
+
+const (
+	CustomConstInt100 CustomTypeInt = 100
+	CustomConstInt200 CustomTypeInt = 200
+)
+
 type TestLabels struct {
 	StructLabelProvider
 	Field1 string
 	Field2 int
 	Field3 bool
+
+	Field4 CustomType
+	Field5 CustomTypeInt
 }
 
 type TestLabelsWithTags struct {
@@ -74,11 +106,15 @@ func Test_extractLabelsWithValues(t *testing.T) {
 				Field1: "value1",
 				Field2: 123,
 				Field3: true,
+				Field4: CustomConst1,
+				Field5: CustomConstInt200,
 			},
 			expected: prometheus.Labels{
 				"field1": "value1",
 				"field2": "123",
 				"field3": "true",
+				"field4": "c1",
+				"field5": "200",
 			},
 		},
 		{

prometheus/promsafe/promauto_adapter/promauto_adapter_test.go

@@ -20,6 +20,26 @@ import (
 	promauto "github.com/prometheus/client_golang/prometheus/promsafe/promauto_adapter"
 )
 
+type EventType int64
+
+const (
+	EventTypeUndefined EventType = iota
+	EventTypeUser
+	EventTypeSystem
+)
+
+// String returns stringified value of EventType enum
+func (et EventType) String() string {
+	switch et {
+	case EventTypeUser:
+		return "user"
+	case EventTypeSystem:
+		return "system"
+	default:
+		return "undefined"
+	}
+}
+
 func ExampleNewCounterVec_promauto_adapted() {
 	// Examples on how to migrate from promauto to promsafe gently
 	//
@@ -45,13 +65,16 @@ func ExampleNewCounterVec_promauto_adapted() {
 
 	type MyLabels struct {
 		promsafe.StructLabelProvider
-		EventType string
+		EventType EventType
 		Source    string
 	}
+	// if declare Mylabels as global type you can add .ToPrometheusLabels() method
+	// that will use fast labels convertion instead of automatic reflect-based
+
 	c := promauto.With[MyLabels](myReg).NewCounterVec(counterOpts)
 
 	c.With(MyLabels{
-		EventType: "reservation", Source: "source1",
+		EventType: EventTypeUser, Source: "source1",
 	}).Inc()
 
 	// Output: