Struct GraphLayer

pub struct GraphLayer { /* private fields */ }

A Layer that records span open events as directed edges in a call graph.

Dropping and Flushing

To ensure all data is flushed when the program exits, GraphLayer exposes the [flush_on_drop] function, which returns a FlushGuard. The FlushGuard will flush the writer when it is dropped. If necessary, it can also be used to manually flush the writer.

Implementations

impl GraphLayer

pub fn enable_top_node(self, name: &'static str) -> Self

Add a top node to the graph.

pub fn disable_top_node(self) -> Self

Remove the top node to the graph.

impl GraphLayer

pub fn new() -> Self

Returns a new GraphLayer which constructs the call graph.

pub fn flush_on_drop<W>(&self, writer: W) -> FlushGuard<W>

where W: Write + 'static,

Returns a FlushGuard which will flush the GraphLayer’s writer when it is dropped, or when flush is manually invoked on the guard.

impl GraphLayer

pub fn with_file( path: impl AsRef<Path>, ) -> Result<(Self, FlushGuard<BufWriter<File>>), Error>

Constructs a GraphLayer that constructs the call graph, and a FlushGuard which writes the graph to a dot file when dropped.

Trait Implementations

impl Clone for GraphLayer

fn clone(&self) -> GraphLayer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphLayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GraphLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for GraphLayer

where S: Subscriber + for<'span> LookupSpan<'span>,

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite.

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled.

fn new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.

fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>

where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer.

fn with_subscriber(self, inner: S) -> Layered<Self, S>

where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber.