feat: track time to publish a message (#451)

* feat: track time to publish a message * fix: add topic label to metric * fix: add more buckets
ChainSafe · Jul 20, 2023 · 83b8e61 · 83b8e61
1 parent 89c82f6
commit 83b8e61
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -2043,6 +2043,7 @@ export class GossipSub extends EventEmitter<GossipsubEvents> implements PubSub<G
    * For messages not from us, this class uses `forwardMessage`.
    */
   async publish(topic: TopicStr, data: Uint8Array, opts?: PublishOpts): Promise<PublishResult> {
+    const startMs = Date.now()
     const transformedData = this.dataTransform ? this.dataTransform.outboundTransform(topic, data) : data
 
     if (this.publishConfig == null) {
@@ -2099,7 +2100,14 @@ export class GossipSub extends EventEmitter<GossipsubEvents> implements PubSub<G
       }
     }
 
-    this.metrics?.onPublishMsg(topic, tosendCount, tosend.size, rawMsg.data != null ? rawMsg.data.length : 0)
+    const durationMs = Date.now() - startMs
+    this.metrics?.onPublishMsg(
+      topic,
+      tosendCount,
+      tosend.size,
+      rawMsg.data != null ? rawMsg.data.length : 0,
+      durationMs
+    )
 
     // Dispatch the message to the user if we are subscribed to the topic
     if (willSendToSelf) {

diff --git a/src/metrics.ts b/src/metrics.ts
@@ -338,6 +338,13 @@ export function getMetrics(
       help: 'Total count of msg publish data.length bytes',
       labelNames: ['topic']
     }),
+    /** Total time in millisecond to publish a message */
+    msgPublishMs: register.histogram<{ topic: TopicLabel }>({
+      name: 'gossipsub_msg_publish_ms',
+      help: 'Total time in millisecond to publish a message',
+      buckets: [1, 2, 5, 10, 100, 500, 1000],
+      labelNames: ['topic']
+    }),
 
     /** Total count of msg forwarded by topic */
     msgForwardCount: register.gauge<{ topic: TopicLabel }>({
@@ -683,7 +690,13 @@ export function getMetrics(
       this.msgForwardPeers.inc({ topic }, tosendCount)
     },
 
-    onPublishMsg(topicStr: TopicStr, tosendGroupCount: ToSendGroupCount, tosendCount: number, dataLen: number): void {
+    onPublishMsg(
+      topicStr: TopicStr,
+      tosendGroupCount: ToSendGroupCount,
+      tosendCount: number,
+      dataLen: number,
+      ms: number
+    ): void {
       const topic = this.toTopic(topicStr)
       this.msgPublishCount.inc({ topic }, 1)
       this.msgPublishBytes.inc({ topic }, tosendCount * dataLen)
@@ -692,6 +705,7 @@ export function getMetrics(
       this.msgPublishPeersByGroup.inc({ peerGroup: 'floodsub' }, tosendGroupCount.floodsub)
       this.msgPublishPeersByGroup.inc({ peerGroup: 'mesh' }, tosendGroupCount.mesh)
       this.msgPublishPeersByGroup.inc({ peerGroup: 'fanout' }, tosendGroupCount.fanout)
+      this.msgPublishMs.observe({ topic }, ms)
     },
 
     onMsgRecvPreValidation(topicStr: TopicStr): void {