metrics

Documentation

Index

• Variables
• type IntervalConfig
  • func NewIntervalConfig(publish bool) IntervalConfig
• type Logger
• type Server
  • func NewServer(address string) (s *Server)
  • func (s *Server) Start(address string) (err error)
  • func (s *Server) Stop() (err error)

Variables

var (
	ErrServerEndedUnexpectedly = fmt.Errorf("metrics server exited unexpectedly")
	ErrServerStopTimeout       = fmt.Errorf("metrics server exit timeout")
)

Types

type IntervalConfig

type IntervalConfig struct {
	Publish  bool
	Interval time.Duration
}

IntervalConfig for interval collection

func NewIntervalConfig

func NewIntervalConfig(publish bool) IntervalConfig

NewIntervalConfig is constructor for IntervalConfig, and uses default metrics interval

type Logger

type Logger interface {
	Info(s string)
	Warn(s string)
	Error(s string)
	Infof(format string, args ...interface{})
}

Logger logs formatted strings at the different log levels.

type Server

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

Server is a metrics http server

func NewServer

func NewServer(address string) (s *Server)

NewServer is a constructor for metrics server

func (*Server) Start

func (s *Server) Start(address string) (err error)

Start will start a dedicated metrics server at the given address.

func (*Server) Stop

func (s *Server) Stop() (err error)

Stop will stop the metrics server