Struct HistogramBuilder

#[non_exhaustive]
pub struct HistogramBuilder<'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>>, pub boundaries: Option<Vec<f64>>, /* private fields */ }
Expand description

Configuration for building a Histogram.

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

§description: Option<Cow<'static, str>>

Description of the Histogram.

§unit: Option<Cow<'static, str>>

Unit of the Histogram.

§boundaries: Option<Vec<f64>>

Bucket boundaries for the histogram.

Implementations§

§

impl<'a, T> HistogramBuilder<'a, T>

pub fn with_description<S>(self, description: S) -> HistogramBuilder<'a, T>
where S: Into<Cow<'static, str>>,

Set the description for this instrument

pub fn with_unit<S>(self, unit: S) -> HistogramBuilder<'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

pub fn with_boundaries(self, boundaries: Vec<f64>) -> HistogramBuilder<'a, T>

Set the boundaries for this histogram.

Setting boundaries is optional. By default, the boundaries are set to:

[0.0, 5.0, 10.0, 25.0, 50.0, 75.0, 100.0, 250.0, 500.0, 750.0, 1000.0, 2500.0, 5000.0, 7500.0, 10000.0]

§Notes
  • Boundaries must not contain f64::NAN, f64::INFINITY or f64::NEG_INFINITY
  • Values must be in strictly increasing order (e.g., each value must be greater than the previous).
  • Boundaries must not contain duplicate values.

If invalid boundaries are provided, the instrument will not report measurements. Providing an empty vec![] means no bucket information will be calculated.

§Warning

Using more buckets can improve the accuracy of percentile calculations in backends. However, this comes at a cost, including increased memory, CPU, and network usage. Choose the number of buckets carefully, considering your application’s performance and resource requirements.

§

impl HistogramBuilder<'_, Histogram<f64>>

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

Creates a new instrument.

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

§

impl HistogramBuilder<'_, Histogram<u64>>

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

Creates a new instrument.

Validates the instrument configuration and creates a new instrument. 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 HistogramBuilder<'_, T>

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for HistogramBuilder<'a, T>

§

impl<'a, T> !RefUnwindSafe for HistogramBuilder<'a, T>

§

impl<'a, T> !Send for HistogramBuilder<'a, T>

§

impl<'a, T> !Sync for HistogramBuilder<'a, T>

§

impl<'a, T> Unpin for HistogramBuilder<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for HistogramBuilder<'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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

type Error = <U as RamaTryFrom<T>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

type Error = <U as RamaTryFrom<T>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,