GW
Go Warp API
metrics API

metrics

package

API reference for the metrics package.

Imports

(2)
STD testing PKG github.com/prometheus/client_golang/prometheus
F
function

TestRegisterCoreMetrics

Parameters

t
*testing.T
v1/metrics/metrics_test.go:9-23 
func TestRegisterCoreMetrics(t *testing.T)

{
	reg := prometheus.NewRegistry()
	RegisterCoreMetrics(reg)
	GetCounter.Inc()
	SetCounter.Inc()
	InvalidateCounter.Inc()
	WatcherGauge.Set(5)
	mfs, err := reg.Gather()
	if err != nil {
		t.Fatalf("gather: %v", err)
	}
	if len(mfs) < 4 {
		t.Fatalf("expected metrics registered")
	}
}
F
function

TestRegisterCoreMetricsDuplicatePanics

Parameters

t
*testing.T
v1/metrics/metrics_test.go:25-34 
func TestRegisterCoreMetricsDuplicatePanics(t *testing.T)

{
	reg := prometheus.NewRegistry()
	RegisterCoreMetrics(reg)
	defer func() {
		if r := recover(); r == nil {
			t.Fatal("expected panic on duplicate registration")
		}
	}()
	RegisterCoreMetrics(reg)
}
F
function

NewRegistry

NewRegistry creates a new Prometheus registry.

v1/metrics/metrics.go:29-31 
func NewRegistry() *prometheus.Registry

{
	return prometheus.NewRegistry()
}
F
function

RegisterCoreMetrics

RegisterCoreMetrics registers warp core metrics on the provided registry.

Parameters

reg
prometheus.Registerer
v1/metrics/metrics.go:34-36 
func RegisterCoreMetrics(reg prometheus.Registerer)

{
	reg.MustRegister(GetCounter, SetCounter, InvalidateCounter, WatcherGauge)
}