metrics

Documentation

Index

• Variables
• type Config
  • func (c *Config) Start(ctx context.Context, nodeConfig *config.Node) error

Variables

var DefaultGatherer = legacyregistry.DefaultGatherer

DefaultGatherer is the implementation of the prometheus Gatherere interface that all metrics operations will use.

var DefaultMetrics = &Config{
	Router: func(context.Context, *config.Node) (*mux.Router, error) {
		return nil, errors.New("not implemented")
	},
}

DefaultMetrics is the default instance of a Metrics server

var DefaultRegisterer = legacyregistry.Registerer()

DefaultRegisterer is the implementation of the prometheus Registerer interface that all metrics operations will use.

Types

type Config

type Config struct {
	// Router will be called to add the metrics API handler to an existing router.
	Router https.RouterFunc
}

Config holds fields for the metrics listener

func (*Config) Start

func (c *Config) Start(ctx context.Context, nodeConfig *config.Node) error

Start starts binds the metrics API to an existing HTTP router.