Skip to main content

WideEventLayer

Struct WideEventLayer 

Source
pub struct WideEventLayer<W = Stdout, F = JsonFormatter, T = Rfc3339> { /* private fields */ }
Expand description

A tracing_subscriber::Layer that writes wide event output.

Timestamp precision is controlled by the FormatTime implementation (default: Rfc3339). Swap it with with_timer:

use wide_event::WideEventLayer;
use tracing_subscriber::fmt::time::Uptime;

tracing_subscriber::registry()
    .with(WideEventLayer::stdout().with_timer(Uptime::default()))
    .init();

Implementations§

Source§

impl WideEventLayer<Stdout, JsonFormatter, Rfc3339>

Source

pub fn stdout() -> Self

Create a layer that writes JSON wide events to stdout with RFC 3339 timestamps.

Source§

impl<W: Write + Send + 'static, F: WideEventFormatter> WideEventLayer<W, F, Rfc3339>

Source

pub fn new(writer: W, formatter: F) -> Self

Create a layer with a custom writer and formatter.

Uses Rfc3339 timestamps by default. Call with_timer to change.

Source§

impl<W: Write + Send + 'static, F: WideEventFormatter, T: FormatTime> WideEventLayer<W, F, T>

Source

pub fn with_system(self, system: &'static str) -> Self

Set a process-wide "system" field injected into every wide event.

Source

pub fn with_target_prefix(self, prefix: &'static str) -> Self

Set the target prefix for wide event output.

The actual tracing target is always wide_event (a macro limitation), but the formatted output uses {prefix}::{subsystem} as the subsystem identifier.

Source

pub fn with_timer<T2: FormatTime>(self, timer: T2) -> WideEventLayer<W, F, T2>

Set the timestamp formatter.

Accepts any FormatTime implementation from tracing_subscriber::fmt::time.

Trait Implementations§

Source§

impl<S, W, F, T> Layer<S> for WideEventLayer<W, F, T>
where S: Subscriber + for<'a> LookupSpan<'a>, W: Write + Send + 'static, F: WideEventFormatter + 'static, T: FormatTime + Send + Sync + 'static,

Source§

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

Notifies this layer that an event has occurred.
Source§

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber. Read more
Source§

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

Performs late initialization when attaching a Layer to a Subscriber. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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.
Source§

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.
Source§

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.
Source§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called. Read more
Source§

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

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

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

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

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

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

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.
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more

Auto Trait Implementations§

§

impl<W = Stdout, F = JsonFormatter, T = Rfc3339> !Freeze for WideEventLayer<W, F, T>

§

impl<W, F, T> RefUnwindSafe for WideEventLayer<W, F, T>

§

impl<W, F, T> Send for WideEventLayer<W, F, T>
where F: Send, T: Send, W: Send,

§

impl<W, F, T> Sync for WideEventLayer<W, F, T>
where F: Sync, T: Sync, W: Send,

§

impl<W, F, T> Unpin for WideEventLayer<W, F, T>
where F: Unpin, T: Unpin, W: Unpin,

§

impl<W, F, T> UnsafeUnpin for WideEventLayer<W, F, T>

§

impl<W, F, T> UnwindSafe for WideEventLayer<W, F, T>
where F: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more