Config refactor

Author: nitely

execution_chain/conf.nim

@@ -48,8 +48,6 @@ const
   defaultHttpPort          = 8545
   # https://github.com/ethereum/execution-apis/blob/v1.0.0-beta.4/src/engine/authentication.md#jwt-specifications
   defaultEngineApiPort*    = 8551
-  defaultAdminListenAddress = (static parseIpAddress("127.0.0.1"))
-  defaultAdminListenAddressDesc = $defaultAdminListenAddress & ", meaning local host only"
   logLevelDesc = getLogLevels()
 
 template defaultListenAddress(): IpAddress =
@@ -175,21 +173,7 @@ type
       defaultValue: StdoutLogKind.Auto
       name: "log-format" .}: StdoutLogKind
 
-    metricsEnabled* {.
-      desc: "Enable the built-in metrics HTTP server"
-      defaultValue: false
-      name: "metrics" .}: bool
-
-    metricsPort* {.
-      desc: "Listening port of the built-in metrics HTTP server"
-      defaultValue: defaultMetricsServerPort
-      name: "metrics-port" .}: Port
-
-    metricsAddress* {.
-      desc: "Listening IP address of the built-in metrics HTTP server"
-      defaultValue: defaultAdminListenAddress
-      defaultValueDesc: defaultAdminListenAddressDesc
-      name: "metrics-address" .}: IpAddress
+    metrics* {.flatten: (port: defaultMetricsServerPort).}: MetricsConf
 
     bootstrapNodes {.
       separator: "\pNETWORKING OPTIONS:"
@@ -396,7 +380,6 @@ type
       httpAddress* {.
         desc: "Listening IP address of the HTTP server(rpc, ws)"
         defaultValue: defaultAdminListenAddress
-        defaultValueDesc: $defaultAdminListenAddressDesc
         name: "http-address" .}: IpAddress
 
       rpcEnabled* {.
@@ -449,7 +432,6 @@ type
       engineApiAddress* {.
         desc: "Listening address for the Engine API(http and ws)"
         defaultValue: defaultAdminListenAddress
-        defaultValueDesc: $defaultAdminListenAddressDesc
         name: "engine-api-address" .}: IpAddress
 
       engineApiWsEnabled* {.

execution_chain/nimbus.nim

@@ -48,7 +48,6 @@ import
   ]
 
 const
-  defaultMetricsServerPort = 8008
   copyright = "Copyright (c) " & compileYear & " Status Research & Development GmbH"
 
 type NStartUpCmd* {.pure.} = enum
@@ -95,21 +94,7 @@ type
       defaultValue: StdoutLogKind.Auto
       name: "log-format" .}: StdoutLogKind
 
-    metricsEnabled* {.
-      desc: "Enable the built-in metrics HTTP server"
-      defaultValue: false
-      name: "metrics" .}: bool
-
-    metricsPort* {.
-      desc: "Listening port of the built-in metrics HTTP server"
-      defaultValue: defaultMetricsServerPort
-      name: "metrics-port" .}: Port
-
-    metricsAddress* {.
-      desc: "Listening IP address of the built-in metrics HTTP server"
-      defaultValue: defaultAdminListenAddress
-      defaultValueDesc: $defaultAdminListenAddressDesc
-      name: "metrics-address" .}: IpAddress
+    metrics* {.flatten.}: MetricsConf
 
     numThreads* {.
       defaultValue: 0,
@@ -219,7 +204,7 @@ proc runBeaconNode(p: BeaconThreadConfig) {.thread.} =
   let engineUrl =
     EngineApiUrl.init(&"http://127.0.0.1:{defaultEngineApiPort}/", Opt.some(jwtKey))
 
-  config.metricsEnabled = false
+  config.metrics.enabled = false
   config.elUrls.add EngineApiUrlConfigValue(
     url: engineUrl.url, jwtSecret: some toHex(distinctBase(jwtKey))
   )
@@ -265,7 +250,7 @@ proc runBeaconNode(p: BeaconThreadConfig) {.thread.} =
 
 proc runExecutionClient(p: ExecutionThreadConfig) {.thread.} =
   var config = makeConfig(ignoreUnknown = true)
-  config.metricsEnabled = false
+  config.metrics.enabled = false
   config.engineApiEnabled = true
   config.engineApiPort = Port(defaultEngineApiPort)
   config.engineApiAddress = defaultAdminListenAddress
@@ -322,7 +307,7 @@ proc runCombinedClient() =
     # permissions are insecure.
     quit QuitFailure
 
-  let metricsServer = (waitFor config.initMetricsServer()).valueOr:
+  let metricsServer = (waitFor initMetricsServer(config.metrics)).valueOr:
     quit 1
 
   # Nim GC metrics (for the main thread) will be collected in onSecond(), but

execution_chain/nimbus_execution_client.nim

@@ -393,7 +393,7 @@ proc main*(config = makeConfig(), nimbus = NimbusNode(nil)) {.noinline.} =
   # Metrics are useful not just when running node but also during import
   let metricsServer =
     try:
-      waitFor(initMetricsServer(config)).valueOr:
+      waitFor(initMetricsServer(config.metrics)).valueOr:
         quit(QuitFailure)
     except CancelledError:
       raiseAssert "Never cancelled"

portal/client/nimbus_portal_client.nim

@@ -236,7 +236,7 @@ proc run(portalClient: PortalClient, config: PortalConf) {.raises: [CatchableErr
     quit QuitFailure
 
   ## Start metrics HTTP server
-  let metricsServer = waitFor(initMetricsServer(config)).valueOr:
+  let metricsServer = waitFor(initMetricsServer(config.metrics)).valueOr:
     quit QuitFailure # Logged in initMetricsServer
 
   ## Start the Portal node.

portal/client/nimbus_portal_client_conf.nim

@@ -26,9 +26,7 @@ import
 
 const
   defaultListenAddress* = (static parseIpAddress("0.0.0.0"))
-  defaultAdminListenAddress* = (static parseIpAddress("127.0.0.1"))
   defaultListenAddressDesc = $defaultListenAddress
-  defaultAdminListenAddressDesc = $defaultAdminListenAddress
 
   defaultStorageCapacity* = 2000'u32 # 2 GB default
   defaultStorageCapacityDesc* = $defaultStorageCapacity
@@ -164,22 +162,7 @@ type
       name: "debug-netkey-nodeid-prefix-unsafe"
     .}: Option[string]
 
-    metricsEnabled* {.
-      defaultValue: false, desc: "Enable the metrics server", name: "metrics"
-    .}: bool
-
-    metricsAddress* {.
-      defaultValue: defaultAdminListenAddress,
-      defaultValueDesc: $defaultAdminListenAddressDesc,
-      desc: "Listening address of the metrics server",
-      name: "metrics-address"
-    .}: IpAddress
-
-    metricsPort* {.
-      defaultValue: 8008,
-      desc: "Listening HTTP port of the metrics server",
-      name: "metrics-port"
-    .}: Port
+    metrics* {.flatten.}: MetricsConf
 
     rpcEnabled* {.
       desc: "Enable the HTTP JSON-RPC server", defaultValue: false, name: "rpc"
@@ -188,7 +171,6 @@ type
     rpcAddress* {.
       desc: "Listening address of the HTTP JSON-RPC server",
       defaultValue: defaultAdminListenAddress,
-      defaultValueDesc: $defaultAdminListenAddressDesc,
       name: "rpc-address"
     .}: IpAddress
 
@@ -211,7 +193,6 @@ type
     wsAddress* {.
       desc: "Listening address of the WebSocket JSON-RPC server",
       defaultValue: defaultAdminListenAddress,
-      defaultValueDesc: $defaultAdminListenAddressDesc,
       name: "ws-address"
     .}: IpAddress
 

portal/tools/portalcli.nim

@@ -19,6 +19,7 @@ import
   eth/[common/keys, net/nat],
   eth/p2p/discoveryv5/node,
   eth/p2p/discoveryv5/protocol as discv5_protocol,
+  beacon_chain/nimbus_binary_common,
   ../common/common_utils,
   ../database/content_db,
   ../network/wire/
@@ -95,21 +96,7 @@ type
       name: "network-key"
     .}: PrivateKey
 
-    metricsEnabled* {.
-      defaultValue: false, desc: "Enable the metrics server", name: "metrics"
-    .}: bool
-
-    metricsAddress* {.
-      defaultValue: defaultAdminListenAddress,
-      desc: "Listening address of the metrics server",
-      name: "metrics-address"
-    .}: IpAddress
-
-    metricsPort* {.
-      defaultValue: 8008,
-      desc: "Listening HTTP port of the metrics server",
-      name: "metrics-port"
-    .}: Port
+    metrics* {.flatten.}: MetricsConf
 
     protocolId* {.
       defaultValue: getProtocolId(PortalSubnetwork.history),
@@ -268,23 +255,11 @@ proc run(config: PortalCliConf) =
       bootstrapRecords = bootstrapRecords,
     )
 
-  if config.metricsEnabled:
-    let
-      address = config.metricsAddress
-      port = config.metricsPort
-      url = "http://" & $address & ":" & $port & "/metrics"
-
-      server = MetricsHttpServerRef.new($address, port).valueOr:
-        error "Could not instantiate metrics HTTP server", url, error
-        quit QuitFailure
-
-    info "Starting metrics HTTP server", url
-    try:
-      waitFor server.start()
-    except MetricsError as exc:
-      fatal "Could not start metrics HTTP server",
-        url, error_msg = exc.msg, error_name = exc.name
-      quit QuitFailure
+  let metricsServer = (waitFor initMetricsServer(config.metrics)).valueOr:
+    quit QuitFailure
+  defer:
+    if metricsServer.isSome():
+      waitFor metricsServer.stopMetricsServer()
 
   case config.cmd
   of ping:

tests/test_configuration.nim

@@ -322,9 +322,9 @@ proc configurationMain*() =
       check config.logLevel == "DEBUG"
       check config.logFormat == StdoutLogKind.Json
 
-      check config.metricsEnabled == true
-      check config.metricsPort == 127.Port
-      check config.metricsAddress == parseIpAddress("111.222.33.203")
+      check config.metrics.enabled == true
+      check config.metrics.port == 127.Port
+      check config.metrics.address == parseIpAddress("111.222.33.203")
 
       privateAccess(ExecutionClientConf)
       check config.bootstrapNodes.len == 3