Struct DurationsLayerBuilder 

pub struct DurationsLayerBuilder { /* private fields */ }

Implementations

impl DurationsLayerBuilder

pub fn build<S>(self) -> Result<(DurationsLayer<S>, DurationsLayerDropGuard)>

This function needs to be called on the (tokio) main thread for accurate reporting.

pub fn with_fields(self, enabled: bool) -> Self

Whether to record the fields passed to the span (default: true).

Example

Span:

info_span!("make_request", host = "example.org", object = 10);

With true:

{"id":4,"start":{"secs":0,"nanos":446},"end":{"secs":0,"nanos":448},"name":"make_request","parents":[1,3],"fields":{"host":"example.org","object":"10"}}

With false:

{"id":4,"start":{"secs":0,"nanos":446},"end":{"secs":0,"nanos":448},"name":"make_request","parents":[1,3]}

pub fn with_parents(self, enabled: bool) -> Self

Whether to record the ids of the parent spans (default: true).

Example

Span:

info_span!("make_request", host = "example.org", object = 10);

With true:

{"id":4,"start":{"secs":0,"nanos":446},"end":{"secs":0,"nanos":448},"name":"make_request","parents":[1,3],"fields":{"host":"example.org","object":"10"}}

With false:

{"id":4,"start":{"secs":0,"nanos":446},"end":{"secs":0,"nanos":448},"name":"make_request","fields":{"host":"example.org","object":"10"}}

pub fn durations_file(self, file: impl Into<PathBuf>) -> Self

Record all span active durations as ndjson.

Example output line, see module level documentation for more details.

{"id":6,"name":"read_cache","start":{"secs":0,"nanos":122457871},"end":{"secs":0,"nanos":122463135},"parents":[3,4],"fields":{"id":"2"}}

The file is flushed when DurationsLayerDropGuard is dropped.

pub fn plot_file(self, file: impl Into<PathBuf>) -> Self

Plot the result and save them as svg.

TODO(konstin): Figure out how to embed an svg in rustdoc.

The file is written when DurationsLayerDropGuard is dropped.

pub fn plot_config(self, plot_config: PlotConfig) -> Self

Trait Implementations

impl Default for DurationsLayerBuilder

fn default() -> Self

Returns the “default value” for a type.