Struct opentelemetry::metrics::InstrumentBuilder

source ·
pub struct InstrumentBuilder<'a, T> { /* private fields */ }
Expand description

Configuration for building a sync instrument.

Implementations§

source§

impl<'a, T> InstrumentBuilder<'a, T>
where T: TryFrom<Self, Error = MetricsError>,

source

pub fn with_description<S: Into<Cow<'static, str>>>( self, description: S, ) -> Self

Set the description for this instrument

source

pub fn with_unit(self, unit: Unit) -> Self

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
source

pub fn try_init(self) -> Result<T>

Validate the instrument configuration and creates a new instrument.

source

pub fn init(self) -> T

Creates a new instrument.

Validate the instrument configuration and crates a new instrument.

§Panics

Panics if the instrument cannot be created. Use try_init if you want to handle errors.

Trait Implementations§

source§

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

source§

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

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

impl TryFrom<InstrumentBuilder<'_, Counter<f64>>> for Counter<f64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Counter<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Counter<u64>>> for Counter<u64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Counter<u64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Gauge<f64>>> for Gauge<f64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Gauge<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Gauge<i64>>> for Gauge<i64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Gauge<i64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Gauge<u64>>> for Gauge<u64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Gauge<u64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Histogram<f64>>> for Histogram<f64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Histogram<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, Histogram<u64>>> for Histogram<u64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, Histogram<u64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, UpDownCounter<f64>>> for UpDownCounter<f64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, UpDownCounter<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<InstrumentBuilder<'_, UpDownCounter<i64>>> for UpDownCounter<i64>

source§

type Error = MetricsError

The type returned in the event of a conversion error.
source§

fn try_from( builder: InstrumentBuilder<'_, UpDownCounter<i64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

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> 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, 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 = 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.