metrics

Documentation

Index

• func StopDatadog()
• func StopInfluxDB()
• func StopStatsd()
• type PrometheusHandler
  • func (h PrometheusHandler) AddRoutes(router *mux.Router)
• type Registry
  • func NewMultiRegistry(registries []Registry) Registry
  • func NewVoidRegistry() Registry
  • func RegisterDatadog(config *types.Datadog) Registry
  • func RegisterInfluxDB(config *types.InfluxDB) Registry
  • func RegisterPrometheus(config *types.Prometheus) Registry
  • func RegisterStatsd(config *types.Statsd) Registry

Functions

func StopDatadog

func StopDatadog()

StopDatadog stops internal datadogTicker which controls the pushing of metrics to DD Agent and resets it to `nil`.

func StopInfluxDB

func StopInfluxDB()

StopInfluxDB stops internal influxDBTicker which controls the pushing of metrics to InfluxDB Agent and resets it to `nil`

func StopStatsd

func StopStatsd()

StopStatsd stops internal statsdTicker which controls the pushing of metrics to StatsD Agent and resets it to `nil`

Types

type PrometheusHandler

type PrometheusHandler struct{}

PrometheusHandler expose Prometheus routes

func (PrometheusHandler) AddRoutes

func (h PrometheusHandler) AddRoutes(router *mux.Router)

AddRoutes add Prometheus routes on a router

type Registry

type Registry interface {
	// IsEnabled shows whether metrics instrumentation is enabled.
	IsEnabled() bool
	ReqsCounter() metrics.Counter
	ReqDurationHistogram() metrics.Histogram
	RetriesCounter() metrics.Counter
}

Registry has to implemented by any system that wants to monitor and expose metrics.

func NewMultiRegistry

func NewMultiRegistry(registries []Registry) Registry

NewMultiRegistry creates a new standardRegistry that wraps multiple Registries.

func NewVoidRegistry

func NewVoidRegistry() Registry

NewVoidRegistry is a noop implementation of metrics.Registry. It is used to avoid nil checking in components that do metric collections.

func RegisterDatadog

func RegisterDatadog(config *types.Datadog) Registry

RegisterDatadog registers the metrics pusher if this didn't happen yet and creates a datadog Registry instance.

func RegisterInfluxDB

func RegisterInfluxDB(config *types.InfluxDB) Registry

RegisterInfluxDB registers the metrics pusher if this didn't happen yet and creates a InfluxDB Registry instance.

func RegisterPrometheus

func RegisterPrometheus(config *types.Prometheus) Registry

RegisterPrometheus registers all Prometheus metrics. It must be called only once and failing to register the metrics will lead to a panic.

func RegisterStatsd

func RegisterStatsd(config *types.Statsd) Registry

RegisterStatsd registers the metrics pusher if this didn't happen yet and creates a statsd Registry instance.