Struct PerfettoLayer 

pub struct PerfettoLayer<W = fn() -> Stdout> { /* private fields */ }

A Layer that records span as perfetto’s TYPE_SLICE_BEGIN/TYPE_SLICE_END, and event as TYPE_INSTANT.

PerfettoLayer will output the records as encoded protobuf messages.

Implementations

impl<W: PerfettoWriter> PerfettoLayer<W>

pub fn new(writer: W) -> Self

pub fn with_debug_annotations(self, value: bool) -> Self

Configures whether or not spans/events shoulde be recored with their metadata and fields.

pub fn with_filter_by_marker(self, filter: fn(&str) -> bool) -> Self

Configures whether or not spans/events be recored based on the occurrence of a field name.

Sometimes, not all the events/spans should be treated as perfetto trace, you can append a field to indicate that this even/span should be captured into trace:

use tracing_perfetto::PerfettoLayer;
use tracing_subscriber::{layer::SubscriberExt, Registry, prelude::*};

let layer = PerfettoLayer::new(std::fs::File::open("/tmp/test.pftrace").unwrap())
                .with_filter_by_marker(|field_name| field_name == "perfetto");
tracing_subscriber::registry().with(layer).init();

// this event will be record, as it contains a `perfetto` field
tracing::info!(perfetto = true, my_bool = true);

// this span will be record, as it contains a `perfetto` field
#[tracing::instrument(fields(perfetto = true))]
fn to_instr() {

  // this event will be ignored
  tracing::info!(my_bool = true);
}

Trait Implementations

impl<W, S> Layer<S> for PerfettoLayer<W>

where S: for<'a> LookupSpan<'a> + Subscriber, W: for<'writer> MakeWriter<'writer> + 'static,

fn on_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_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

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

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

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber.

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 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 event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.

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

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

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

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

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.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>

where Self: Sized, F: Filter<S>,

Combines self with a Filter, returning a Filtered layer.

fn boxed(self) -> Box<dyn Layer<S> + Send + Sync>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Erases the type of this Layer, returning a Boxed dyn Layer trait object.