Add child dsc process to pass-through traces to parent

SteveL-MSFT · SteveL-MSFT · commit 3b41d90a70e9 · 2024-09-06T17:03:33.000-07:00
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test"
@@ -28,6 +32,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test",
@@ -45,19 +51,11 @@
     "5": "Resource instance failed schema validation",
     "6": "Command cancelled"
   },
-  "schema": {
-    "command": {
-      "executable": "dsc",
-      "args": [
-        "schema",
-        "--type",
-        "configuration"
-      ]
-    }
-  },
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],
diff --git a/dsc/group.dsc.resource.json b/dsc/group.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "get"
@@ -16,6 +18,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "set"
@@ -27,6 +31,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-group",
       "test"
@@ -46,6 +52,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],
diff --git a/dsc/include.dsc.resource.json b/dsc/include.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -29,6 +33,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "--as-group",
@@ -48,6 +54,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--as-include",
       "validate"
diff --git a/dsc/parallel.dsc.resource.json b/dsc/parallel.dsc.resource.json
@@ -7,6 +7,8 @@
   "get": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -17,6 +19,8 @@
   "set": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -29,6 +33,8 @@
   "test": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "--parallel",
       "--as-group",
@@ -49,6 +55,8 @@
   "validate": {
     "executable": "dsc",
     "args": [
+      "--trace-format",
+      "pass-through",
       "config",
       "validate"
     ],
diff --git a/dsc/src/args.rs b/dsc/src/args.rs
@@ -16,6 +16,8 @@ pub enum TraceFormat {
     Default,
     Plaintext,
     Json,
+    #[clap(hide = true)]
+    PassThrough,
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]
diff --git a/dsc/src/tablewriter.rs b/dsc/src/tablewriter.rs
@@ -1,4 +1,4 @@
-use crossterm::terminal::{size};
+use crossterm::terminal::size;
 
 pub struct Table {
     header: Vec<String>,
@@ -8,13 +8,13 @@ pub struct Table {
 
 impl Table {
     /// Create a new table.
-    /// 
+    ///
     /// # Arguments
-    /// 
+    ///
     /// * `header` - The header row
-    /// 
+    ///
     /// # Returns
-    /// 
+    ///
     /// * `Table` - The new table
     #[must_use]
     pub fn new(header: &[&str]) -> Table {
@@ -31,9 +31,9 @@ impl Table {
     }
 
     /// Add a row to the table.
-    /// 
+    ///
     /// # Arguments
-    /// 
+    ///
     /// * `row` - The row to add
     pub fn add_row(&mut self, row: Vec<String>) {
         for (i, column) in row.iter().enumerate() {
diff --git a/dsc/src/util.rs b/dsc/src/util.rs
@@ -323,15 +323,15 @@ pub fn enable_tracing(trace_level: &Option<TraceLevel>, trace_format: &TraceForm
                 .with_line_number(with_source)
                 .boxed()
         },
-        TraceFormat::Json => {
+        TraceFormat::Json | TraceFormat::PassThrough => {
             layer
                 .with_ansi(false)
                 .with_level(true)
                 .with_target(with_source)
                 .with_line_number(with_source)
                 .json()
                 .boxed()
-        }
+        },
     };
 
     let subscriber = tracing_subscriber::Registry::default().with(fmt).with(filter).with(indicatif_layer);
diff --git a/dsc_lib/src/dscresources/command_resource.rs b/dsc_lib/src/dscresources/command_resource.rs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 use jsonschema::JSONSchema;
+use serde::Deserialize;
 use serde_json::Value;
 use std::{collections::HashMap, env, process::Stdio};
 use crate::configure::{config_doc::ExecutionKind, config_result::{ResourceGetResult, ResourceTestResult}};
@@ -815,26 +816,114 @@ pub fn log_stderr_line<'a>(process_id: &u32, trace_line: &'a str) -> &'a str
 {
     if !trace_line.is_empty()
     {
-        if let Result::Ok(json_obj) = serde_json::from_str::<Value>(trace_line) {
+        if let Ok(trace_object) = serde_json::from_str::<Trace>(trace_line) {
+            let mut include_target = trace_object.level == TraceLevel::Debug || trace_object.level == TraceLevel::Trace;
+            let target = if let Some(t) = trace_object.target.as_deref() { t } else {
+                include_target = false;
+                ""
+            };
+            let line_number = if let Some(l) = trace_object.line_number { l } else {
+                include_target = false;
+                0
+            };
+            match trace_object.level {
+                TraceLevel::Error => {
+                    if include_target {
+                        error!("Process {process_id}: {target}: {line_number}: {}", trace_object.fields.message);
+                    }
+                    else {
+                        error!("Process {process_id}: {}", trace_object.fields.message);
+                    }
+                },
+                TraceLevel::Warning => {
+                    if include_target {
+                        warn!("Process {process_id}: {target}: {line_number}: {}", trace_object.fields.message);
+                    }
+                    else {
+                        warn!("Process {process_id}: {}", trace_object.fields.message);
+                    }
+                },
+                TraceLevel::Info => {
+                    if include_target {
+                        info!("Process {process_id}: {target}: {line_number}: {}", trace_object.fields.message);
+                    }
+                    else {
+                        info!("Process {process_id}: {}", trace_object.fields.message);
+                    }
+                },
+                TraceLevel::Debug => {
+                    if include_target {
+                        debug!("Process {process_id}: {target}: {line_number}: {}", trace_object.fields.message);
+                    }
+                    else {
+                        debug!("Process {process_id}: {}", trace_object.fields.message);
+                    }
+                },
+                TraceLevel::Trace => {
+                    if include_target {
+                        trace!("Process {process_id}: {target}: {line_number}: {}", trace_object.fields.message);
+                    }
+                    else {
+                        trace!("Process {process_id}: {}", trace_object.fields.message);
+                    }
+                },
+            }
+        }
+        else if let Ok(json_obj) = serde_json::from_str::<Value>(trace_line) {
             if let Some(msg) = json_obj.get("Error") {
-                error!("Process id {process_id} : {}", msg.as_str().unwrap_or_default());
+                error!("Process {process_id}: {}", msg.as_str().unwrap_or_default());
             } else if let Some(msg) = json_obj.get("Warning") {
-                warn!("Process id {process_id} : {}", msg.as_str().unwrap_or_default());
+                warn!("Process {process_id}: {}", msg.as_str().unwrap_or_default());
             } else if let Some(msg) = json_obj.get("Info") {
-                info!("Process id {process_id} : {}", msg.as_str().unwrap_or_default());
+                info!("Process {process_id}: {}", msg.as_str().unwrap_or_default());
             } else if let Some(msg) = json_obj.get("Debug") {
-                debug!("Process id {process_id} : {}", msg.as_str().unwrap_or_default());
+                debug!("Process {process_id}: {}", msg.as_str().unwrap_or_default());
             } else if let Some(msg) = json_obj.get("Trace") {
-                trace!("Process id {process_id} : {}", msg.as_str().unwrap_or_default());
+                trace!("Process {process_id}: {}", msg.as_str().unwrap_or_default());
             } else {
                 // the line is a valid json, but not one of standard trace lines - return it as filtered stderr_line
+                trace!("Process {process_id}: {trace_line}");
                 return trace_line;
             };
         } else {
             // the line is not a valid json - return it as filtered stderr_line
+            trace!("Process {process_id}: {}", trace_line);
             return trace_line;
         }
     };
 
     ""
 }
+
+#[derive(PartialEq, Eq, Deserialize)]
+enum TraceLevel {
+    #[serde(rename = "ERROR")]
+    Error,
+    #[serde(rename = "WARN")]
+    Warning,
+    #[serde(rename = "INFO")]
+    Info,
+    #[serde(rename = "DEBUG")]
+    Debug,
+    #[serde(rename = "TRACE")]
+    Trace,
+}
+
+#[derive(Deserialize)]
+struct Fields {
+    message: String,
+}
+
+#[derive(Deserialize)]
+struct Trace {
+    #[serde(rename = "timestamp")]
+    _timestamp: String,
+    level: TraceLevel,
+    fields: Fields,
+    target: Option<String>,
+    line_number: Option<u32>,
+    #[serde(rename = "span")]
+    _span: Option<HashMap<String, Value>>,
+    #[serde(rename = "spans")]
+    _spans: Option<Vec<HashMap<String, Value>>>,
+}
diff --git a/runcommandonset/RunCommandOnSet.dsc.resource.json b/runcommandonset/RunCommandOnSet.dsc.resource.json
@@ -6,13 +6,17 @@
     "get": {
         "executable": "runcommandonset",
         "args": [
+          "--trace-format",
+          "json",
           "get"
         ],
         "input": "stdin"
     },
     "set": {
         "executable": "runcommandonset",
         "args": [
+          "--trace-format",
+          "json",
           "set"
         ],
         "input": "stdin",

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@ pub enum TraceFormat {`
`16`	`16`	`Default,`
`17`	`17`	`Plaintext,`
`18`	`18`	`Json,`
	`19`	`+ #[clap(hide = true)]`
	`20`	`+ PassThrough,`
`19`	`21`	`}`
`20`	`22`
`21`	`23`	`#[derive(Debug, Clone, PartialEq, Eq, ValueEnum)]`