Skip to main content

LabeledHistogram

Struct LabeledHistogram 

Source
pub struct LabeledHistogram<L: LabelEnum> { /* private fields */ }
Expand description

A histogram indexed by an enum label, providing O(1) dimensional metrics.

Each label variant has its own histogram with independent buckets.

§Example

use fast_telemetry::{LabeledHistogram, LabelEnum};

#[derive(Copy, Clone, Debug)]
enum Endpoint { Api, Auth, Static }

impl LabelEnum for Endpoint {
    const CARDINALITY: usize = 3;
    const LABEL_NAME: &'static str = "endpoint";

    fn as_index(self) -> usize { self as usize }
    fn from_index(index: usize) -> Self {
        match index {
            0 => Self::Api, 1 => Self::Auth, _ => Self::Static,
        }
    }
    fn variant_name(self) -> &'static str {
        match self {
            Self::Api => "api", Self::Auth => "auth", Self::Static => "static",
        }
    }
}

let histogram: LabeledHistogram<Endpoint> = LabeledHistogram::with_latency_buckets(4);
histogram.record(Endpoint::Api, 150);    // 150µs
histogram.record(Endpoint::Auth, 2000);  // 2ms

// Iteration for export
for (label, buckets, sum, count) in histogram.iter() {
    println!("{}={}: count={}", Endpoint::LABEL_NAME, label.variant_name(), count);
}

Implementations§

Source§

impl<L: LabelEnum> LabeledHistogram<L>

Source

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

Create a labeled histogram with custom bucket boundaries.

Each label variant gets its own histogram with these boundaries.

Source

pub fn with_latency_buckets(shard_count: usize) -> Self

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

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

Source

pub fn record(&self, label: L, value: u64)

Record a value in the histogram for the given label.

Source

pub fn get(&self, label: L) -> &Histogram

Get the histogram for a specific label (for detailed inspection).

Source

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

Iterate over all label/histogram data for export.

Returns (label, cumulative_buckets, sum, count) for each variant.

Trait Implementations§

Source§

impl<L: LabelEnum> DogStatsDExport for LabeledHistogram<L>

Source§

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

Export this metric to the output string in DogStatsD format. Read more
Source§

impl<L: LabelEnum> OtlpExport for LabeledHistogram<L>

Source§

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

Source§

impl<L: LabelEnum> PrometheusExport for LabeledHistogram<L>

Source§

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

Export this metric to the output string. Read more

Auto Trait Implementations§

§

impl<L> Freeze for LabeledHistogram<L>

§

impl<L> RefUnwindSafe for LabeledHistogram<L>
where L: RefUnwindSafe,

§

impl<L> Send for LabeledHistogram<L>
where L: Send,

§

impl<L> Sync for LabeledHistogram<L>
where L: Sync,

§

impl<L> Unpin for LabeledHistogram<L>
where L: Unpin,

§

impl<L> UnsafeUnpin for LabeledHistogram<L>

§

impl<L> UnwindSafe for LabeledHistogram<L>
where L: UnwindSafe,

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