Struct opentelemetry::metrics::InstrumentBuilder
source · #[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§
source§impl<'a, T> InstrumentBuilder<'a, T>
impl<'a, T> InstrumentBuilder<'a, T>
sourcepub fn with_description<S: Into<Cow<'static, str>>>(
self,
description: S,
) -> Self
pub fn with_description<S: Into<Cow<'static, str>>>( self, description: S, ) -> Self
Set the description for this instrument
source§impl<'a> InstrumentBuilder<'a, Counter<u64>>
impl<'a> InstrumentBuilder<'a, Counter<u64>>
source§impl<'a> InstrumentBuilder<'a, Counter<f64>>
impl<'a> InstrumentBuilder<'a, Counter<f64>>
source§impl<'a> InstrumentBuilder<'a, Gauge<u64>>
impl<'a> InstrumentBuilder<'a, Gauge<u64>>
source§impl<'a> InstrumentBuilder<'a, Gauge<f64>>
impl<'a> InstrumentBuilder<'a, Gauge<f64>>
source§impl<'a> InstrumentBuilder<'a, Gauge<i64>>
impl<'a> InstrumentBuilder<'a, Gauge<i64>>
source§impl<'a> InstrumentBuilder<'a, UpDownCounter<i64>>
impl<'a> InstrumentBuilder<'a, UpDownCounter<i64>>
sourcepub 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.
source§impl<'a> InstrumentBuilder<'a, UpDownCounter<f64>>
impl<'a> InstrumentBuilder<'a, UpDownCounter<f64>>
sourcepub 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§
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