metrics

Documentation

Overview

Package metrics implements an HTTP metrics server along with its life cycle: start, shutdown, and register metrics.

Index

• type Registerer
• type Registry
• type Server
  • func NewServer(addr string) *Server
  • func (m Server) MustRegister(collectors ...prometheus.Collector)
  • func (m Server) Register(collector prometheus.Collector) error
  • func (m Server) Shutdown()
  • func (m Server) Start()

Types

type Registerer

type Registerer interface {
	RegisterMetrics(Registry)
}

type Registry

type Registry interface {
	Register(prometheus.Collector) error
	MustRegister(...prometheus.Collector)
}

Registry defines the interface of the prometheus metrics registry

type Server

type Server struct {
	// contains filtered or unexported fields
}

A metrics server holds the http API and the prometheus registry which provides access to the registered metrics.

func NewServer

func NewServer(addr string) *Server

Create new metrics server. Do not listen to the given address until the server is started.

func (Server) MustRegister

func (m Server) MustRegister(collectors ...prometheus.Collector)

MustRegister registers multiple prometheus collectors in the prometheus registry used by the metrics server.

func (Server) Register

func (m Server) Register(collector prometheus.Collector) error

Register registers a prometheus collector in the prometheus registry used by the metrics server.

func (Server) Shutdown

func (m Server) Shutdown()

Shutdown gracefully shutdowns metrics http server waiting 5 seconds for connections to be closed.

func (Server) Start

func (m Server) Start()

Listens on the configured address and blocks until shutdown is called.