go-metrics/registry.go

package metrics

import "sync"

// A Registry holds references to a set of metrics by name and can iterate
// over them, calling callback functions provided by the user.
//
// This is an interface so as to encourage other structs to implement
// the Registry API as appropriate.
type Registry interface {
	Each(func(string, interface{}))
	Get(string) interface{}
	Register(string, interface{})
	RunHealthchecks()
	Unregister(string)
}

// The standard implementation of a Registry is a set of mutex-protected
// maps of names to metrics.
type StandardRegistry struct {
	mutex *sync.Mutex
	metrics map[string]interface{}
}

// Create a new registry.
func NewRegistry() *StandardRegistry {
	return &StandardRegistry {
		&sync.Mutex{},
		make(map[string]interface{}),
	}
}

// Call the given function for each registered metric.
func (r *StandardRegistry) Each(f func(string, interface{})) {
	r.mutex.Lock()
	for name, i := range r.metrics { f(name, i) }
	r.mutex.Unlock()
}

// Get the metric by the given name or nil if none is registered.
func (r *StandardRegistry) Get(name string) interface{} {
	r.mutex.Lock()
	i := r.metrics[name]
	r.mutex.Unlock()
	return i
}

// Register the given metric under the given name.
func (r *StandardRegistry) Register(name string, i interface{}) {
	switch i.(type) {
	case Counter, Gauge, Healthcheck, Histogram, Meter, Timer:
		r.mutex.Lock()
		r.metrics[name] = i
		r.mutex.Unlock()
	}
}

// Run all registered healthchecks.
func (r *StandardRegistry) RunHealthchecks() {
	r.mutex.Lock()
	for _, i := range r.metrics {
		if h, ok := i.(Healthcheck); ok { h.Check() }
	}
	r.mutex.Unlock()
}

// Unregister the metric with the given name.
func (r *StandardRegistry) Unregister(name string) {
	r.mutex.Lock()
	r.metrics[name] = nil, false
	r.mutex.Unlock()
}