Struct console_subscriber::ConsoleLayer

pub struct ConsoleLayer { /* private fields */ }

A ConsoleLayer is a [tracing_subscriber::Layer] that records tracing spans and events emitted by the async runtime.

Runtimes emit tracing spans and events that represent specific operations that occur in asynchronous Rust programs, such as spawning tasks and waker operations. The ConsoleLayer collects and aggregates these events, and the resulting diagnostic data is exported to clients by the corresponding gRPC Server instance.

Implementations

impl ConsoleLayer

pub fn new() -> (Self, Server)

Returns a ConsoleLayer built with the default settings.

Note: these defaults do not include values provided via the environment variables specified in Builder::with_default_env.

See also Builder::build.

pub fn builder() -> Builder

Returns a Builder for configuring a ConsoleLayer.

Note that the returned builder does not include values provided via the environment variables specified in Builder::with_default_env. To extract those, you can call that method on the returned builder.

impl ConsoleLayer

pub const DEFAULT_EVENT_BUFFER_CAPACITY: usize = 102_400usize

Default maximum capacity for the channel of events sent from a ConsoleLayer to a Server.

When this capacity is exhausted, additional events will be dropped. Decreasing this value will reduce memory usage, but may result in events being dropped more frequently.

See also Builder::event_buffer_capacity.

pub const DEFAULT_CLIENT_BUFFER_CAPACITY: usize = 4_096usize

Default maximum capacity for th echannel of events sent from a Server to each subscribed client.

When this capacity is exhausted, the client is assumed to be inactive, and may be disconnected.

See also Builder::client_buffer_capacity.

pub const DEFAULT_PUBLISH_INTERVAL: Duration = _

Default frequency for publishing events to clients.

Note that methods like init and spawn will take the value from the TOKIO_CONSOLE_PUBLISH_INTERVAL environment variable before falling back on this default.

See also Builder::publish_interval.

pub const DEFAULT_RETENTION: Duration = _

By default, completed spans are retained for one hour.

Note that methods like init and spawn will take the value from the TOKIO_CONSOLE_RETENTION environment variable before falling back on this default.

See also Builder::retention.

pub const DEFAULT_POLL_DURATION_MAX: Duration = _

The default maximum value for task poll duration histograms.

Any poll duration exceeding this will be clamped to this value. By default, the maximum poll duration is one second.

See also Builder::poll_duration_histogram_max.

pub const DEFAULT_SCHEDULED_DURATION_MAX: Duration = _

The default maximum value for the task scheduled duration histogram.

Any scheduled duration (the time from a task being woken until it is next polled) exceeding this will be clamped to this value. By default, the maximum scheduled duration is one second.

See also Builder::scheduled_duration_histogram_max.

Trait Implementations

impl Debug for ConsoleLayer

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

Formats the value using the given formatter.

impl<S> Layer<S> for ConsoleLayer

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

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

Notifies this layer that an event has occurred.

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

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

fn on_exit(&self, id: &Id, cx: Context<'_, S>)

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

fn on_close(&self, id: Id, cx: 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 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_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 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> + Sync + Send>

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

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