add hierarchical layer

Author: juleswritescode

Cargo.lock

@@ -44,7 +44,7 @@ strum                    = { version = "0.27.1", features = ["derive"] }
 sqlx                     = { version = "0.8.2", features = ["runtime-tokio", "runtime-async-std", "postgres", "json"] }
 syn                      = "1.0.109"
 termcolor                = "1.4.1"
-test-log           = "0.2.17"
+test-log                 = "0.2.17"
 tokio                    = { version = "1.40.0", features = ["full"] }
 tower-lsp                = "0.20.0"
 tracing                  = { version = "0.1.40", default-features = false, features = ["std"] }

Cargo.toml

@@ -39,6 +39,7 @@ tracing                  = { workspace = true }
 tracing-appender         = "0.2.3"
 tracing-bunyan-formatter = { workspace = true }
 tracing-subscriber       = { workspace = true, features = ["env-filter", "json"] }
+tracing-tree             = { version = "0.4.0", features = ["time"] }
 
 [target.'cfg(unix)'.dependencies]
 libc  = "0.2.161"

crates/pgt_cli/Cargo.toml

@@ -17,6 +17,7 @@ use tracing_subscriber::{
     prelude::*,
     registry,
 };
+use tracing_tree::{HierarchicalLayer, time::UtcDateTime};
 
 pub(crate) fn start(
     session: CliSession,
@@ -78,8 +79,9 @@ pub(crate) fn run_server(
     log_path: Option<PathBuf>,
     log_file_name_prefix: Option<String>,
     log_level: Option<String>,
+    log_kind: Option<String>,
 ) -> Result<(), CliDiagnostic> {
-    setup_tracing_subscriber(log_path, log_file_name_prefix, log_level);
+    setup_tracing_subscriber(log_path, log_file_name_prefix, log_level, log_kind);
 
     let rt = Runtime::new()?;
     let factory = ServerFactory::new(stop_on_disconnect);
@@ -185,6 +187,7 @@ fn setup_tracing_subscriber(
     log_path: Option<PathBuf>,
     log_file_name_prefix: Option<String>,
     log_level: Option<String>,
+    log_kind: Option<String>,
 ) {
     let pgt_log_path = log_path.unwrap_or(pgt_fs::ensure_cache_dir().join("pgt-logs"));
 
@@ -197,13 +200,37 @@ fn setup_tracing_subscriber(
         .build(pgt_log_path)
         .expect("Failed to start the logger for the daemon.");
 
-    registry()
-        .with(JsonStorageLayer)
-        .with(
-            BunyanFormattingLayer::new("pgt_logs".into(), file_appender)
-                .with_filter(PgtLoggingFilter::from(log_level)),
-        )
-        .init();
+    let filter = PgtLoggingFilter::from(log_level);
+
+    let log_kind = log_kind.unwrap_or("hierarchical".into());
+
+    match log_kind.as_str() {
+        "bunyan" => {
+            registry()
+                .with(JsonStorageLayer)
+                .with(
+                    BunyanFormattingLayer::new("pgt_logs".into(), file_appender)
+                        .with_filter(filter),
+                )
+                .init();
+        }
+
+        _ => registry()
+            .with(
+                HierarchicalLayer::default()
+                    .with_indent_lines(true)
+                    .with_indent_amount(2)
+                    .with_bracketed_fields(true)
+                    .with_targets(true)
+                    .with_ansi(false)
+                    .with_timer(UtcDateTime {
+                        higher_precision: false,
+                    })
+                    .with_writer(file_appender)
+                    .with_filter(filter),
+            )
+            .init(),
+    }
 }
 
 pub fn default_pgt_log_path() -> PathBuf {

crates/pgt_cli/src/commands/daemon.rs

@@ -171,6 +171,15 @@ pub enum PgtCommand {
         )]
         log_level: String,
 
+        /// Allows to change the logging format kind. Default is hierarchical.
+        #[bpaf(
+            env("PGT_LOG_KIND"),
+            long("log-kind"),
+            argument("hierarchical|bunyan"),
+            fallback(String::from("hierarchical"))
+        )]
+        log_kind: String,
+
         #[bpaf(long("stop-on-disconnect"), hide_usage)]
         stop_on_disconnect: bool,
         /// Allows to set a custom file path to the configuration file,

crates/pgt_cli/src/commands/mod.rs

@@ -106,12 +106,14 @@ impl<'app> CliSession<'app> {
                 log_path,
                 log_prefix_name,
                 log_level,
+                log_kind,
             } => commands::daemon::run_server(
                 stop_on_disconnect,
                 config_path,
                 Some(log_path),
                 Some(log_prefix_name),
                 Some(log_level),
+                Some(log_kind),
             ),
             PgtCommand::PrintSocket => commands::daemon::print_socket(),
         };

crates/pgt_cli/src/lib.rs

@@ -227,7 +227,7 @@ impl LanguageServer for LSPServer {
     async fn code_action(&self, params: CodeActionParams) -> LspResult<Option<CodeActionResponse>> {
         match handlers::code_actions::get_actions(&self.session, params) {
             Ok(result) => {
-                tracing::info!("Got Code Actions: {:?}", result);
+                tracing::trace!("Got {} Code Action(s)", result.len());
                 return LspResult::Ok(Some(result));
             }
             Err(e) => LspResult::Err(into_lsp_error(e)),