workbench: further cardano-tracer integration & RTView

nix/nixos/cardano-tracer-service.nix

@@ -2,7 +2,7 @@ pkgs:
 let serviceConfigToJSON =
       cfg:
       {
-        networkMagic = 764824073; ## Mainnet
+        inherit (cfg) networkMagic;
         # loRequestNum = 100;
         network =
           if        cfg.acceptingSocket != null
@@ -28,6 +28,10 @@ let serviceConfigToJSON =
           rpMaxAgeHours   = 24;
         };
 
+        hasRTView = {
+          epHost    = "127.0.0.1";
+          epPort    = 3300;
+        };
         hasEKG = [
           { epHost    = "127.0.0.1";
             epPort    = 3100; ## supervisord.portShiftPrometheus
@@ -58,9 +62,10 @@ in pkgs.commonLib.defServiceModule
 
       extraOptionDecls = {
         ### You can actually change those!
-        acceptingSocket = mayOpt str        "Socket path: as acceptor.";
-        connectToSocket = mayOpt str        "Socket path: connect to.";
-        logRoot         = opt    str null   "Log storage root directory.";
+        networkMagic    = opt    int 764824073 "Network magic (764824073 for Cardano mainnet).";
+        acceptingSocket = mayOpt str           "Socket path: as acceptor.";
+        connectToSocket = mayOpt str           "Socket path: connect to.";
+        logRoot         = opt    str null      "Log storage root directory.";
 
         ### Here be dragons, on the other hand..
         configFile      = mayOpt str

nix/workbench/backend.sh

@@ -10,8 +10,8 @@ usage_backend() {
 
     allocate-run RUNDIR
     describe-run RUNDIR
-    start-cluster RUNDIR
-                     Start the cluster nodes
+    start RUNDIR     Start the backend
+    start-nodes RUNDIR
     start-node RUNDIR NODE-NAME
     stop-node RUNDIR NODE-NAME
     wait-node RUNDIR NODE-NAME
@@ -43,7 +43,8 @@ case "${op}" in
     setenv-defaults )            backend_$WORKBENCH_BACKEND "$@";;
     allocate-run )               backend_$WORKBENCH_BACKEND "$@";;
     describe-run )               backend_$WORKBENCH_BACKEND "$@";;
-    start-cluster )              backend_$WORKBENCH_BACKEND "$@";;
+    start )                      backend_$WORKBENCH_BACKEND "$@";;
+    start-nodes )                backend_$WORKBENCH_BACKEND "$@";;
     start-node )                 backend_$WORKBENCH_BACKEND "$@";;
     stop-node )                  backend_$WORKBENCH_BACKEND "$@";;
     wait-node )                  backend_$WORKBENCH_BACKEND "$@";;

nix/workbench/lib-cabal.sh

@@ -10,7 +10,7 @@ function workbench-prebuild-executables()
 
     echo "workbench:  prebuilding executables (because of useCabalRun)"
     unset NIX_ENFORCE_PURITY
-    for exe in cardano-node cardano-cli cardano-topology tx-generator locli
+    for exe in cardano-node cardano-cli cardano-topology cardano-tracer tx-generator locli
     do echo "workbench:    $(with_color blue prebuilding) $(with_color red $exe)"
        cabal -v0 build -- exe:$exe 2>&1 >/dev/null |
            { grep -v 'exprType TYPE'; true; } || return 1
@@ -30,6 +30,10 @@ function cardano-topology() {
     cabal -v0 run exe:cardano-topology -- "$@"
 }
 
+function cardano-tracer() {
+    cabal -v0 run exe:cardano-tracer -- "$@"
+}
+
 function locli() {
     cabal -v0 build exe:locli
     set-git-rev \
@@ -44,4 +48,4 @@ function tx-generator() {
 
 export WORKBENCH_CABAL_MODE=t
 
-export -f cardano-cli cardano-node cardano-topology locli tx-generator
+export -f cardano-cli cardano-node cardano-topology cardano-tracer locli tx-generator

nix/workbench/profile.sh

@@ -49,6 +49,7 @@ case "$op" in
         ' --exit-status --arg name "$name" >/dev/null
         ;;
 
+    ## XXX:  does not respect overlays!!
     compose )
         local profile_names="$@"
 
@@ -64,10 +65,17 @@ case "$op" in
         local usage="USAGE: wb profile $op [NAME=<current-shell-profile>"
         local name=${1:-${WORKBENCH_SHELL_PROFILE:?variable unset, no profile name to use as a default.}}
 
-        if test -f  "$name"
-        then jq '.' "$name"
-        else profile generate-all |
-             jq '.["'$name'"]'
+        local json=$(if test -f  "$name"
+                     then jq '.' "$name"
+                     else profile generate-all |
+                             jq '.["'$name'"]'
+                     fi)
+
+        local preset=$(jq -r '.preset // ""' <<<$json)
+        local preset_overlay=$global_basedir/profiles/presets/$preset/overlay.json
+        if test -z "$preset" -o ! -f $preset_overlay
+        then echo "$json"
+        else jq '. * $overlay[0]' <<<$json --slurpfile overlay $preset_overlay
         fi;;
 
     describe )

nix/workbench/profiles/presets/mainnet/overlay.json

@@ -0,0 +1,4 @@
+{ "genesis":
+  { "network_magic": 764824073
+  }
+}

nix/workbench/profiles/tracer-service.nix

@@ -25,6 +25,8 @@ let
           ## In both the local and remote scenarios, it's most frequently convenient to act as an acceptor.
           acceptingSocket = "tracer.socket";
 
