feat: track libp2p dial error (#7712)

**Motivation**

- to know the reason why we cannot dial a peer. In `peerdas-devnet-6` it
happens a lot cc @matthewkeil

**Description**

- model all possible libp2p errors
- do not dial a peer if it has no multiaddr, this follows up #7708
- new metric `notDialReason` in Discovery which I bring from `peerDAS`
branch

**Testing**
This is how it showed for `peerdas-devnet-6`

<img width="1540" alt="Screenshot 2025-04-17 at 13 16 09"
src="https://github.com/user-attachments/assets/5fca773c-3ba6-42e3-a41e-be963d25d774"
/>

Co-authored-by: Tuyen Nguyen <twoeths@users.noreply.github.com>

Author: twoeths

packages/beacon-node/src/network/core/metrics.ts

@@ -1,7 +1,8 @@
 import {SubnetID} from "@lodestar/types";
 import {RegistryMetricCreator} from "../../metrics/utils/registryMetricCreator.js";
+import {Libp2pError} from "../libp2p/error.js";
 import {SubnetType} from "../metadata.js";
-import {DiscoveredPeerStatus} from "../peers/discover.js";
+import {DiscoveredPeerStatus, NotDialReason} from "../peers/discover.js";
 import {SubnetSource} from "../subnets/attnetsService.js";
 
 export type NetworkCoreMetrics = ReturnType<typeof createNetworkCoreMetrics>;
@@ -159,12 +160,22 @@ export function createNetworkCoreMetrics(register: RegistryMetricCreator) {
         name: "lodestar_discovery_total_dial_attempts",
         help: "Total dial attempts by peer discovery",
       }),
+      notDialReason: register.gauge<{reason: NotDialReason}>({
+        name: "lodestar_discovery_not_dial_reason_total_count",
+        help: "Total count of not dial reasons",
+        labelNames: ["reason"],
+      }),
       dialTime: register.histogram<{status: string}>({
         name: "lodestar_discovery_dial_time_seconds",
         help: "Time to dial peers in seconds",
         labelNames: ["status"],
         buckets: [0.1, 5, 60],
       }),
