metrics

Documentation

Index

• type Configuration
• type Server
  • func NewServer(c Configuration, log *logger.Logger) (s *Server, err error)
  • func (s *Server) Start() error
  • func (s *Server) Stop()

Types

type Configuration

type Configuration struct {
	// TCP address (<IP>:<port>) where the Prometheus metrics are exported.
	Address string

	// The path where the metrics are exported.
	Path string

	// Indicate whether the profiling metrics must be exported or not.
	Profiling bool
}

Configuration represents the configuration used to export the metrics.

type Server

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

Server represents an HTTP server responsible for exporting metrics.

func NewServer

func NewServer(c Configuration, log *logger.Logger) (s *Server, err error)

NewServer creates a metrics Server instance.

func (*Server) Start

func (s *Server) Start() error

Start starts the execution of the Server.

func (*Server) Stop

func (s *Server) Stop()

Stop stops the Metrics Server. Once called, it unblocks the Server.