Skip to content

Extract shared ASB Prometheus helpers #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
haasonsaas merged 1 commit into from
Apr 14, 2026
+121 −169
Merged

Extract shared ASB Prometheus helpers #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 14 additions & 104 deletions internal/app/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package app

import (
"fmt"
"strings"
"time"
"unicode"

"github.com/evalops/asb/internal/core"
"github.com/evalops/asb/internal/promutil"
"github.com/prometheus/client_golang/prometheus"
)

Expand Down Expand Up @@ -36,9 +35,9 @@ type Metrics struct {
// NewMetrics creates Prometheus collectors for ASB domain metrics.
func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
opts = opts.withDefaults()
prefix := metricsPrefix(serviceName)
prefix := promutil.MetricPrefix(serviceName)

sessionsActive, err := registerGaugeVec(
sessionsActive, err := promutil.RegisterGaugeVec(
opts.Registerer,
prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Expand All @@ -52,7 +51,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

sessionsTotal, err := registerCounterVec(
sessionsTotal, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -66,7 +65,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

grantsTotal, err := registerCounterVec(
grantsTotal, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -80,7 +79,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

grantTTL, err := registerHistogram(
grantTTL, err := promutil.RegisterHistogram(
opts.Registerer,
prometheus.NewHistogram(
prometheus.HistogramOpts{
Expand All @@ -94,7 +93,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

approvalsTotal, err := registerCounterVec(
approvalsTotal, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -108,7 +107,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

approvalWait, err := registerHistogramVec(
approvalWait, err := promutil.RegisterHistogramVec(
opts.Registerer,
prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Expand All @@ -123,7 +122,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

policyEval, err := registerCounterVec(
policyEval, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -137,7 +136,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

budgetExhaust, err := registerCounterVec(
budgetExhaust, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -151,7 +150,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

artifactsActive, err := registerGaugeVec(
artifactsActive, err := promutil.RegisterGaugeVec(
opts.Registerer,
prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Expand All @@ -165,7 +164,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

artifactUnwraps, err := registerCounterVec(
artifactUnwraps, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -179,7 +178,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

connectorOps, err := registerCounterVec(
connectorOps, err := promutil.RegisterCounterVec(
opts.Registerer,
prometheus.NewCounterVec(
prometheus.CounterOpts{
Expand All @@ -193,7 +192,7 @@ func NewMetrics(serviceName string, opts MetricsOptions) (*Metrics, error) {
return nil, err
}

connectorLatency, err := registerHistogramVec(
connectorLatency, err := promutil.RegisterHistogramVec(
opts.Registerer,
prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Expand Down Expand Up @@ -353,92 +352,3 @@ func labelOrUnknown(value string) string {
}
return value
}

func metricsPrefix(serviceName string) string {
serviceName = strings.TrimSpace(serviceName)
if serviceName == "" {
return "service"
}

var builder strings.Builder
for index, runeValue := range serviceName {
switch {
case unicode.IsLetter(runeValue), unicode.IsDigit(runeValue):
builder.WriteRune(unicode.ToLower(runeValue))
default:
builder.WriteByte('_')
}
if index == 0 && unicode.IsDigit(runeValue) {
builder.WriteByte('_')
}
}

prefix := strings.Trim(builder.String(), "_")
if prefix == "" {
return "service"
}
if prefix[0] >= '0' && prefix[0] <= '9' {
return "service_" + prefix
}
return prefix
}

func registerGaugeVec(registerer prometheus.Registerer, collector *prometheus.GaugeVec) (*prometheus.GaugeVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.GaugeVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}

func registerCounterVec(registerer prometheus.Registerer, collector *prometheus.CounterVec) (*prometheus.CounterVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.CounterVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}

func registerHistogram(registerer prometheus.Registerer, collector prometheus.Histogram) (prometheus.Histogram, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(prometheus.Histogram)
if !ok {
return nil, fmt.Errorf("register histogram: existing collector has unexpected type %T", alreadyRegistered.ExistingCollector)
}
return existing, nil
}
return collector, nil
}

func registerHistogramVec(registerer prometheus.Registerer, collector *prometheus.HistogramVec) (*prometheus.HistogramVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.HistogramVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}
103 changes: 103 additions & 0 deletions internal/promutil/promutil.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
package promutil

import (
"fmt"
"strings"
"unicode"

"github.com/prometheus/client_golang/prometheus"
)

// MetricPrefix normalizes a service name into a Prometheus metric prefix.
func MetricPrefix(serviceName string) string {
serviceName = strings.TrimSpace(serviceName)
if serviceName == "" {
return "service"
}

var builder strings.Builder
for index, runeValue := range serviceName {
switch {
case unicode.IsLetter(runeValue), unicode.IsDigit(runeValue):
builder.WriteRune(unicode.ToLower(runeValue))
default:
builder.WriteByte('_')
}
if index == 0 && unicode.IsDigit(runeValue) {
builder.WriteByte('_')
}
}

prefix := strings.Trim(builder.String(), "_")
if prefix == "" {
return "service"
}
if prefix[0] >= '0' && prefix[0] <= '9' {
return "service_" + prefix
}
return prefix
}

// RegisterGaugeVec registers collector and returns an existing compatible collector when present.
func RegisterGaugeVec(registerer prometheus.Registerer, collector *prometheus.GaugeVec) (*prometheus.GaugeVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.GaugeVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}

// RegisterCounterVec registers collector and returns an existing compatible collector when present.
func RegisterCounterVec(registerer prometheus.Registerer, collector *prometheus.CounterVec) (*prometheus.CounterVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.CounterVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}

// RegisterHistogram registers collector and returns an existing compatible collector when present.
func RegisterHistogram(registerer prometheus.Registerer, collector prometheus.Histogram) (prometheus.Histogram, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(prometheus.Histogram)
if !ok {
return nil, fmt.Errorf("register histogram: existing collector has unexpected type %T", alreadyRegistered.ExistingCollector)
}
return existing, nil
}
return collector, nil
}

// RegisterHistogramVec registers collector and returns an existing compatible collector when present.
func RegisterHistogramVec(registerer prometheus.Registerer, collector *prometheus.HistogramVec) (*prometheus.HistogramVec, error) {
if err := registerer.Register(collector); err != nil {
alreadyRegistered, ok := err.(prometheus.AlreadyRegisteredError)
if !ok {
return nil, err
}
existing, ok := alreadyRegistered.ExistingCollector.(*prometheus.HistogramVec)
if !ok {
return nil, err
}
return existing, nil
}
return collector, nil
}
Loading
Loading