metrics

Documentation

Index

• type Metrics
  • func New(logger log.Logger, addr string) *Metrics
  • func (s *Metrics) InitializeMetrics(server *grpc.Server)
  • func (s *Metrics) Registry() *prometheus.Registry
  • func (s *Metrics) Serve()
  • func (s *Metrics) UnaryServerInterceptor() grpc.UnaryServerInterceptor

Types

type Metrics

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

Metrics wraps the prometheus metrics gathering and serving.

It exposes gRPC and Go Runtime metrics.

func New

func New(logger log.Logger, addr string) *Metrics

func (*Metrics) InitializeMetrics

func (s *Metrics) InitializeMetrics(server *grpc.Server)

InitializeMetrics initializes all metrics, with their appropriate null value, for all gRPC methods registered on a gRPC server. This is useful, to ensure that all metrics exist when collecting and querying.

func (*Metrics) Registry

func (s *Metrics) Registry() *prometheus.Registry

func (*Metrics) Serve

func (s *Metrics) Serve()

func (*Metrics) UnaryServerInterceptor

func (s *Metrics) UnaryServerInterceptor() grpc.UnaryServerInterceptor

UnaryServerInterceptor returns an UnaryServerInterceptor that must be installed on the grpc.Server to gather metrics.