Skip to main content

EventEmitter

Struct EventEmitter 

Source
pub struct EventEmitter { /* private fields */ }
Expand description

Ships structured events to the logging daemon’s ingest socket.

Construct it with EventEmitter::new (or EventEmitter::with_socket) inside a running tokio runtime — the background shipper is spawned at construction. Clone it freely: every clone shares the one shipper channel and the one stats handle, so a service can hand a clone to each task that needs to record an event without standing up a second shipper.

Implementations§

Source§

impl EventEmitter

Source

pub fn new(source: impl Into<String>) -> Self

Build an emitter for the default ingest socket, tagging every event with source (the binary name). Spawns the background shipper on the current tokio runtime; must be called from within a runtime context.

Source

pub fn with_socket(source: impl Into<String>, socket: impl AsRef<Path>) -> Self

Build an emitter that ships to an explicit socket path (used by tests). Spawns the background shipper on the current tokio runtime.

Source

pub fn stats(&self) -> Arc<EmitterStats> ⓘ

The diagnostic counters for this emitter (enqueued / dropped).

Source

pub fn emit(&self, kind: impl Into<String>, severity: Level, detail: Fields)

Record one event: kind is the dotted classifier, severity the level, detail the open field map (redacted in place before it leaves the process). Wait-free: a full channel drops the event and counts it, a closed channel (shipper gone) is a silent drop. Never blocks the caller, so an event recorded from a hot loop or a heartbeat tick cannot stall.

Trait Implementations§

Source§

impl Clone for EventEmitter

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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