Skip to main content

Histogram

Struct Histogram 

Source
pub struct Histogram { /* private fields */ }
Expand description

A fixed-bucket histogram with thread-sharded counters.

Buckets are defined by upper bounds (inclusive). Values are placed in the first bucket whose bound is >= the value. Values exceeding all bounds go in the final “+Inf” bucket.

Implementations§

Source§

impl Histogram

Source

pub fn new(bounds: &[u64], shard_count: usize) -> Self

Create a histogram with the given bucket boundaries.

Boundaries should be sorted ascending. Each boundary represents the upper bound (inclusive) of a bucket. An implicit +Inf bucket is added.

shard_count is passed to each underlying Counter.

Source

pub fn with_latency_buckets(shard_count: usize) -> Self

Create a histogram with default latency buckets (in microseconds).

Buckets: 10µs, 50µs, 100µs, 500µs, 1ms, 5ms, 10ms, 50ms, 100ms, 500ms, 1s, 5s, 10s

Source

pub fn record(&self, value: u64)

Record a value in the histogram.

Source

pub fn buckets_cumulative(&self) -> Vec<(u64, u64)>

Get cumulative bucket counts – for Prometheus exposition.

Returns pairs of (upper_bound, cumulative_count). The last entry has bound u64::MAX representing +Inf.

Prefer Self::buckets_cumulative_iter on the export path; it avoids the Vec allocation per call.

Source

pub fn buckets_cumulative_iter(&self) -> impl Iterator<Item = (u64, u64)> + '_

Iterator form of Self::buckets_cumulative that skips the Vec allocation. Used by the Prometheus and OTLP export paths.

Source

pub fn sum(&self) -> u64

Source

pub fn count(&self) -> u64

Trait Implementations§

Source§

impl ClickHouseExport for Histogram

Source§

fn export_clickhouse( &self, batch: &mut ClickHouseMetricBatch, name: &str, description: &str, time_unix_nano: u64, )

Source§

impl DogStatsDExport for Histogram

Source§

fn export_dogstatsd( &self, output: &mut String, name: &str, tags: &[(&str, &str)], )

Export histogram as count + sum metrics.

DogStatsD distributions expect raw samples, not pre-aggregated buckets. We export name.count and name.sum as counters instead.

Source§

impl HistogramSnapshot for Histogram

Source§

fn count(&self) -> u64

Source§

fn sum(&self) -> u64

Source§

fn visit_buckets(&self, visitor: &mut dyn FnMut(u64, u64))

Source§

impl OtlpExport for Histogram

Source§

fn export_otlp( &self, metrics: &mut Vec<Metric>, name: &str, description: &str, time_unix_nano: u64, )

Source§

impl PrometheusExport for Histogram

Source§

fn export_prometheus(&self, output: &mut String, name: &str, help: &str)

Export this metric to the output string. Read more

Auto Trait Implementations§

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

Source§

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

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

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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