+          networkMagic = profile.value.genesis.network_magic;
+
           ## logRoot = ## ..really depends on context -- available in backend.finaliseTracerService
 
           dsmPassthrough = {

nix/workbench/scenario.sh

@@ -25,33 +25,38 @@ local p=$dir/profile.json
 progress "run | scenario" "starting $(yellow $op)"
 case "$op" in
     idle | default )
-        backend start-cluster "$dir"
+        backend start                "$dir"
+        backend start-nodes          "$dir"
         ;;
 
     fixed )
-        backend start-cluster      "$dir"
+        backend start                "$dir"
 
-        scenario_setup_termination "$dir"
-        backend wait-pools-stopped "$dir"
+        scenario_setup_termination   "$dir"
+        backend start-nodes          "$dir"
+        backend wait-pools-stopped   "$dir"
         scenario_cleanup_termination
 
-        backend stop-cluster       "$dir"
+        backend stop-cluster         "$dir"
         ;;
 
     loaded )
-        backend start-cluster   "$dir"
-        backend start-generator "$dir"
+        backend start                "$dir"
+        backend start-nodes          "$dir"
+        backend start-generator      "$dir"
         ;;
 
     fixed-loaded )
-        backend start-cluster      "$dir"
-        backend start-generator    "$dir"
+        backend start                "$dir"
 
-        scenario_setup_termination "$dir"
-        backend wait-pools-stopped "$dir"
+        backend start-nodes          "$dir"
+        backend start-generator      "$dir"
+
+        scenario_setup_termination   "$dir"
+        backend wait-pools-stopped   "$dir"
         scenario_cleanup_termination
 
-        backend stop-cluster       "$dir"
+        backend stop-cluster         "$dir"
         ;;
 
     chainsync )
@@ -73,8 +78,10 @@ case "$op" in
         progress "scenario" "preparing ChainDB for the $(green server node)"
         chaindb "${chaindb_server[@]}"
 
+        backend start "$dir"
+
         progress "scenario" "starting the $(yellow ChainDB server node)"
-        backend start-cluster "$dir"
+        backend start-node        "$dir" 'node-0'
 
         progress "scenario" "starting the $(yellow fetcher node)"
         backend start-node        "$dir" 'node-1'

nix/workbench/supervisor-conf.nix

@@ -71,8 +71,7 @@ let
       stdout_logfile = "${service.value.stateDir}/stdout";
       stderr_logfile = "${service.value.stateDir}/stderr";
       startretries   = 0;
-      autostart      = nodeSpec.value.autostart
-                       or true; ## Backward compatibility for profiles coming from old pinned workbench.
+      autostart      = false;
       autorestart    = false;
     };
 

nix/workbench/supervisor.sh

@@ -26,6 +26,7 @@ case "$op" in
 
         setenvjq    'port_shift_ekg'        100
         setenvjq    'port_shift_prometheus' 200
+        setenvjq    'port_shift_rtview'     300
         setenvjqstr 'supervisor_conf'      "$profile_dir"/supervisor.conf
         ;;
 
@@ -51,8 +52,10 @@ case "$op" in
         local basePort=$(                   envjq 'basePort')
         local port_ekg=$((       basePort+$(envjq 'port_shift_ekg')))
         local port_prometheus=$((basePort+$(envjq 'port_shift_prometheus')))
+        local port_rtview=$((    basePort+$(envjq 'port_shift_rtview')))
 
         cat <<EOF
+  - RTView URL:              http://localhost:$port_rtview
   - EKG URL (node-0):        http://localhost:$port_ekg/
   - Prometheus URL (node-0): http://localhost:$port_prometheus/metrics
 EOF
@@ -98,13 +101,20 @@ EOF
         echo " $node up (${i}s)" >&2
         ;;
 
-    start-cluster )
-        local usage="USAGE: wb supervisor $op RUN-DIR"
+    start-nodes )
+        local usage="USAGE: wb supervisor $op RUN-DIR [HONOR_AUTOSTART=]"
         local dir=${1:?$usage}; shift
+        local honor_autostart=${1:-}
 
-        supervisord --config  "$dir"/supervisor/supervisord.conf $@
+        local nodes=($(jq_tolist keys "$dir"/node-specs.json))
 
-        for node in $(jq_tolist keys "$dir"/node-specs.json)
+        if test -n "$honor_autostart"
+        then for node in ${nodes[*]}
+             do jqtest ".\"$node\".autostart" "$dir"/node-specs.json &&
+                     supervisorctl start $node; done;
+        else supervisorctl start ${nodes[*]}; fi
+
+        for node in ${nodes[*]}
         do jqtest ".\"$node\".autostart" "$dir"/node-specs.json &&
                 backend_supervisor wait-node "$dir" $node; done
 
@@ -113,7 +123,20 @@ EOF
         fi
 
         backend_supervisor save-child-pids "$dir"
-        backend_supervisor save-pid-maps "$dir";;
+        backend_supervisor save-pid-maps   "$dir"
+        ;;
+
+    start )
+        local usage="USAGE: wb supervisor $op RUN-DIR"
+        local dir=${1:?$usage}; shift
+
+        supervisord --config  "$dir"/supervisor/supervisord.conf $@
+
+        if jqtest ".node.tracer" "$dir"/profile.json
+        then progress_ne "supervisor" "waiting for $(yellow cardano-tracer) to create socket: "
+             while test ! -e "$dir"/tracer/tracer.socket; do sleep 1; done
+             echo $(green ' OK') >&2
+        fi;;
 
     get-node-socket-path )
         local usage="USAGE: wb supervisor $op STATE-DIR NODE-NAME"