metrics

Documentation

Index

• func MakeAndRegister(gatherer MultiGatherer, name string) (*prometheus.Registry, error)
• type Client
  • func NewClient(uri string) *Client
  • func (c *Client) GetMetrics(ctx context.Context) (map[string]*dto.MetricFamily, error)
• type MultiGatherer
  • func NewLabelGatherer(labelName string) MultiGatherer
  • func NewMultiGatherer() MultiGatherer
  • func NewPrefixGatherer() MultiGatherer
• type OptionalGatherer
  • func NewOptionalGatherer() OptionalGatherer

Functions

func MakeAndRegister

func MakeAndRegister(gatherer MultiGatherer, name string) (*prometheus.Registry, error)

Types

type Client

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

Client for requesting metrics from a remote Lux Node instance

func NewClient

func NewClient(uri string) *Client

NewClient returns a new Metrics API Client

func (*Client) GetMetrics

func (c *Client) GetMetrics(ctx context.Context) (map[string]*dto.MetricFamily, error)

GetMetrics returns the metrics from the connected node. The metrics are returned as a map of metric family name to the metric family.

type MultiGatherer

type MultiGatherer interface {
	prometheus.Gatherer

	// Register adds the outputs of [gatherer] to the results of future calls to
	// Gather with the provided [name] added to the metrics.
	Register(name string, gatherer prometheus.Gatherer) error
}

MultiGatherer extends the Gatherer interface by allowing additional gatherers to be registered.

func NewLabelGatherer

func NewLabelGatherer(labelName string) MultiGatherer

NewLabelGatherer returns a new MultiGatherer that merges metrics by adding a new label.

func NewMultiGatherer

func NewMultiGatherer() MultiGatherer

Deprecated: Use NewPrefixGatherer instead.

TODO: Remove once coreth is updated.

func NewPrefixGatherer

func NewPrefixGatherer() MultiGatherer

NewPrefixGatherer returns a new MultiGatherer that merges metrics by adding a prefix to their names.

type OptionalGatherer

type OptionalGatherer interface {
	prometheus.Gatherer

	// Register the provided gatherer. If a gatherer was previously registered,
	// an error will be returned.
	Register(gatherer prometheus.Gatherer) error
}

OptionalGatherer extends the Gatherer interface by allowing the optional registration of a single gatherer. If no gatherer is registered, Gather will return no metrics and no error. If a gatherer is registered, Gather will return the results of calling Gather on the provided gatherer.

func NewOptionalGatherer

func NewOptionalGatherer() OptionalGatherer