+      dialError: register.gauge<{reason: Libp2pError}>({
+        name: "lodestar_discovery_dial_error_total_count",
+        help: "Total count of dial errors",
+        labelNames: ["reason"],
+      }),
     },
 
     reqResp: {

packages/beacon-node/src/network/libp2p/error.ts

@@ -0,0 +1,55 @@
+export enum Libp2pError {
+  // https://github.com/libp2p/js-libp2p/blob/b936324a92038d9447983bb11db623c1b5a17a76/packages/libp2p/src/errors.ts#L6
+  MissingServiceError = "MissingServiceError",
+  UnmetServiceDependenciesError = "UnmetServiceDependenciesError",
+  NoContentRoutersError = "NoContentRoutersError",
+  NoPeerRoutersError = "NoPeerRoutersError",
+  QueriedForSelfError = "QueriedForSelfError",
+  UnhandledProtocolError = "UnhandledProtocolError",
+  DuplicateProtocolHandlerError = "DuplicateProtocolHandlerError",
+  DialDeniedError = "DialDeniedError",
+  UnsupportedListenAddressError = "UnsupportedListenAddressError",
+  UnsupportedListenAddressesError = "UnsupportedListenAddressesError",
+  NoValidAddressesError = "NoValidAddressesError",
+  ConnectionInterceptedError = "ConnectionInterceptedError",
+  ConnectionDeniedError = "ConnectionDeniedError",
+  MuxerUnavailableError = "MuxerUnavailableError",
+  EncryptionFailedError = "EncryptionFailedError",
+  TransportUnavailableError = "TransportUnavailableError",
+  // https://github.com/libp2p/js-libp2p/blob/b936324a92038d9447983bb11db623c1b5a17a76/packages/interface/src/errors.ts#L6
+  AbortError = "AbortError",
+  UnexpectedPeerError = "UnexpectedPeerError",
+  InvalidCryptoExchangeError = "InvalidCryptoExchangeError",
+  InvalidParametersError = "InvalidParametersError",
+  InvalidPublicKeyError = "InvalidPublicKeyError",
+  InvalidPrivateKeyError = "InvalidPrivateKeyError",
+  UnsupportedOperationError = "UnsupportedOperationError",
+  ConnectionClosingError = "ConnectionClosingError",
+  ConnectionClosedError = "ConnectionClosedError",
+  ConnectionFailedError = "ConnectionFailedError",
+  MuxerClosedError = "MuxerClosedError",
+  StreamResetError = "StreamResetError",
+  StreamStateError = "StreamStateError",
+  NotFoundError = "NotFoundError",
+  InvalidPeerIdError = "InvalidPeerIdError",
+  InvalidMultiaddrError = "InvalidMultiaddrError",
+  InvalidCidError = "InvalidCIDError",
+  InvalidMultihashError = "InvalidMultihashError",
+  UnsupportedProtocolError = "UnsupportedProtocolError",
+  InvalidMessageError = "InvalidMessageError",
+  ProtocolError = "ProtocolError",
+  TimeoutError = "TimeoutError",
+  NotStartedError = "NotStartedError",
+  AlreadyStartedError = "AlreadyStartedError",
+  DialError = "DialError",
+  ListenError = "ListenError",
+  LimitedConnectionError = "LimitedConnectionError",
+  TooManyInboundProtocolStreamsError = "TooManyInboundProtocolStreamsError",
+  TooManyOutboundProtocolStreamsError = "TooManyOutboundProtocolStreamsError",
+  UnsupportedKeyTypeError = "UnsupportedKeyTypeError",
+  OtherError = "OtherError",
+}
+
+export function getLibp2pError(error: Error): Libp2pError {
+  return Libp2pError[(error as unknown as {name: string}).name as keyof typeof Libp2pError] ?? Libp2pError.OtherError;
+}

packages/beacon-node/src/network/peers/discover.ts

@@ -10,6 +10,7 @@ import {NetworkCoreMetrics} from "../core/metrics.js";
 import {Discv5Worker} from "../discv5/index.js";
 import {LodestarDiscv5Opts} from "../discv5/types.js";
 import {Libp2p} from "../interface.js";
+import {getLibp2pError} from "../libp2p/error.js";
 import {ENRKey, SubnetType} from "../metadata.js";
 import {getConnectionsMap, prettyPrintPeerId} from "../util.js";
 import {IPeerRpcScoreStore, ScoreState} from "./score/index.js";
@@ -55,6 +56,12 @@ export enum DiscoveredPeerStatus {
   no_multiaddrs = "no_multiaddrs",
 }
 
+export enum NotDialReason {
+  not_contain_requested_sampling_groups = "not_contain_requested_sampling_groups",
+  not_contain_requested_attnet_syncnet_subnets = "not_contain_requested_attnet_syncnet_subnets",
+  no_multiaddrs = "no_multiaddrs",
+}
+
 type UnixMs = number;
 /**
  * Maintain peersToConnect to avoid having too many topic peers at some point.
@@ -448,7 +455,11 @@ export class PeerDiscovery {
 
     // Must add the multiaddrs array to the address book before dialing
     // https://github.com/libp2p/js-libp2p/blob/aec8e3d3bb1b245051b60c2a890550d262d5b062/src/index.js#L638
-    await this.libp2p.peerStore.merge(peerId, {multiaddrs: [multiaddrTCP]});
+    const peer = await this.libp2p.peerStore.merge(peerId, {multiaddrs: [multiaddrTCP]});
+    if (peer.addresses.length === 0) {
+      this.metrics?.discovery.notDialReason.inc({reason: NotDialReason.no_multiaddrs});
+      return;
+    }
 
     // Note: PeerDiscovery adds the multiaddrTCP beforehand
     const peerIdShort = prettyPrintPeerId(peerId);
@@ -466,6 +477,7 @@ export class PeerDiscovery {
     } catch (e) {
       timer?.({status: "error"});
       formatLibp2pDialError(e as Error);
+      this.metrics?.discovery.dialError.inc({reason: getLibp2pError(e as Error)});
       this.logger.debug("Error dialing discovered peer", {peer: peerIdShort}, e as Error);
     }
   }