feat: integrate tokio traces & debug console (#275)

Cargo.toml

@@ -54,13 +54,15 @@ trait-variant = "0.1.2"
 comfy-table = { version = "7.1.1", optional = true }
 inquire = { version = "0.7.5", optional = true }
 toml = { version = "0.8.13", optional = true }
+console-subscriber = { version = "0.3.0", optional = true }
 
 [dev-dependencies]
 tempfile = "3.3.0"
 
 [features]
 mithril = ["mithril-client"]
 utils = ["comfy-table", "inquire", "toml"]
+debug = ["console-subscriber", "tokio/tracing"]
 default = ["mithril", "utils"]
 
 # The profile that 'cargo dist' will build with

README.md

@@ -67,3 +67,25 @@ sudo sh ./get-dolos.sh
 ```
 
 After installation, follow this [configuration guide](book/src/configuration). Guide on running dolos [here](book/src/running).
+
+
+# Debug
+
+## Running Tokio Console
+
+Make sure you have enable tokio traces in dolos.toml:
+```toml
+[logging]
+max_level=trace
+include_tokio=true
+```
+
+Start Dolos using:
+```
+RUSTFLAGS="--cfg tokio_unstable" cargo --features debug run
+```
+
+Then start tokio console:
+```
+tokio-console
+```

src/bin/dolos/common.rs

@@ -54,6 +54,12 @@ pub fn setup_tracing(config: &LoggingConfig) -> miette::Result<()> {
         .with_target("dolos", level)
         .with_target("gasket", level);
 
+    if config.include_tokio {
+        filter = filter
+            .with_target("tokio", level)
+            .with_target("runtime", level);
+    }
+
     if config.include_pallas {
         filter = filter.with_target("pallas", level);
     }
@@ -62,11 +68,22 @@ pub fn setup_tracing(config: &LoggingConfig) -> miette::Result<()> {
         filter = filter.with_target("tonic", level);
     }
 
-    tracing_subscriber::FmtSubscriber::builder()
-        .with_max_level(level)
-        .finish()
-        .with(filter)
-        .init();
+    #[cfg(not(feature = "debug"))]
+    {
+        tracing_subscriber::registry()
+            .with(tracing_subscriber::fmt::layer())
+            .with(filter)
+            .init();
+    }
+
+    #[cfg(feature = "debug")]
+    {
+        tracing_subscriber::registry()
+            .with(tracing_subscriber::fmt::layer())
+            .with(console_subscriber::spawn())
+            .with(filter)
+            .init();
+    }
 
     Ok(())
 }

src/bin/dolos/main.rs

@@ -109,6 +109,9 @@ pub struct LoggingConfig {
     #[serde_as(as = "DisplayFromStr")]
     max_level: tracing::Level,
 
+    #[serde(default)]
+    include_tokio: bool,
+
     #[serde(default)]
     include_pallas: bool,
 
@@ -120,6 +123,7 @@ impl Default for LoggingConfig {
     fn default() -> Self {
         Self {
             max_level: tracing::Level::INFO,
+            include_tokio: Default::default(),
             include_pallas: Default::default(),
             include_grpc: Default::default(),
         }