chronicles: bump and logging updates (#7319)

* chronicles: bump and logging updates

* formatting uses `formatIt` also for object fields
* respect [`NO_COLOR`](https://no-color.org/)
* less memory allocation per log statement
* outputs fully disabled when not used (instead of being formatted and
then discarded)
* directly produce nocolored output instead of coloring then filtering

* bump

* oops

* oops

* better

* bump

* move nooutput back

* move nooutput back

* move import

* setup logging before file limits

* bump

Author: arnetheduck

beacon_chain/nimbus_beacon_node.nim.cfg

@@ -1,6 +1,6 @@
 -d:"chronicles_sinks=textlines[dynamic],json[dynamic]"
 -d:"chronicles_runtime_filtering=on"
--d:"chronicles_disable_thread_id"
+-d:"chronicles_thread_ids=no"
 
 @if release:
   -d:"chronicles_line_numbers:0"

beacon_chain/nimbus_binary_common.nim

@@ -11,7 +11,7 @@
 
 import
   # Standard library
-  std/[tables, strutils, terminal, typetraits],
+  std/[os, tables, strutils, terminal, typetraits],
 
   # Nimble packages
   chronos, confutils, presto, toml_serialization, metrics,
@@ -38,45 +38,7 @@ export
 
 type
   SlotStartProc*[T] = proc(node: T, wallTime: BeaconTime,
-                           lastSlot: Slot): Future[bool] {.gcsafe,
-  raises: [].}
-
-# silly chronicles, colors is a compile-time property
-when defaultChroniclesStream.outputs.type.arity == 2:
-  func stripAnsi(v: string): string =
-    var
-      res = newStringOfCap(v.len)
-      i: int
-
-    while i < v.len:
-      let c = v[i]
-      if c == '\x1b':
-        var
-          x = i + 1
-          found = false
-
-        while x < v.len: # look for [..m
-          let c2 = v[x]
-          if x == i + 1:
-            if c2 != '[':
-              break
-          else:
-            if c2 in {'0'..'9'} + {';'}:
-              discard # keep looking
-            elif c2 == 'm':
-              i = x + 1
-              found = true
-              break
-            else:
-              break
-          inc x
-
-        if found: # skip adding c
-          continue
-      res.add c
-      inc i
-
-    res
+                           lastSlot: Slot): Future[bool] {.gcsafe, raises: [].}
 
 proc updateLogLevel*(logLevel: string) {.raises: [ValueError].} =
   # Updates log levels (without clearing old ones)
@@ -93,7 +55,7 @@ proc updateLogLevel*(logLevel: string) {.raises: [ValueError].} =
 
 proc detectTTY*(stdoutKind: StdoutLogKind): StdoutLogKind =
   if stdoutKind == StdoutLogKind.Auto:
-    if isatty(stdout):
+    if getEnv("NO_COLOR").len == 0 and isatty(stdout):
       # On a TTY, let's be fancy
       StdoutLogKind.Colors
     else:
@@ -108,6 +70,8 @@ when defaultChroniclesStream.outputs.type.arity == 2:
   from std/os import splitFile
   from "."/filepath import secureCreatePath
 
+  import stew/staticfor
+
 proc setupFileLimits*() =
   when not defined(windows):
     # In addition to databases and sockets, we need a file descriptor for every
@@ -129,9 +93,6 @@ proc setupLogging*(
   when defaultChroniclesStream.outputs.type.arity != 2:
     warn "Logging configuration options not enabled in the current build"
   else:
-    # Naive approach where chronicles will form a string and we will discard
-    # it, even if it could have skipped the formatting phase
-
     proc noOutput(logLevel: LogLevel, msg: LogOutputStr) = discard
     proc writeAndFlush(f: File, msg: LogOutputStr) =
       try:
@@ -143,9 +104,6 @@ proc setupLogging*(
     proc stdoutFlush(logLevel: LogLevel, msg: LogOutputStr) =
       writeAndFlush(stdout, msg)
 
-    proc noColorsFlush(logLevel: LogLevel, msg: LogOutputStr) =
-      writeAndFlush(stdout, stripAnsi(msg))
-
     let fileWriter =
       if logFile.isSome():
         let
@@ -171,14 +129,15 @@ proc setupLogging*(
 
     defaultChroniclesStream.outputs[1].writer = fileWriter
 
-    let tmp = detectTTY(stdoutKind)
-
-    case tmp
-    of StdoutLogKind.Auto: raiseAssert "checked above"
+    case detectTTY(stdoutKind)
+    of StdoutLogKind.Auto:
+      raiseAssert "Auto-detection done in detectTTY"
     of StdoutLogKind.Colors:
       defaultChroniclesStream.outputs[0].writer = stdoutFlush
+      defaultChroniclesStream.outputs[0].colors = true
     of StdoutLogKind.NoColors:
-      defaultChroniclesStream.outputs[0].writer = noColorsFlush
+      defaultChroniclesStream.outputs[0].writer = stdoutFlush
+      defaultChroniclesStream.outputs[0].colors = false
     of StdoutLogKind.Json:
       defaultChroniclesStream.outputs[0].writer = noOutput
 
@@ -190,6 +149,9 @@ proc setupLogging*(
     of StdoutLogKind.None:
      defaultChroniclesStream.outputs[0].writer = noOutput
 
+    staticFor i, 0..<defaultChroniclesStream.outputs.type.arity:
+      setLogEnabled(defaultChroniclesStream.outputs[i].writer != noOutput, i)
+
     if logFile.isSome():
       warn "The --log-file option is deprecated. Consider redirecting the standard output to a file instead"
   try:

beacon_chain/nimbus_light_client.nim.cfg

@@ -1,6 +1,6 @@
 -d:"chronicles_sinks=textlines[dynamic],json[dynamic]"
 -d:"chronicles_runtime_filtering=on"
--d:"chronicles_disable_thread_id"
+-d:"chronicles_thread_ids=no"
 
 @if release:
   -d:"chronicles_line_numbers:0"

beacon_chain/nimbus_signing_node.nim.cfg

@@ -1,6 +1,6 @@
 -d:"chronicles_sinks=textlines[dynamic],json[dynamic]"
 -d:"chronicles_runtime_filtering=on"
--d:"chronicles_disable_thread_id"
+-d:"chronicles_thread_ids=no"
 
 @if release:
   -d:"chronicles_line_numbers:0"

beacon_chain/nimbus_validator_client.nim

@@ -571,6 +571,6 @@ programMain:
     # and avoid using system resources (such as urandom) after that
     rng = HmacDrbgContext.new()
 
-  setupFileLimits()
   setupLogging(config.logLevel, config.logStdout, config.logFile)
+  setupFileLimits()
   waitFor runValidatorClient(config, rng)

beacon_chain/nimbus_validator_client.nim.cfg

@@ -1,6 +1,6 @@
 -d:"chronicles_sinks=textlines[dynamic],json[dynamic]"
 -d:"chronicles_runtime_filtering=on"
--d:"chronicles_disable_thread_id"
+-d:"chronicles_thread_ids=no"
 
 @if release:
   -d:"chronicles_line_numbers:0"

benchmarks/rest_api_benchmark.nim.cfg

@@ -1,2 +1,2 @@
 -d:"chronicles_runtime_filtering=on"
--d:"chronicles_disable_thread_id"
+-d:"chronicles_thread_ids=no"