From 223c216fab8409a8fd86b43e8491f80bc22cdc0d Mon Sep 17 00:00:00 2001
From: Jacek Sieka <jacek@status.im>
Date: Wed, 5 Jun 2024 23:55:19 +0200
Subject: [PATCH] import: add csv debug option

This new option saves a CSV to disk while performing `import` such that
the performance of one import can be compared with the other.

This early version is likely to change in the future
---
 nimbus/config.nim        |  5 ++++
 nimbus/nimbus_import.nim | 54 +++++++++++++++++++++++++++++++++-------
 2 files changed, 50 insertions(+), 9 deletions(-)

diff --git a/nimbus/config.nim b/nimbus/config.nim
index 8197053304..c4e07c7b04 100644
--- a/nimbus/config.nim
+++ b/nimbus/config.nim
@@ -520,6 +520,11 @@ type
         defaultValue: 8192
         name: "chunk-size" .}: uint64
 
+      csvStats* {.
+        hidden
+        desc: "Save performance statistics to CSV"
+        name: "debug-csv-stats".}: Option[string]
+
 func parseCmdArg(T: type NetworkId, p: string): T
     {.gcsafe, raises: [ValueError].} =
   parseInt(p).T
diff --git a/nimbus/nimbus_import.nim b/nimbus/nimbus_import.nim
index 517c93dd20..169098ee7f 100644
--- a/nimbus/nimbus_import.nim
+++ b/nimbus/nimbus_import.nim
@@ -12,7 +12,7 @@
 import
   chronicles,
   chronos/timer,
-  std/strformat,
+  std/[strformat, strutils],
   stew/io2,
   ./config,
   ./common/common,
@@ -35,7 +35,8 @@ func shortLog(a: timer.Duration, parts = int.high): string {.inline.} =
       res.add(n)
       v = v mod T.nanoseconds()
       dec parts
-      if v == 0 or parts <= 0: return res
+      if v == 0 or parts <= 0:
+        return res
 
   f("w", Week)
   f("d", Day)
@@ -58,11 +59,12 @@ proc importBlocks*(conf: NimbusConf, com: CommonRef) =
   setControlCHook(controlCHandler)
 
   let
-    start = try:
-      com.db.getSavedStateBlockNumber().truncate(uint64) + 1
-    except RlpError as exc:
-      error "Could not read block number", err = exc.msg
-      quit(QuitFailure)
+    start =
+      try:
+        com.db.getSavedStateBlockNumber().truncate(uint64) + 1
+      except RlpError as exc:
+        error "Could not read block number", err = exc.msg
+        quit(QuitFailure)
 
     chain = com.newChain()
 
@@ -71,6 +73,23 @@ proc importBlocks*(conf: NimbusConf, com: CommonRef) =
     gas = 0.u256
     txs = 0
     time0 = Moment.now()
+    csv =
+      if conf.csvStats.isSome:
+        try:
+          let f = open(conf.csvStats.get(), fmAppend)
+          if f.getFileSize() == 0:
+            f.writeLine("block_number,blocks,txs,gas,time")
+          f
+        except IOError as exc:
+          error "Could not open statistics output file",
+            file = conf.csvStats, err = exc.msg
+          quit(QuitFailure)
+      else:
+        File(nil)
+  defer:
+    if csv != nil:
+      close(csv)
+
   template blockNumber(): uint64 =
     start + imported
 
@@ -110,7 +129,6 @@ proc importBlocks*(conf: NimbusConf, com: CommonRef) =
           diff1 = (time2 - time1).nanoseconds().float / 1000000000
           diff0 = (time2 - time0).nanoseconds().float / 1000000000
 
-        # TODO generate csv with import statistics
         info "Imported blocks",
           blockNumber,
           blocks = imported,
@@ -122,7 +140,25 @@ proc importBlocks*(conf: NimbusConf, com: CommonRef) =
           avgBps = f(imported.float / diff0),
           avgTps = f(txs.float / diff0),
           avgGps = f(gas.truncate(uint64).float / diff0), # TODO fix truncate
-          elapsed = shortLog(time2-time0, 3)
+          elapsed = shortLog(time2 - time0, 3)
+
+        if csv != nil:
+          # In the CSV, we store a line for every chunk of blocks processed so
+          # that the file can meaningfully be appended to when restarting the
+          # process - this way, each sample is independent
+          try:
+            csv.writeLine(
+              [
+                $blockNumber,
+                $headers.len,
+                $statsRes[].txs,
+                $statsRes[].gas,
+                $(time2 - time1).nanoseconds(),
+              ].join(",")
+            )
+            csv.flushFile()
+          except IOError as exc:
+            warn "Could not write csv", err = exc.msg
         headers.setLen(0)
         bodies.setLen(0)