metrics

Documentation

Index

• Constants
• func Initialize(port int) (*metrics.Registry, bool)
• func ObserveBtcChainConnectivity(ctx context.Context, registry *metrics.Registry, btcHandle btc.Handle, ...)
• func ObserveHeadersPulled(ctx context.Context, registry *metrics.Registry, nodeStats node.Stats, ...)
• func ObserveHeadersPushed(ctx context.Context, registry *metrics.Registry, nodeStats node.Stats, ...)
• func ObserveHeadersRelayActive(ctx context.Context, registry *metrics.Registry, nodeStats node.Stats, ...)
• func ObserveHeadersRelayErrors(ctx context.Context, registry *metrics.Registry, nodeStats node.Stats, ...)
• func ObserveHostChainConnectivity(ctx context.Context, registry *metrics.Registry, hostChain chain.Handle, ...)

Constants

const (
	// DefaultChainMetricsTick is the default duration of the
	// observation tick for chain-related metrics.
	DefaultChainMetricsTick = 10 * time.Minute
	// DefaultNodeMetricsTick is the default duration of the
	// observation tick for node-related metrics.
	DefaultNodeMetricsTick = 10 * time.Second
)

Functions

func Initialize

func Initialize(
	port int,
) (*metrics.Registry, bool)

Initialize set up the metrics registry and enables metrics server.

func ObserveBtcChainConnectivity

func ObserveBtcChainConnectivity(
	ctx context.Context,
	registry *metrics.Registry,
	btcHandle btc.Handle,
	tick time.Duration,
)

ObserveBtcChainConnectivity triggers an observation process of the btc_chain_connectivity metric.

func ObserveHeadersPulled

func ObserveHeadersPulled(
	ctx context.Context,
	registry *metrics.Registry,
	nodeStats node.Stats,
	tick time.Duration,
)

ObserveHeadersPulled triggers an observation process of the headers_pulled metric.

func ObserveHeadersPushed

func ObserveHeadersPushed(
	ctx context.Context,
	registry *metrics.Registry,
	nodeStats node.Stats,
	tick time.Duration,
)

ObserveHeadersPushed triggers an observation process of the headers_pushed metric.

func ObserveHeadersRelayActive

func ObserveHeadersRelayActive(
	ctx context.Context,
	registry *metrics.Registry,
	nodeStats node.Stats,
	tick time.Duration,
)

ObserveHeadersRelayActive triggers an observation process of the headers_relay_active metric.

func ObserveHeadersRelayErrors

func ObserveHeadersRelayErrors(
	ctx context.Context,
	registry *metrics.Registry,
	nodeStats node.Stats,
	tick time.Duration,
)

ObserveHeadersRelayErrors triggers an observation process of the headers_relay_errors metric.

func ObserveHostChainConnectivity

func ObserveHostChainConnectivity(
	ctx context.Context,
	registry *metrics.Registry,
	hostChain chain.Handle,
	tick time.Duration,
)

ObserveHostChainConnectivity triggers an observation process of the host_chain_connectivity metric.