Add metrics to show number of peers by client (#3571)

ChainSafe · Jan 5, 2022 · 659e3e1 · 659e3e1
1 parent c384b36
commit 659e3e1
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/packages/lodestar/src/metrics/metrics/lodestar.ts b/packages/lodestar/src/metrics/metrics/lodestar.ts
@@ -44,6 +44,11 @@ export function createLodestarMetrics(
       help: "number of peers, labeled by direction",
       labelNames: ["direction"],
     }),
+    peersByClient: register.gauge<"client">({
+      name: "lodestar_peers_by_client_count",
+      help: "number of peers, labeled by client",
+      labelNames: ["client"],
+    }),
     peersSync: register.gauge({
       name: "lodestar_peers_sync_count",
       help: "Current count of peers useful for sync",

diff --git a/packages/lodestar/src/network/peers/peerManager.ts b/packages/lodestar/src/network/peers/peerManager.ts
@@ -9,7 +9,7 @@ import {GoodByeReasonCode, GOODBYE_KNOWN_CODES, Libp2pEvent} from "../../constan
 import {IMetrics} from "../../metrics";
 import {NetworkEvent, INetworkEventBus} from "../events";
 import {IReqResp, ReqRespMethod, RequestTypedContainer} from "../reqresp";
-import {prettyPrintPeerId} from "../util";
+import {prettyPrintPeerId, getClientFromPeerStore} from "../util";
 import {ISubnetsService} from "../subnets";
 import {Libp2pPeerMetadataStore} from "./metastore";
 import {PeerDiscovery, SubnetDiscvQueryMs} from "./discover";
@@ -519,11 +519,14 @@ export class PeerManager {
   private runPeerCountMetrics(metrics: IMetrics): void {
     let total = 0;
     const peersByDirection = new Map<string, number>();
+    const peersByClient = new Map<string, number>();
     for (const connections of this.libp2p.connectionManager.connections.values()) {
       const openCnx = connections.find((cnx) => cnx.stat.status === "open");
       if (openCnx) {
         const direction = openCnx.stat.direction;
         peersByDirection.set(direction, 1 + (peersByDirection.get(direction) ?? 0));
+        const client = getClientFromPeerStore(openCnx.remotePeer, this.libp2p.peerStore.metadataBook);
+        peersByClient.set(client, 1 + (peersByClient.get(client) ?? 0));
         total++;
       }
     }
@@ -532,6 +535,10 @@ export class PeerManager {
       metrics.peersByDirection.set({direction}, peers);
     }
 
+    for (const [client, peers] of peersByClient.entries()) {
+      metrics.peersByClient.set({client}, peers);
+    }
+
     let syncPeers = 0;
     for (const peer of this.connectedPeers.values()) {
       if (peer.relevantStatus === RelevantPeerStatus.relevant) {