metrics

Documentation

Overview

Package metrics defines metric reporting for the p2p component.

Index

• Constants
• Variables

Constants

const (
	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
	// package.
	MetricsSubsystem = "p2p"

	// ProtocolLabel holds the name we use to add a protocol label value
	ProtocolLabel = "protocol"

	// PeerIDLabel holds the name we use to add a protocol label value
	PeerIDLabel = "peer_id"
)

Variables

var (
	// PropagationQueueLen is the current size of the gossip queue
	PropagationQueueLen = metrics.NewGauge(
		"propagate_queue_len",
		MetricsSubsystem,
		"Number of messages in the gossip queue",
		nil,
	)
	// QueueLength is the current size of protocol queues
	QueueLength = metrics.NewGauge(
		"protocol_queue_len",
		MetricsSubsystem,
		"Length of protocol queues",
		[]string{ProtocolLabel},
	)

	// OutboundPeers is the number of outbound peers we have connected
	OutboundPeers = totalPeers.With(typeLabel, "outbound")

	// InboundPeers is the number of inbound peers we have connected
	InboundPeers = totalPeers.With(typeLabel, "inbound")

	// PeerRecv is the num of bytes received from peer
	PeerRecv = metrics.NewCounter(
		"peer_receive_bytes_total",
		MetricsSubsystem,
		"Number of bytes received from a given peer",
		[]string{PeerIDLabel},
	)

	// PeerSend is the num of bytes sent to peer
	PeerSend = metrics.NewCounter(
		"peer_send_bytes_total",
		MetricsSubsystem,
		"Number of bytes sent to a given peer",
		[]string{PeerIDLabel},
	)

	// NewGossipMessages is a metric for newly received gossip messages
	NewGossipMessages = totalGossipMessages.With(messageTypeLabel, "new")

	// OldGossipMessages is a metric for old messages received (duplicates)
	OldGossipMessages = totalGossipMessages.With(messageTypeLabel, "old")

	// InvalidGossipMessages is a metric for invalid messages received
	InvalidGossipMessages = totalGossipMessages.With(messageTypeLabel, "invalid")

	// AddrbookSize is the current size of the discovery
	AddrbookSize = metrics.NewGauge(
		"addrbook_size",
		MetricsSubsystem,
		"Number of peers in the discovery",
		[]string{},
	)
)