Skip to main content

HistogramSummary

saluki_core::data_model::event::metric

Struct HistogramSummary

pub struct HistogramSummary<'a> { /* private fields */ }

Expand description

Summary view over a Histogram.

Implementations§

impl HistogramSummary<'_>

pub fn count(&self) -> u64

Returns the number of samples in the histogram.

This is adjusted by the weight of each sample, based on the sample rate given during insertion.

The underlying weight accumulation uses compensated (Neumaier) summation over float weights, and the result is rounded to the nearest integer. For standard sample rates whose reciprocals are exact integers (for example, 0.1, 0.25, 0.5, 1.0) rounding has no effect; for non-integer-reciprocal rates (for example, 0.21 → weight ≈ 4.762) it gives a closer approximation than truncation.

pub fn sum(&self) -> f64

Returns the sum of all samples in the histogram.

This is adjusted by the weight of each sample, based on the sample rate given during insertion.

pub fn min(&self) -> Option<f64>

Returns the minimum value in the histogram.

If the histogram is empty, None will be returned.

pub fn max(&self) -> Option<f64>

Returns the maximum value in the histogram.

If the histogram is empty, None will be returned.

pub fn avg(&self) -> f64

Returns the average value in the histogram.

pub fn median(&self) -> Option<f64>

Returns the median value in the histogram.

If the histogram is empty, None will be returned.

pub fn quantile(&self, quantile: f64) -> Option<f64>

Returns the given quantile in the histogram.

If the histogram is empty, or if quantile is less than 0.0 or greater than 1.0, None will be returned.

Auto Trait Implementations§

impl<'a> Freeze for HistogramSummary<'a>

impl<'a> RefUnwindSafe for HistogramSummary<'a>

impl<'a> Send for HistogramSummary<'a>

impl<'a> Sync for HistogramSummary<'a>

impl<'a> Unpin for HistogramSummary<'a>

impl<'a> UnsafeUnpin for HistogramSummary<'a>

impl<'a> UnwindSafe for HistogramSummary<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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

type Output = T

Should always be Self

impl<T> Track for T

fn track_resources(self, token: ResourceGroupToken) -> Tracked<Self>

Instruments this type by attaching the given resource group token, returning a Tracked wrapper. Read more

fn in_current_resource_group(self) -> Tracked<Self>

Instruments this type by attaching the current resource group, returning a Tracked wrapper. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

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