Struct SdkLayer

pub struct SdkLayer { /* private fields */ }

A layer to be used with tracing-subscriber that forwards collected spans to the Perfetto SDK via the C++ API.

Implementations

impl SdkLayer

pub fn from_config( config: TraceConfig, output_file: Option<File>, ) -> Builder<'static>

Create a new layer builder from the supplied proto config.

The proto config is usually read from an external source using the prototext syntax, or else using one of the serde codecs. The config will internally be encoded to bytes straight away, so prefer [NativeLayer::from_config_bytes] if you already have the byte representation.

The built layer will write traces to the supplied output file. If no file is specified, it is probably only useful to run in system mode, so that the traces are sent to the traced daemon instead (else they would just get lost).

pub fn from_config_bytes( config_bytes: &[u8], output_file: Option<File>, ) -> Builder<'_>

Create a new layer builder from the supplied proto config bytes.

The proto config bytes needs to be an already encoded message of type schema::TraceConfig.

The built layer will write traces to the supplied output file. If no file is specified, it is probably only useful to run in system mode, so that the traces are sent to the traced daemon instead (else they would just get lost).

pub fn flush(&self, timeout: Duration) -> Result<()>

Flush internal buffers, making the best effort for all pending writes to be visible on this layer’s output_file.

pub fn stop(&self) -> Result<()>

Stop the layer and stop collecting traces.

Trait Implementations

impl Clone for SdkLayer

fn clone(&self) -> SdkLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Layer<S> for SdkLayer

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

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, id: &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_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_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_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.