Skip to main content

SelfEventBuilder

Struct SelfEventBuilder 

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

Fluent builder for runtime-style self-events.

Sinks, middleware, and tok’s own init paths emit labels-only self-events (ObsConfigReloaded, ObsBatchSinkUploaded, …). The plain obs_core::self_event helper returns a bare envelope that the caller mutates; the builder wraps that in a fluent chain for call sites that set two or more labels.

use obs_kit::SelfEventBuilder;
use obs_kit::{Severity, Tier};

SelfEventBuilder::new("mylib.v1.WorkerRestart", Tier::Log, Severity::Warn)
    .label("reason", "timeout")
    .label("worker_id", "42")
    .emit();

Implementations§

Source§

impl SelfEventBuilder

Source

pub fn new(full_name: &str, tier: Tier, sev: Severity) -> Self

Start a new builder with the given full_name, tier, and sev. sampling_reason is set to SAMPLING_REASON_RUNTIME and ts_ns to the current wall-clock via obs_core::self_event.

Source

pub fn label(self, key: impl Into<String>, value: impl Into<String>) -> Self

Insert (or replace) a label.

Source

pub fn labels<I, K, V>(self, iter: I) -> Self
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Extend the envelope with an iterator of (key, value) pairs. Useful when the labels come from a pre-built BTreeMap/HashMap.

Source

pub fn emit(self)

Emit the envelope through the active observer.

Source

pub fn build(self) -> ObsEnvelope

Return the built envelope without emitting. Useful for tests and for call sites that want to attach a payload before handing the envelope to a sink manually.

Trait Implementations§

Source§

impl Debug for SelfEventBuilder

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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