metric: measure uTP packets and talkReq

Author: ScottyPoi

packages/portalnetwork/src/client/client.ts

@@ -400,23 +400,30 @@ export class PortalNetwork extends (EventEmitter as { new (): PortalNetworkEvent
 
   private onTalkReq = async (src: INodeAddress, sourceId: ENR | null, message: ITalkReqMessage) => {
     this.metrics?.totalBytesReceived.inc(message.request.length)
+    const network = this.networks.get(bytesToHex(message.protocol) as NetworkId)
+
     if (bytesToHex(message.protocol) === NetworkId.UTPNetwork) {
       await this.handleUTP(src, src.nodeId, message, message.request)
       return
     }
-    const network = this.networks.get(bytesToHex(message.protocol) as NetworkId)
     if (!network) {
       this.logger(`Received TALKREQ message on unsupported network ${bytesToHex(message.protocol)}`)
       await this.sendPortalNetworkResponse(src, message.id, new Uint8Array())
-
       return
     }
 
+    if (this.metrics) {
+      const metric = (NetworkNames[bytesToHex(message.protocol) as NetworkId] +
+        '_talkReqReceived') as keyof PortalNetworkMetrics
+      this.metrics[metric].inc()
+    }
     await network.handle(message, src)
   }
 
   private onTalkResp = (src: INodeAddress, sourceId: ENR | null, message: ITalkRespMessage) => {
-    this.metrics?.totalBytesReceived.inc(message.response.length)
+    if (this.metrics) {
+      this.metrics?.totalBytesReceived.inc(message.response.length)
+    }
   }
 
   /**

packages/portalnetwork/src/networks/network.ts

@@ -116,17 +116,13 @@ export abstract class BaseNetwork extends EventEmitter {
     utpMessage?: boolean,
   ): Promise<Uint8Array> {
     if (this.portal.metrics) {
-      const metric = (this.networkName + '_talkRequestsSent') as keyof PortalNetworkMetrics
+      const metric = (this.networkName + '_talkReqSent') as keyof PortalNetworkMetrics
       this.portal.metrics[metric].inc()
     }
     return this.portal.sendPortalNetworkMessage(enr, payload, networkId, utpMessage)
   }
 
   sendResponse(src: INodeAddress, requestId: bigint, payload: Uint8Array): Promise<void> {
-    if (this.portal.metrics) {
-      const metric = (this.networkName + '_talkResponsesSent') as keyof PortalNetworkMetrics
-      this.portal.metrics[metric].inc()
-    }
     return this.portal.sendPortalNetworkResponse(src, requestId, payload)
   }
   findEnr(nodeId: string): ENR | undefined {

packages/portalnetwork/src/util/metrics.ts

@@ -60,21 +60,26 @@ const ultralightMetrics = [
     help: 'how many MBs are currently stored in the db',
   },
   {
-    name: 'talkRequestsSent',
+    name: 'talkReqSent',
     metric: MetricType.Counter,
     help: 'how many talk requests have been sent',
   },
   {
-    name: 'talkResponsesReceived',
+    name: 'talkReqReceived',
     metric: MetricType.Counter,
-    help: 'how many talk responses have been sent',
+    help: 'how many talk requests have been received',
+  },
+  {
+    name: 'utpPacketsReceived',
+    metric: MetricType.Counter,
+    help: 'how many UTP packets have been received',
   },
 ]
 
 export const setupMetrics = (
   networks: NetworkId[] = [NetworkId.HistoryNetwork],
 ): PortalNetworkMetrics => {
-  const metrics = createMetrics(ultralightMetrics, networks)
+  const metrics = createMetrics(ultralightMetrics, [...networks, NetworkId.UTPNetwork])
   return {
     ...metrics,
     totalContentLookups: new Gauge<string>({

packages/portalnetwork/src/wire/utp/PortalNetworkUtp/index.ts

@@ -1,4 +1,5 @@
 import {
+  NetworkNames,
   RequestCode,
   UtpSocketType,
   createContentRequest,
@@ -12,6 +13,7 @@ import type {
   INewRequest,
   NetworkId,
   PortalNetwork,
+  PortalNetworkMetrics,
   UtpSocketKey,
 } from '../../../index.js'
 import type { SocketType } from '../Socket/index.js'
@@ -131,6 +133,15 @@ export class PortalNetworkUTP {
       this.logger(`No open request for ${srcId} with connectionId ${packetBuffer.readUint16BE(2)}`)
       return
     }
+    if (this.client.metrics) {
+      const metric = (NetworkNames[request.network.networkId] +
+        '_talkReqReceived') as keyof PortalNetworkMetrics
+      this.client.metrics[metric].inc()
+
+      const utpMetric = (NetworkNames[request.network.networkId] +
+        '_utpPacketsReceived') as keyof PortalNetworkMetrics
+      this.client.metrics[utpMetric].inc()
+    }
     await request.handleUtpPacket(packetBuffer)
   }