Struct console_subscriber::ConsoleLayer
source · [−]pub struct ConsoleLayer { /* private fields */ }
Expand description
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
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
.
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.
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
.
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
.
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
.
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
.
Trait Implementations
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
. Read more
Notifies this layer that a new span was constructed with the given
Attributes
and Id
. Read more
Notifies this layer that an event has occurred.
Notifies this layer that a span with the given ID was entered.
Notifies this layer that the span with the given ID was exited.
Notifies this layer that the span with the given ID has been closed.
Performs late initialization when attaching a Layer
to a
Subscriber
. Read more
Returns true
if this layer is interested in a span or event with the
given metadata
in the current Context
, similarly to
Subscriber::enabled
. Read more
Notifies this layer that a span with the given Id
recorded the given
values
. Read more
Notifies this layer that a span with the ID span
recorded that it
follows from the span with the ID follows
. Read more
Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID. Read more
Composes this layer around the given Layer
, returning a Layered
struct implementing Layer
. Read more
Composes this Layer
with the given Subscriber
, returning a
Layered
struct that implements Subscriber
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ConsoleLayer
impl Send for ConsoleLayer
impl Sync for ConsoleLayer
impl Unpin for ConsoleLayer
impl !UnwindSafe for ConsoleLayer
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more