Add metrics for peermanager scores (#158)

* Add metrics for peermanager scores * fix tests
sei-protocol · Oct 4, 2023 · bf1224d · bf1224d
1 parent 51802ea
commit bf1224d
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 69 deletions.
diff --git a/internal/p2p/metrics.gen.go b/internal/p2p/metrics.gen.go
diff --git a/internal/p2p/metrics.go b/internal/p2p/metrics.go
@@ -28,6 +28,8 @@ var (
 type Metrics struct {
 	// Number of peers.
 	Peers metrics.Gauge
+	// Score for each peer
+	PeerScore metrics.Gauge `metrics_labels:"peer_id"`
 	// Number of bytes per channel received from a given peer.
 	PeerReceiveBytesTotal metrics.Counter `metrics_labels:"peer_id, chID, message_type"`
 	// Number of bytes per channel sent to a given peer.

diff --git a/internal/p2p/p2ptest/network.go b/internal/p2p/p2ptest/network.go
@@ -263,7 +263,7 @@ func (n *Network) MakeNode(ctx context.Context, t *testing.T, opts NodeOptions)
 		RetryTimeJitter: time.Millisecond,
 		MaxPeers:        opts.MaxPeers,
 		MaxConnected:    opts.MaxConnected,
-	})
+	}, p2p.NopMetrics())
 	require.NoError(t, err)
 
 	router, err := p2p.NewRouter(

diff --git a/internal/p2p/peermanager.go b/internal/p2p/peermanager.go
@@ -300,6 +300,7 @@ type PeerManager struct {
 	ready         map[types.NodeID]bool         // ready peers (Ready → Disconnected)
 	evict         map[types.NodeID]bool         // peers scheduled for eviction (Connected → EvictNext)
 	evicting      map[types.NodeID]bool         // peers being evicted (EvictNext → Disconnected)
+	metrics       *Metrics
 }
 
 // NewPeerManager creates a new peer manager.
@@ -308,6 +309,7 @@ func NewPeerManager(
 	selfID types.NodeID,
 	peerDB dbm.DB,
 	options PeerManagerOptions,
+	metrics *Metrics,
 ) (*PeerManager, error) {
 	if selfID == "" {
 		return nil, errors.New("self ID not given")
@@ -339,6 +341,7 @@ func NewPeerManager(
 		evict:         map[types.NodeID]bool{},
 		evicting:      map[types.NodeID]bool{},
 		subscriptions: map[*PeerUpdates]*PeerUpdates{},
+		metrics:       metrics,
 	}
 	if err = peerManager.configurePeers(); err != nil {
 		return nil, err
@@ -873,6 +876,7 @@ func (m *PeerManager) Advertise(peerID types.NodeID, limit uint16) []NodeAddress
 	}
 
 	for _, peer := range m.store.Ranked() {
+		m.metrics.PeerScore.With("peer_id", string(peerID)).Set(float64(int(peer.Score())))
 		if peer.ID == peerID {
 			continue
 		}

diff --git a/internal/p2p/peermanager_scoring_test.go b/internal/p2p/peermanager_scoring_test.go
@@ -21,7 +21,7 @@ func TestPeerScoring(t *testing.T) {
 
 	// create a mock peer manager
 	db := dbm.NewMemDB()
-	peerManager, err := NewPeerManager(log.NewNopLogger(), selfID, db, PeerManagerOptions{})
+	peerManager, err := NewPeerManager(log.NewNopLogger(), selfID, db, PeerManagerOptions{}, NopMetrics())
 	require.NoError(t, err)
 
 	// create a fake node