Add unionvisor diagnostics (#1732)

- feat(unionvisor): log bundle
- feat(unionvisor): better bundle logging
- fix(unionvisor): remove trailing }
- feat(unionvisor): log running uniond version
- feat(unionvisor): log uniond link info

Author: cor

unionvisor/src/bundle.rs

@@ -7,7 +7,7 @@ use std::{
 
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
-use tracing::{debug, error, field::display as as_display};
+use tracing::{debug, error, field::display as as_display, info};
 
 /// Bundles should have the following structure on the filesystem:
 ///
@@ -117,12 +117,6 @@ pub struct BundleMeta {
     versions_directory: PathBuf,
 }
 
-// pub enum BinaryAvailability {
-//     NotFound,
-//     PermissionDenied,
-//     Ok,
-// }
-
 impl Bundle {
     /// Constructs a new [`Bundle`] based on a path.
     /// Will read `bundle/meta.json` and error if invalid.
@@ -149,13 +143,17 @@ impl Bundle {
     pub fn path_to(&self, version: impl Into<OsString>) -> UnvalidatedVersionPath {
         let version = version.into();
         UnvalidatedVersionPath::new(
-            self.path
-                .join(&self.meta.versions_directory)
+            self.versions_path()
                 .join(version)
                 .join(&self.meta.binary_name),
         )
     }
 
+    /// Provides the full path the the versions directory
+    pub fn versions_path(&self) -> PathBuf {
+        self.path.join(&self.meta.versions_directory)
+    }
+
     /// Returns a [`PathBuf`] to the Bundle's genesis.json
     pub fn genesis_json(&self) -> PathBuf {
         self.path.join("genesis.json")
@@ -168,6 +166,19 @@ impl Bundle {
     }
 }
 
+pub fn log_bundle(bundle: &Bundle) {
+    let versions = fs::read_dir(bundle.versions_path())
+        .expect("can't read contents of versions path")
+        .map(|v| {
+            v.expect("can't read version in dir")
+                .path()
+                .into_os_string()
+        })
+        .collect::<Vec<_>>();
+
+    info!(target: "unionvisor", ?bundle, genesis=?bundle.genesis_json().into_os_string(), ?versions, "running with bundle" );
+}
+
 #[derive(Debug, Error)]
 pub enum NewBundleError {
     #[error("cannot read bundle/meta.json")]

unionvisor/src/cli.rs

@@ -13,7 +13,7 @@ use tracing::{field::display as as_display, info};
 use tracing_subscriber::filter::LevelFilter;
 
 use crate::{
-    bundle::{Bundle, NewBundleError, ValidateVersionPathError},
+    bundle::{log_bundle, Bundle, NewBundleError, ValidateVersionPathError},
     init::{self, SetSeedsError},
     logging::LogFormat,
     supervisor::{self, RuntimeError},
@@ -208,6 +208,7 @@ impl RunCmd {
     fn run(&self, root: impl Into<PathBuf>, logformat: LogFormat) -> Result<(), RunError> {
         let root = root.into();
         let bundle = Bundle::new(self.bundle.clone())?;
+        log_bundle(&bundle);
         let symlinker = Symlinker::new(root.clone(), bundle);
         supervisor::run_and_upgrade(
             root,

unionvisor/src/supervisor.rs

@@ -1,6 +1,6 @@
 use std::{
     ffi::{OsStr, OsString},
-    fs::create_dir_all,
+    fs::{self, create_dir_all},
     io,
     path::{Path, PathBuf},
     process::{Child, ExitStatus},
@@ -53,6 +53,13 @@ impl Supervisor {
         args: I,
     ) -> Result<(), SpawnError> {
         let program = self.symlinker.current_validated()?;
+        info!(
+            "running {:?} pointing to {:?}",
+            program.0.clone().into_os_string(),
+            fs::read_link(program.0.clone())
+                .expect("uniond is not a link!")
+                .into_os_string()
+        );
         let mut command = std::process::Command::new(program.0);
         let command = command
             .args(vec!["--log_format", logformat.as_str()])
@@ -274,7 +281,10 @@ mod tests {
     use tracing_test::traced_test;
 
     use super::*;
-    use crate::{bundle::Bundle, testdata};
+    use crate::{
+        bundle::{log_bundle, Bundle},
+        testdata,
+    };
 
     #[test]
     #[traced_test]

unionvisor/unionvisor.nix

@@ -125,6 +125,11 @@
           type = types.package;
           default = self.packages.${pkgs.system}.bundle-testnet-7;
         };
+        logFormat = mkOption {
+          type = types.str;
+          default = "json";
+          example = "plain";
+        };
         moniker = mkOption { type = types.str; };
         network = mkOption {
           type = types.str;
@@ -210,11 +215,11 @@
                 ''
                   ${pkgs.coreutils}/bin/mkdir -p /var/lib/unionvisor
                   cd /var/lib/unionvisor
-                  unionvisor init  --moniker ${cfg.moniker} --seeds ${cfg.seeds} --network ${cfg.network} --allow-dirty
+                  unionvisor --log-format ${cfg.logFormat} init --moniker ${cfg.moniker} --seeds ${cfg.seeds} --network ${cfg.network} --allow-dirty
 
                   ${configSymLinkCommands}
                 
-                  unionvisor run
+                  unionvisor --log-format ${cfg.logFormat} run
                 '';
             };
           in
@@ -230,3 +235,6 @@
       };
     };
 }
+
+
+