Instrumented Data

Instrumented Data notes

WARNING: This doc is outdated and needs to be updated.

TODO: Provide context here.

TODO: decide if to use this page to describe reported events as well

This page describes how we instrument and expose insightful data from the Spacemesh node in tests and over time.

Quick introduction to metrics

Collecting metrics in a time series database will help us see how processes work together and how they affect each other. (e.g: number of connected peers to number of goroutines)

Note: this page is a work in progress, new metrics and metric type will be added in the future.

Metric Types

Counter - A counter is a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart. For example, you can use a counter to represent the number of requests served, tasks completed, or errors.

Gauge - A gauge is a metric that represents a single numerical value that can arbitrarily go up and down. Gauges are typically used for measured values like temperatures or current memory usage, but also "counts" that can go up and down, like the number of concurrent requests.

..TBD

P2P

OutboundPeers - Gauge (prometheus: peers, type: outbound) The number of peers we have live outbound connection with.

InboundPeers - Gauge (prometheus: peers, type: inbound) The number of peers we have live inbound connection with.

PeerRecv - Counter (prometheus: peer_recv_bytes_total) The number of bytes recieved from a peer. (per peer)

PeerSend - Counter (prometheus: peer_send_bytes_total) The number of bytes sent to a peer. (per peer)

NewGossipMessage - Counter (prometheus: total_gossip_message, message_type: new) The number of new gossip messages we have seen.

OldGossipMessages - Counter (prometheus: total_gossip_message, message_type: old) The number of old (duplicate) gossip messages we have seen.

InvalidGossipMessages - Counter (prometheus: total_gossip_message, message_type: invalid) The number of invalid gossip messages we have seen.