metrics

README

Metrics

graph LR
    A[avalanche] --> B[api]
    A --> C[chain]
    A --> D[db]
    A --> E[health]
    A --> F[network]
    A --> G[process]
    A --> H[requests]
    A --> I[resource_tracker]
    A --> J[responses]
    A --> K[system_resources]
    C -- $chainID --> L[avalanche]
    C -- $chainID --> M[handler]
    C -- $chainID --> N[meterchainvm]
    C -- $chainID --> O[meterdagvm]
    C -- $chainID --> P[meterdb]
    C -- $chainID --> Q[proposervm]
    C -- $chainID --> R[snowman]
    C -- $chainID --> S[$vmID]

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

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 AvalancheGo 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.