Skip to main content

Instrumentation

Struct Instrumentation 

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

A dynamic, isolated tracing instrumentation. Each instrumentation takes a dedicated slot. The slot number identifies which slot this instrumentation uses. The slot number is used to map to that slot in SLOTS, and in the OTel Context to identify which (active) span belongs to the slot.

Implementations§

Source§

impl Instrumentation

Source

pub fn builder() -> InstrumentationBuilder

Create a new InstrumentationBuilder.

Source

pub fn is_distributed(&self) -> bool

Whether this is the distributed instrumentation (see InstrumentationBuilder::distributed).

Source

pub fn enable_all(&self)

Enable every known #[traceable] function for this instrumentation.

Source

pub fn disable_all(&self)

Disable every function for this instrumentation.

Source

pub fn set_enabled<S: AsRef<str>>( &self, selectors: &[S], ) -> Result<Selection, UnknownKeys>

Replace this instrumentation’s enabled sites with the ones the provided selectors resolve to.

§Errors

UnknownKeys does not resolve to any #[traceable] function. In that case nothing is applied and this instrumentation keeps the set it already had.

Source

pub fn enable<S: AsRef<str>>( &self, selectors: &[S], ) -> Result<Selection, UnknownKeys>

Enable everything that selectors resolves to, leaving the rest of the enabled set unchanged (additive).

§Errors

As set_enabled.

Source

pub fn disable<S: AsRef<str>>( &self, selectors: &[S], ) -> Result<Selection, UnknownKeys>

Disable everything that selectors resolves to, leaving the rest of the enabled set unchanged.

§Errors

As set_enabled.

Source

pub fn enabled_names(&self) -> impl Iterator<Item = &'static str>

Registry keys currently enabled for this instrumentation.

Trait Implementations§

Source§

impl Debug for Instrumentation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Instrumentation

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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, 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