From 78aeb5d8607948a800960fddeebc6fcb0cd89d2d Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 24 Aug 2026 18:10:57 +0200 Subject: [PATCH] deprecate convenience wrappers The Register, Deregister, and Handler functions are direct wrappers for prometheus functions. Deprecate them and add a `//go:fix` directive to help users migrate to their equivalent. Signed-off-by: Sebastiaan van Stijn --- handler.go | 4 ++++ register.go | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/handler.go b/handler.go index 344d46d..fc76481 100644 --- a/handler.go +++ b/handler.go @@ -44,6 +44,10 @@ var ( // Handler is a convenience wrapper around [promhttp.Handler] that returns an // HTTP handler serving metrics from the default Prometheus gatherer. +// +// Deprecated: use [promhttp.Handler] directly. +// +//go:fix inline func Handler() http.Handler { return promhttp.Handler() } diff --git a/register.go b/register.go index ad2d8d2..2da9b8d 100644 --- a/register.go +++ b/register.go @@ -4,12 +4,20 @@ import "github.com/prometheus/client_golang/prometheus" // Register is a convenience wrapper around [prometheus.MustRegister] that // registers all metrics in n with the default Prometheus registry. +// +// Deprecated: use [prometheus.MustRegister] directly. +// +//go:fix inline func Register(n *Namespace) { prometheus.MustRegister(n) } // Deregister is a convenience wrapper around [prometheus.Unregister] that // unregisters all metrics in n from the default Prometheus registry. +// +// Deprecated: use [prometheus.Unregister] directly. +// +//go:fix inline func Deregister(n *Namespace) { prometheus.Unregister(n) }