Struct Histogram

pub struct Histogram { /* private fields */ }

OpenMetrics Histogram to track distributions of values.

Implementations

impl Histogram

pub fn new(buckets: Vec<f64>) -> Self

Constructs a new histogram with the given bucket boundaries.

The buckets parameter defines the upper bounds for each bucket. Buckets should be in ascending order. An infinity bucket is automatically added if not present to ensure all observations are captured.

pub fn observe(&self, value: f64)

Records a value in the histogram.

pub fn count(&self) -> u64

Returns the total count of observations.

pub fn sum(&self) -> f64

Returns the sum of all observed values.

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

Returns the bucket counts as a vector of (upper_bound, cumulative_count) pairs.

The counts are cumulative, meaning each bucket contains the count of all observations less than or equal to its upper bound.

pub fn percentile(&self, p: f64) -> f64

Calculates the approximate percentile value.

Returns the bucket upper bound where the percentile falls. For example, percentile(0.99) returns the p99 value.

Trait Implementations

impl Debug for Histogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Histogram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Metric for Histogram

fn type(&self) -> MetricType

Returns the type of this metric.

fn value(&self) -> MetricValue

Returns the current value of this metric.

fn as_any(&self) -> &dyn Any

Casts this metric to Any for downcasting to concrete types.

impl Serialize for Histogram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.