Struct sc_telemetry::TelemetryLayer

pub struct TelemetryLayer(_);

Layer that handles the logs for telemetries.

Implementations

impl TelemetryLayer

pub fn new(
    buffer_size: Option<usize>,
    telemetry_external_transport: Option<ExtTransport>
) -> Result<(Self, TelemetryWorker)>

Create a new TelemetryLayer and TelemetryWorker.

The buffer_size defaults to 16.

The ExtTransport is used in WASM contexts where we need some binding between the networking provided by the operating system or environment and libp2p.

Important: Each individual call to write corresponds to one message. There is no internal buffering going on. In the context of WebSockets, each write must be one individual WebSockets frame.

Trait Implementations

impl Debug for TelemetryLayer

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

Formats the value using the given formatter.

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

fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

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

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

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

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

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

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

pub 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.

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

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

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

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