chore: with_verbose_retrace => with_span_retrace

Author: ten3roberts

examples/basic.rs

@@ -11,7 +11,6 @@ fn main() {
         .with_thread_ids(true)
         .with_verbose_exit(true)
         .with_verbose_entry(true)
-        .with_span_modes(true)
         .with_targets(true);
 
     let subscriber = Registry::default().with(layer);

examples/concurrent.rs

@@ -18,7 +18,8 @@ fn main() {
         .with_thread_ids(true)
         .with_verbose_exit(true)
         .with_verbose_entry(true)
-        .with_verbose_retrace(true)
+        .with_span_retrace(true)
+        .with_deferred_spans(true)
         .with_deferred_spans(false)
         .with_span_modes(true)
         .with_targets(true);
@@ -48,34 +49,32 @@ fn main() {
     });
 
     debug!("starting countdowns");
-    debug_span!("countdowns").in_scope(
-        || {
-            let mut countdown_a = CountdownFuture {
-                label: "a",
-                count: 3,
-            }
-            .instrument(span!(Level::DEBUG, "countdown_a"))
-            .fuse();
-
-            let mut countdown_b = CountdownFuture {
-                label: "b",
-                count: 5,
-            }
-            .instrument(span!(Level::DEBUG, "countdown_b"))
-            .fuse();
-
-            // We don't care if the futures are ready, as we poll manually
-            let waker = futures::task::noop_waker();
-            let mut cx = Context::from_waker(&waker);
-
-            let _ = countdown_a.poll_unpin(&mut cx);
-            let _ = countdown_b.poll_unpin(&mut cx);
-
-            std::thread::sleep(std::time::Duration::from_millis(300));
-
-            let _ = countdown_b.poll_unpin(&mut cx);
-        }, //
-    );
+    debug_span!("countdowns").in_scope(|| {
+        let mut countdown_a = CountdownFuture {
+            label: "a",
+            count: 3,
+        }
+        .instrument(span!(Level::DEBUG, "countdown_a"))
+        .fuse();
+
+        let mut countdown_b = CountdownFuture {
+            label: "b",
+            count: 5,
+        }
+        .instrument(span!(Level::DEBUG, "countdown_b"))
+        .fuse();
+
+        // We don't care if the futures are ready, as we poll manually
+        let waker = futures::task::noop_waker();
+        let mut cx = Context::from_waker(&waker);
+
+        let _ = countdown_a.poll_unpin(&mut cx);
+        let _ = countdown_b.poll_unpin(&mut cx);
+
+        std::thread::sleep(std::time::Duration::from_millis(300));
+
+        let _ = countdown_b.poll_unpin(&mut cx);
+    });
 
     tracing::info!("finished countdowns");
 

src/format.rs

@@ -53,12 +53,12 @@ pub struct Config {
     /// Whether to print the current span before exiting it.
     pub verbose_exit: bool,
     /// Print the path leading up to a span if a different span was entered concurrently
-    pub verbose_retrace: bool,
+    pub span_retrace: bool,
     /// Whether to print squiggly brackets (`{}`) around the list of fields in a span.
     pub bracketed_fields: bool,
-
+    /// Defer printing a span until an event is generated inside of it
     pub deferred_spans: bool,
-
+    /// Print a label of the span mode (open/close etc).
     pub span_modes: bool,
 }
 
@@ -110,9 +110,9 @@ impl Config {
         }
     }
 
-    pub fn with_verbose_retrace(self, verbose_retrace: bool) -> Self {
+    pub fn with_span_retrace(self, enabled: bool) -> Self {
         Self {
-            verbose_retrace,
+            span_retrace: enabled,
             ..self
         }
     }
@@ -173,7 +173,7 @@ impl Default for Config {
             wraparound: usize::max_value(),
             verbose_entry: false,
             verbose_exit: false,
-            verbose_retrace: false,
+            span_retrace: false,
             bracketed_fields: false,
             deferred_spans: false,
             span_modes: false,

src/lib.rs

@@ -204,9 +204,9 @@ where
     /// the meantime
     /// This helps during concurrent or multi-threaded events where threads are entered, but not
     /// necessarily *exited* before other *divergent* spans are entered and generating events.
-    pub fn with_verbose_retrace(self, verbose_retrace: bool) -> Self {
+    pub fn with_span_retrace(self, enabled: bool) -> Self {
         Self {
-            config: self.config.with_verbose_retrace(verbose_retrace),
+            config: self.config.with_span_retrace(enabled),
             ..self
         }
     }
@@ -394,7 +394,7 @@ where
         let bufs = &mut *guard;
 
         if let Some((span_id, current_span)) = &span {
-            if self.config.verbose_retrace
+            if self.config.span_retrace
                 || current_span
                     .extensions()
                     .get::<Data>()
@@ -406,8 +406,6 @@ where
 
                 let old_span_id = bufs.current_span.replace((*span_id).clone());
 
-                eprintln!("Old span: {old_span_id:?}");
-
                 if Some(*span_id) != old_span_id.as_ref() {
                     let old_span = old_span_id.as_ref().and_then(|v| ctx.span(v));
 
@@ -429,7 +427,7 @@ where
                             bufs,
                             &ctx,
                             SpanMode::Retrace {
-                                verbose: self.config.verbose_retrace,
+                                verbose: self.config.span_retrace,
                             },
                         )
                     }