prometheus metrics

metrics.go

// Package metric allows to create Prometheus metrics easily.
package metric

import "github.com/prometheus/client_golang/prometheus"

// DefaultHistogramBuckets provides a simple and reusable heatmap setup.
var DefaultHistogramBuckets = prometheus.LinearBuckets(0, 0.03, 67)

// Namespace is a Prometheus namespace.
type Namespace string

// RegisterCounter registers a new Prometheus vectorial counter.
func (ns Namespace) RegisterCounter(name, help string, labels ...string) *prometheus.CounterVec {
	opts := prometheus.CounterOpts{
		Namespace: string(ns),
		Name:      name,
		Help:      help,
	}
	met := prometheus.NewCounterVec(opts, labels)
	prometheus.MustRegister(met)
	return met
}

// RegisterHistogram registers a new Prometheus histogram.
func (ns Namespace) RegisterHistogram(name, help string, buckets []float64, labels ...string) *prometheus.HistogramVec {
	opts := prometheus.HistogramOpts{
		Namespace: string(ns),
		Name:      name,
		Help:      help,
		Buckets:   buckets,
	}
	met := prometheus.NewHistogramVec(opts, labels)
	prometheus.MustRegister(met)
	return met
}

// RegisterGauge registers a new Prometheus gauge.
func (ns Namespace) RegisterGauge(name, help string) prometheus.Gauge {
	opts := prometheus.GaugeOpts{
		Namespace: string(ns),
		Name:      name,
		Help:      help,
	}
	met := prometheus.NewGauge(opts)
	prometheus.MustRegister(met)
	return met
}