From 528cc5ad34d2bcf23020daa675294f739784b731 Mon Sep 17 00:00:00 2001
From: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
Date: Fri, 3 Feb 2023 10:06:21 +0200
Subject: [PATCH] chore: add better e2 trace logging for relay (#1526)

---
 waku/v2/node/waku_node.nim | 13 ++++++++++---
 waku/v2/utils/time.nim     | 15 +++++++++------
 2 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/waku/v2/node/waku_node.nim b/waku/v2/node/waku_node.nim
index 7db205b38..0e91cac7c 100644
--- a/waku/v2/node/waku_node.nim
+++ b/waku/v2/node/waku_node.nim
@@ -38,6 +38,7 @@ import
   ../protocol/waku_peer_exchange,
   ../utils/peers,
   ../utils/wakuenr,
+  ../utils/time,
   ./peer_manager/peer_manager,
   ./dnsdisc/waku_dnsdisc,
   ./discv5/waku_discv5,
@@ -300,13 +301,16 @@ proc subscribe(node: WakuNode, topic: PubsubTopic, handler: Option[TopicHandler]
 
   proc defaultHandler(topic: string, data: seq[byte]) {.async, gcsafe.} =
     # A default handler should be registered for all topics
-    trace "Hit default handler", topic=topic, data=data
 
     let msg = WakuMessage.decode(data)
     if msg.isErr():
       # TODO: Add metric to track waku message decode errors
       return
 
+    trace "waku.relay received",
+      pubsubTopic=topic,
+      hash=MultiHash.digest("sha2-256", data).expect("valid hash").data.buffer.to0xHex(), # TODO: this could be replaced by a message UID
+      receivedTime=getNowInNanosecondTime()
 
     # Notify mounted protocols of new message
     if not node.wakuFilter.isNil():
@@ -371,10 +375,13 @@ proc publish*(node: WakuNode, topic: PubsubTopic, message: WakuMessage) {.async,
     # TODO: Improve error handling
     return
 
-  trace "publish", topic=topic, contentTopic=message.contentTopic
-
   discard await node.wakuRelay.publish(topic, message)
 
+  trace "waku.relay published",
+    pubsubTopic=topic,
+    hash=MultiHash.digest("sha2-256", message.encode().buffer).expect("valid hash").data.buffer.to0xHex(), # TODO: this could be replaced by a message UID
+    publishTime=getNowInNanosecondTime()
+
 proc startRelay*(node: WakuNode) {.async.} =
   ## Setup and start relay protocol
   info "starting relay protocol"
diff --git a/waku/v2/utils/time.nim b/waku/v2/utils/time.nim
index 693938fd5..915d619ed 100644
--- a/waku/v2/utils/time.nim
+++ b/waku/v2/utils/time.nim
@@ -4,27 +4,30 @@ when (NimMajor, NimMinor) < (1, 4):
 else:
   {.push raises: [].}
 
-import 
+import
   std/times,
   metrics
 
-type Timestamp* = int64 
+type Timestamp* = int64
 
-proc getNanosecondTime*[T](timeInSeconds: T): Timestamp = 
+proc getNanosecondTime*[T](timeInSeconds: T): Timestamp =
   var ns = Timestamp(timeInSeconds.int64 * 1000_000_000.int64)
   return ns
 
-proc getMicrosecondTime*[T](timeInSeconds: T): Timestamp = 
+proc getMicrosecondTime*[T](timeInSeconds: T): Timestamp =
   var us = Timestamp(timeInSeconds.int64 * 1000_000.int64)
   return us
 
-proc getMillisecondTime*[T](timeInSeconds: T): Timestamp = 
+proc getMillisecondTime*[T](timeInSeconds: T): Timestamp =
   var ms = Timestamp(timeInSeconds.int64 * 1000.int64)
   return ms
 
 proc nowInUnixFloat(): float =
   return getTime().toUnixFloat()
 
+proc getNowInNanosecondTime*(): Timestamp =
+  return getNanosecondTime(nowInUnixFloat())
+
 template nanosecondTime*(collector: Summary | Histogram, body: untyped) =
   when defined(metrics):
     let start = nowInUnixFloat()
@@ -39,4 +42,4 @@ template nanosecondTime*(collector: Gauge, body: untyped) =
     body
     metrics.set(collector, nowInUnixFloat() - start)
   else:
-    body
\ No newline at end of file
+    body