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 */
}

Configuration for building a sync instrument.

Fields (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>

pub fn with_description<S>(self, description: S) -> InstrumentBuilder<'a, T>

where S: Into<Cow<'static, str>>,

Set the description for this instrument

pub fn with_unit<S>(self, unit: S) -> InstrumentBuilder<'a, T>

where S: Into<Cow<'static, str>>,

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>>

pub fn build(self) -> Counter<u64>

Validates the instrument configuration and creates a new Counter<u64>. In case of invalid configuration, a no-op instrument is returned and an error is logged using internal logging.

impl<'a> InstrumentBuilder<'a, Counter<f64>>

pub fn build(self) -> Counter<f64>

Validates the instrument configuration and creates a new Counter<f64>. In case of invalid configuration, a no-op instrument is returned and an error is logged using internal logging.

impl<'a> InstrumentBuilder<'a, Gauge<u64>>

pub fn build(self) -> Gauge<u64>

Validates the instrument configuration and creates a new Gauge<u64>. In case of invalid configuration, a no-op instrument is returned and an error is logged using internal logging.

impl<'a> InstrumentBuilder<'a, Gauge<f64>>

pub fn build(self) -> Gauge<f64>

Validates the instrument configuration and creates a new Gauge<f64>. In case of invalid configuration, a no-op instrument is returned and an error is logged using internal logging.

impl<'a> InstrumentBuilder<'a, Gauge<i64>>

pub fn build(self) -> Gauge<i64>

Validates the instrument configuration and creates a new Gauge<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<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>>

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

impl<T> Debug for InstrumentBuilder<'_, T>

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

Formats the value using the given formatter.