update examples on promauto adapter

prometheus/promsafe/promauto/auto.go → prometheus/promsafe/promauto_adapter/promauto_adapter.go

@@ -1,12 +1,12 @@
-package promauto
+package promauto_adapter
 
 import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
 	"github.com/prometheus/client_golang/prometheus/promsafe"
 )
 
-// NewCounterVec behaves as promauto.NewCounterVec but with type-safe labels
+// NewCounterVec behaves as adapter-promauto.NewCounterVec but with type-safe labels
 func NewCounterVec[T promsafe.LabelsProviderMarker](opts prometheus.CounterOpts) *promsafe.CounterVec[T] {
 	//_ = promauto.NewCounterVec // keeping for reference
 
@@ -22,12 +22,12 @@ type Factory[T promsafe.LabelsProviderMarker] struct {
 	r prometheus.Registerer
 }
 
-// With behaves same as promauto.With but with type-safe labels
+// With behaves same as adapter-promauto.With but with type-safe labels
 func With[T promsafe.LabelsProviderMarker](r prometheus.Registerer) Factory[T] {
 	return Factory[T]{r: r}
 }
 
-// NewCounterVec behaves like promauto.NewCounterVec but with type-safe labels
+// NewCounterVec behaves like adapter-promauto.NewCounterVec but with type-safe labels
 func (f Factory[T]) NewCounterVec(opts prometheus.CounterOpts) *promsafe.CounterVec[T] {
 	c := NewCounterVec[T](opts)
 	if f.r != nil {

prometheus/promsafe/promauto_adapter/promauto_adapter_test.go

@@ -0,0 +1,44 @@
+package promauto_adapter_test
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promsafe"
+	promauto "github.com/prometheus/client_golang/prometheus/promsafe/promauto_adapter"
+)
+
+func ExampleNewCounterVec_promauto_adapted() {
+	// Examples on how to migrate from promauto to promsafe gently
+	//
+	// Before:
+	//   import "github.com/prometheus/client_golang/prometheus/promauto"
+	// func main() {
+	//   myReg := prometheus.NewRegistry()
+	//   counterOpts := prometheus.CounterOpts{Name:"..."}
+	//   promauto.With(myReg).NewCounterVec(counterOpts, []string{"event_type", "source"})
+	// }
+	//
+	// After:
+	//
+	//   import (
+	//     promauto "github.com/prometheus/client_golang/prometheus/promsafe/promauto_adapter"
+	//   )
+	//   ...
+
+	myReg := prometheus.NewRegistry()
+	counterOpts := prometheus.CounterOpts{
+		Name: "items_counted_detailed_auto",
+	}
+
+	type MyLabels struct {
+		promsafe.StructLabelProvider
+		EventType string
+		Source    string
+	}
+	c := promauto.With[MyLabels](myReg).NewCounterVec(counterOpts)
+
+	c.With(MyLabels{
+		EventType: "reservation", Source: "source1",
+	}).Inc()
+
+	// Output:
+}