diff --git a/internal/p2p/metrics.gen.go b/internal/p2p/metrics.gen.go index 8244da1f4..cbfba29d9 100644 --- a/internal/p2p/metrics.gen.go +++ b/internal/p2p/metrics.gen.go @@ -24,49 +24,49 @@ func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics { Namespace: namespace, Subsystem: MetricsSubsystem, Name: "peer_receive_bytes_total", - Help: "Number of bytes received from a given peer.", + Help: "Number of bytes per channel received from a given peer.", }, append(labels, "peer_id", "chID", "message_type")).With(labelsAndValues...), PeerSendBytesTotal: prometheus.NewCounterFrom(stdprometheus.CounterOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "peer_send_bytes_total", - Help: "Number of bytes sent to a given peer.", + Help: "Number of bytes per channel sent to a given peer.", }, append(labels, "peer_id", "chID", "message_type")).With(labelsAndValues...), PeerPendingSendBytes: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "peer_pending_send_bytes", - Help: "Pending bytes to be sent to a given peer.", + Help: "Number of bytes pending being sent to a given peer.", }, append(labels, "peer_id")).With(labelsAndValues...), RouterPeerQueueRecv: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "router_peer_queue_recv", - Help: "RouterPeerQueueRecv defines the time taken to read off of a peer's queue before sending on the connection.", + Help: "The time taken to read off of a peer's queue before sending on the connection.", }, labels).With(labelsAndValues...), RouterPeerQueueSend: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "router_peer_queue_send", - Help: "RouterPeerQueueSend defines the time taken to send on a peer's queue which will later be read and sent on the connection (see RouterPeerQueueRecv).", + Help: "The time taken to send on a peer's queue which will later be read and sent on the connection.", }, labels).With(labelsAndValues...), RouterChannelQueueSend: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "router_channel_queue_send", - Help: "RouterChannelQueueSend defines the time taken to send on a p2p channel's queue which will later be consued by the corresponding reactor/service.", + Help: "The time taken to send on a p2p channel's queue which will later be consued by the corresponding reactor/service.", }, labels).With(labelsAndValues...), PeerQueueDroppedMsgs: prometheus.NewCounterFrom(stdprometheus.CounterOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "router_channel_queue_dropped_msgs", - Help: "PeerQueueDroppedMsgs defines the number of messages dropped from a peer's queue for a specific flow (i.e. Channel).", + Help: "The number of messages dropped from a peer's queue for a specific p2p Channel.", }, append(labels, "ch_id")).With(labelsAndValues...), PeerQueueMsgSize: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{ Namespace: namespace, Subsystem: MetricsSubsystem, Name: "peer_queue_msg_size", - Help: "PeerQueueMsgSize defines the average size of messages sent over a peer's queue for a specific flow (i.e. Channel).", + Help: "The size of messages sent over a peer's queue for a specific p2p Channel.", }, append(labels, "ch_id")).With(labelsAndValues...), } } diff --git a/internal/p2p/metrics.go b/internal/p2p/metrics.go index c44d9ceca..b45f128e5 100644 --- a/internal/p2p/metrics.go +++ b/internal/p2p/metrics.go @@ -28,31 +28,36 @@ var ( type Metrics struct { // Number of peers. Peers metrics.Gauge - // Number of bytes received from a given peer. + // Number of bytes per channel received from a given peer. PeerReceiveBytesTotal metrics.Counter `metrics_labels:"peer_id, chID, message_type"` - // Number of bytes sent to a given peer. + // Number of bytes per channel sent to a given peer. PeerSendBytesTotal metrics.Counter `metrics_labels:"peer_id, chID, message_type"` - // Pending bytes to be sent to a given peer. + // Number of bytes pending being sent to a given peer. PeerPendingSendBytes metrics.Gauge `metrics_labels:"peer_id"` // RouterPeerQueueRecv defines the time taken to read off of a peer's queue // before sending on the connection. + //metrics:The time taken to read off of a peer's queue before sending on the connection. RouterPeerQueueRecv metrics.Histogram // RouterPeerQueueSend defines the time taken to send on a peer's queue which // will later be read and sent on the connection (see RouterPeerQueueRecv). + //metrics:The time taken to send on a peer's queue which will later be read and sent on the connection. RouterPeerQueueSend metrics.Histogram // RouterChannelQueueSend defines the time taken to send on a p2p channel's // queue which will later be consued by the corresponding reactor/service. + //metrics:The time taken to send on a p2p channel's queue which will later be consued by the corresponding reactor/service. RouterChannelQueueSend metrics.Histogram // PeerQueueDroppedMsgs defines the number of messages dropped from a peer's // queue for a specific flow (i.e. Channel). + //metrics:The number of messages dropped from a peer's queue for a specific p2p Channel. PeerQueueDroppedMsgs metrics.Counter `metrics_labels:"ch_id" metrics_name:"router_channel_queue_dropped_msgs"` // PeerQueueMsgSize defines the average size of messages sent over a peer's // queue for a specific flow (i.e. Channel). + //metrics:The size of messages sent over a peer's queue for a specific p2p Channel. PeerQueueMsgSize metrics.Gauge `metrics_labels:"ch_id" metric_name:"router_channel_queue_msg_size"` }