metrics

Documentation

Overview

Package metrics implements a server which displays only read-only monitoring data.

Index

• func NewListener(config Config) (net.Listener, error)
• type Config
• type Server
  • func NewServer(log *zap.Logger, listener net.Listener, registry *monkit.Registry, ...) (*Server, error)
  • func (server *Server) Close() error
  • func (server *Server) Run(ctx context.Context) error

Functions

func NewListener

func NewListener(config Config) (net.Listener, error)

NewListener configures a TLS listener based on configuration..

Types

type Config

type Config struct {
	Address  string `internal:"true"`
	TLSKey   string
	TLSCert  string
	ClientCA string
}

Config defines configuration for metrics server.

type Server

type Server struct {
	*debug.PrometheusEndpoint
	// contains filtered or unexported fields
}

Server provides endpoints for debugging.

func NewServer

func NewServer(log *zap.Logger, listener net.Listener, registry *monkit.Registry, config Config) (*Server, error)

NewServer returns a new debug.Server.

func (*Server) Close

func (server *Server) Close() error

Close closes server and underlying listener.

func (*Server) Run

func (server *Server) Run(ctx context.Context) error

Run starts the debug endpoint.