chore(instrumentation): Improve trace events with fields

Author: NickLarsenNZ

rust/stackable-cockpit/src/platform/operator/mod.rs

@@ -191,7 +191,7 @@ impl OperatorSpec {
         namespace: &str,
         chart_source: &ChartSourceType,
     ) -> Result<(), helm::Error> {
-        info!("Installing operator {}", self);
+        info!(operator = %self, "Installing operator");
 
         let version = self.version.as_ref().map(|v| v.to_string());
         let helm_name = self.helm_name();

rust/stackable-cockpit/src/platform/release/spec.rs

@@ -70,26 +70,34 @@ impl ReleaseSpec {
         let namespace = namespace.to_string();
         futures::stream::iter(self.filter_products(include_products, exclude_products))
             .map(|(product_name, product)| {
+                let task_span =
+                    tracing::debug_span!("install_operator", product_name = tracing::field::Empty);
+
                 let namespace = namespace.clone();
                 let chart_source = chart_source.clone();
                 // Helm installs currently `block_in_place`, so we need to spawn each job onto a separate task to
                 // get useful parallelism.
-                tokio::spawn(async move {
-                    info!("Installing {product_name}-operator");
-
-                    // Create operator spec
-                    let operator = OperatorSpec::new(&product_name, Some(product.version.clone()))
-                        .context(OperatorSpecParseSnafu)?;
-
-                    // Install operator
-                    operator
-                        .install(&namespace, &chart_source)
-                        .context(HelmInstallSnafu)?;
-
-                    info!("Installed {product_name}-operator");
-
-                    Ok(())
-                })
+                tokio::spawn(
+                    async move {
+                        Span::current().record("product_name", &product_name);
+                        info!("Installing {product_name}-operator");
+
+                        // Create operator spec
+                        let operator =
+                            OperatorSpec::new(&product_name, Some(product.version.clone()))
+                                .context(OperatorSpecParseSnafu)?;
+
+                        // Install operator
+                        operator
+                            .install(&namespace, &chart_source)
+                            .context(HelmInstallSnafu)?;
+
+                        info!("Installed {product_name}-operator");
+
+                        Ok(())
+                    }
+                    .instrument(task_span),
+                )
             })
             .buffer_unordered(10)
             .map(|res| res.context(BackgroundTaskSnafu)?)

rust/stackable-cockpit/src/platform/stack/spec.rs

@@ -206,7 +206,7 @@ impl StackSpec {
         _product_namespace: &str, // TODO (@NickLarsenNZ): remove this field
         chart_source: &ChartSourceType,
     ) -> Result<(), Error> {
-        info!("Trying to install release {}", self.release);
+        info!(self.release, "Trying to install release");
 
         // Get the release by name
         let release = release_list

rust/stackablectl/src/cli/mod.rs

@@ -152,6 +152,7 @@ impl Cli {
 
     pub fn cache_settings(&self) -> Result<Settings, CacheSettingsError> {
         if self.no_cache {
+            tracing::debug!("Cache disabled");
             Ok(Settings::disabled())
         } else {
             let project_dir = ProjectDirs::from(
@@ -161,7 +162,12 @@ impl Cli {
             )
             .ok_or(CacheSettingsError::UserDir)?;
 
-            Ok(Settings::disk(project_dir.cache_dir()))
+            let cache_dir = project_dir.cache_dir();
+            tracing::debug!(
+                cache_dir = %cache_dir.to_string_lossy(),
+                "Setting cache directory"
+            );
+            Ok(Settings::disk(cache_dir))
         }
     }
 

rust/stackablectl/src/cmds/demo.rs

@@ -265,7 +265,7 @@ async fn describe_cmd(
     cli: &Cli,
     list: demo::List,
 ) -> Result<String, CmdError> {
-    info!("Describing demo {}", args.demo_name);
+    info!(demo_name = %args.demo_name, "Describing demo");
 
     let demo = list.get(&args.demo_name).ok_or(CmdError::NoSuchDemo {
         name: args.demo_name.clone(),
@@ -327,7 +327,7 @@ async fn install_cmd(
     transfer_client: &xfer::Client,
     release_branch: &str,
 ) -> Result<String, CmdError> {
-    info!(%release_branch, "Installing demo {}", args.demo_name);
+    info!(demo_name = %args.demo_name, "Installing demo");
 
     // Init result output and progress output
     let mut output = cli.result();

rust/stackablectl/src/cmds/operator.rs

@@ -246,7 +246,7 @@ async fn list_cmd(args: &OperatorListArgs, cli: &Cli) -> Result<String, CmdError
 
 #[instrument(skip_all)]
 async fn describe_cmd(args: &OperatorDescribeArgs, cli: &Cli) -> Result<String, CmdError> {
-    debug!("Describing operator {}", args.operator_name);
+    debug!(operator_name = %args.operator_name, "Describing operator");
 
     // Build map which maps artifacts to a chart source
     let source_index_files =
@@ -328,6 +328,8 @@ async fn install_cmd(args: &OperatorInstallArgs, cli: &Cli) -> Result<String, Cm
             )
             .context(HelmSnafu)?;
 
+        // TODO (@NickLarsenNZ): Send this to the progress handler instead of using println
+        // info!(%operator, "Installed operator");
         println!("Installed {} operator", operator);
     }
 
@@ -383,7 +385,7 @@ fn uninstall_cmd(args: &OperatorUninstallArgs, cli: &Cli) -> Result<String, CmdE
 
 #[instrument(skip_all)]
 fn installed_cmd(args: &OperatorInstalledArgs, cli: &Cli) -> Result<String, CmdError> {
-    debug!("Listing installed operators");
+    info!("Listing installed operators");
 
     type ReleaseList = IndexMap<String, Release>;
 
@@ -523,10 +525,7 @@ fn build_versions_list_for_operator<T>(
 where
     T: AsRef<str> + std::fmt::Display + std::fmt::Debug,
 {
-    debug!(
-        "Build versions list for operator {}",
-        operator_name.as_ref()
-    );
+    debug!("Build versions list for operator");
 
     let mut versions_list = OperatorVersionList(HashMap::new());
     let operator_name = operator_name.as_ref();

rust/stackablectl/src/cmds/release.rs

@@ -211,7 +211,7 @@ async fn describe_cmd(
     cli: &Cli,
     release_list: release::ReleaseList,
 ) -> Result<String, CmdError> {
-    info!("Describing release");
+    info!(release = %args.release, "Describing release");
 
     let release = release_list.get(&args.release);
 
@@ -272,6 +272,7 @@ async fn install_cmd(
     cli: &Cli,
     release_list: release::ReleaseList,
 ) -> Result<String, CmdError> {
+    info!(release = %args.release, "Installing release");
     match release_list.get(&args.release) {
         Some(release) => {
             let mut output = cli.result();

rust/stackablectl/src/cmds/stack.rs

@@ -249,7 +249,7 @@ fn describe_cmd(
     cli: &Cli,
     stack_list: stack::StackList,
 ) -> Result<String, CmdError> {
-    info!("Describing stack {}", args.stack_name);
+    info!(stack_name = %args.stack_name, "Describing stack");
 
     match stack_list.get(&args.stack_name) {
         Some(stack) => match args.output_type {
@@ -312,7 +312,7 @@ async fn install_cmd(
     stack_list: stack::StackList,
     transfer_client: &xfer::Client,
 ) -> Result<String, CmdError> {
-    info!("Installing stack {}", args.stack_name);
+    info!(stack_name = %args.stack_name, "Installing stack");
 
     let files = cli.get_release_files().context(PathOrUrlParseSnafu)?;
     let release_list = release::ReleaseList::build(&files, transfer_client)