Struct tracing_chrome::ChromeLayerBuilder

pub struct ChromeLayerBuilder<S> where
    S: Subscriber + for<'span> LookupSpan<'span> + Send + Sync,  { /* private fields */ }

Implementations

impl<S> ChromeLayerBuilder<S> where
    S: Subscriber + for<'span> LookupSpan<'span> + Send + Sync, 

pub fn new() -> Self

pub fn file<P: AsRef<Path>>(self, file: P) -> Self

Set the file to which to output the trace.

Defaults to “./trace-{unix epoch time}.json”

pub fn include_args(self, include: bool) -> Self

Include arguments in each trace entry.

Defaults to false.

Includes the arguments used when creating a span/event in the “args” section of the trace entry.

pub fn include_locations(self, include: bool) -> Self

Include file+line with each trace entry.

Defaults to true.

This can add quite a bit of data to the output so turning it off might be helpful when collecting larger traces.

pub fn trace_style(self, style: TraceStyle) -> Self

Sets the style used when recording trace events. See TraceStyle for details.

pub fn name_fn(
    self,
    name_fn: Box<dyn Fn(&EventOrSpan<'_, '_, S>) -> String + Send + Sync>
) -> Self

Allows supplying a function that derives a name from an Event or Span. The result is used as the “name” field on trace entries.

Example

use tracing_chrome::{ChromeLayerBuilder, EventOrSpan};
use tracing_subscriber::{registry::Registry, prelude::*};

let (chrome_layer, _guard) = ChromeLayerBuilder::new().name_fn(Box::new(|event_or_span| {
    match event_or_span {
        EventOrSpan::Event(ev) => { ev.metadata().name().into() },
        EventOrSpan::Span(_s) => { "span".into() },
    }
})).build();
tracing_subscriber::registry().with(chrome_layer).init()

pub fn category_fn(
    self,
    cat_fn: Box<dyn Fn(&EventOrSpan<'_, '_, S>) -> String + Send + Sync>
) -> Self

Allows supplying a function that derives a category from an Event or Span. The result is used as the “cat” field on trace entries.

Example

use tracing_chrome::{ChromeLayerBuilder, EventOrSpan};
use tracing_subscriber::{registry::Registry, prelude::*};

let (chrome_layer, _guard) = ChromeLayerBuilder::new().category_fn(Box::new(|_| {
    "my_module".into()
})).build();
tracing_subscriber::registry().with(chrome_layer).init()

pub fn build(self) -> (ChromeLayer<S>, FlushGuard)

Trait Implementations

impl<S: Default> Default for ChromeLayerBuilder<S> where
    S: Subscriber + for<'span> LookupSpan<'span> + Send + Sync, 

fn default() -> ChromeLayerBuilder<S>

Returns the “default value” for a type.