metrics

Documentation

Overview

Package metrics contains the HTTP server for exposing Prometheus metrics.

Index

• Constants
• func AppendMetricsMiddlewares(log *slog.Logger, uu []grpc.UnaryServerInterceptor, ...) ([]grpc.UnaryServerInterceptor, []grpc.StreamServerInterceptor, error)
• type Options
• type Server
  • func New(ctx context.Context, o Options) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Shutdown(ctx context.Context) error

Constants

const DefaultListenAddress = "[::]:8080"

DefaultListenAddress is the default listen address for the node Metrics.

const DefaultPath = "/metrics"

DefaultPath is the default path for the node Metrics.

Functions

func AppendMetricsMiddlewares

func AppendMetricsMiddlewares(log *slog.Logger, uu []grpc.UnaryServerInterceptor, ss []grpc.StreamServerInterceptor) ([]grpc.UnaryServerInterceptor, []grpc.StreamServerInterceptor, error)

AppendMetricsMiddlewares appends the Prometheus metrics middlewares to the gRPC server interceptors.

Types

type Options

type Options struct {
	// ListenAddress is the address to start the metrics server on.
	ListenAddress string
	// Path is the path to expose metrics on.
	Path string
}

Options contains the configuration for exposing node metrics.

type Server

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

Server is the metrics server.

func New

func New(ctx context.Context, o Options) *Server

New returns a new metrics server.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe starts the server and blocks until the server exits.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown attempts to stop the server gracefully.