Struct InstrumentBuilder
#[non_exhaustive]pub struct InstrumentBuilder<'a, T> {
pub instrument_provider: &'a dyn InstrumentProvider,
pub name: Cow<'static, str>,
pub description: Option<Cow<'static, str>>,
pub unit: Option<Cow<'static, str>>,
/* private fields */
}
Expand description
Configuration for building a sync instrument.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.instrument_provider: &'a dyn InstrumentProvider
Instrument provider is used to create the instrument.
name: Cow<'static, str>
Name of the instrument.
description: Option<Cow<'static, str>>
Description of the instrument.
unit: Option<Cow<'static, str>>
Unit of the instrument.
Implementations§
§impl<'a, T> InstrumentBuilder<'a, T>
impl<'a, T> InstrumentBuilder<'a, T>
pub fn with_description<S>(self, description: S) -> InstrumentBuilder<'a, T>
pub fn with_description<S>(self, description: S) -> InstrumentBuilder<'a, T>
Set the description for this instrument
pub fn with_unit<S>(self, unit: S) -> InstrumentBuilder<'a, T>
pub fn with_unit<S>(self, unit: S) -> InstrumentBuilder<'a, T>
Set the unit for this instrument.
Unit is case sensitive(kb
is not the same as kB
).
Unit must be:
- ASCII string
- No longer than 63 characters
§impl<'a> InstrumentBuilder<'a, Counter<u64>>
impl<'a> InstrumentBuilder<'a, Counter<u64>>
§impl<'a> InstrumentBuilder<'a, Counter<f64>>
impl<'a> InstrumentBuilder<'a, Counter<f64>>
§impl<'a> InstrumentBuilder<'a, Gauge<u64>>
impl<'a> InstrumentBuilder<'a, Gauge<u64>>
§impl<'a> InstrumentBuilder<'a, Gauge<f64>>
impl<'a> InstrumentBuilder<'a, Gauge<f64>>
§impl<'a> InstrumentBuilder<'a, Gauge<i64>>
impl<'a> InstrumentBuilder<'a, Gauge<i64>>
§impl<'a> InstrumentBuilder<'a, UpDownCounter<i64>>
impl<'a> InstrumentBuilder<'a, UpDownCounter<i64>>
pub fn build(self) -> UpDownCounter<i64>
pub fn build(self) -> UpDownCounter<i64>
Validates the instrument configuration and creates a new UpDownCounter<i64>
.
In case of invalid configuration, a no-op instrument is returned
and an error is logged using internal logging.
§impl<'a> InstrumentBuilder<'a, UpDownCounter<f64>>
impl<'a> InstrumentBuilder<'a, UpDownCounter<f64>>
pub fn build(self) -> UpDownCounter<f64>
pub fn build(self) -> UpDownCounter<f64>
Validates the instrument configuration and creates a new UpDownCounter<f64>
.
In case of invalid configuration, a no-op instrument is returned
and an error is logged using internal logging.
Trait Implementations§
Auto Trait Implementations§
impl<'a, T> Freeze for InstrumentBuilder<'a, T>
impl<'a, T> !RefUnwindSafe for InstrumentBuilder<'a, T>
impl<'a, T> !Send for InstrumentBuilder<'a, T>
impl<'a, T> !Sync for InstrumentBuilder<'a, T>
impl<'a, T> Unpin for InstrumentBuilder<'a, T>where
T: Unpin,
impl<'a, T> !UnwindSafe for InstrumentBuilder<'a, T>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Create a new
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more