Struct NativeHistogram 

pub struct NativeHistogram {
    pub schema: i32,
    pub zero_threshold: f64,
    pub sum: f64,
    pub reset_hint: CounterResetHint,
    pub start_timestamp: Option<i64>,
    pub custom_values: Vec<f64>,
    pub positive_spans: Vec<Span>,
    pub negative_spans: Vec<Span>,
    pub count: f64,
    pub zero_count: f64,
    pub positive_buckets: Vec<f64>,
    pub negative_buckets: Vec<f64>,
}

Query-time representation of a Prometheus native histogram.

Bucket counts are absolute f64 values even when the persisted payload used integer counts or deltas.

Fields

schema: i32

Exponential bucket schema, or CUSTOM_BUCKETS_SCHEMA.

zero_threshold: f64

Absolute width of the zero bucket.

sum: f64

Sum of all observations.

reset_hint: CounterResetHint

Counter reset information associated with this sample.

start_timestamp: Option<i64>

Optional time in milliseconds when this histogram started counting.

custom_values: Vec<f64>

Inclusive upper bounds used when schema is CUSTOM_BUCKETS_SCHEMA.

positive_spans: Vec<Span>

Sparse spans describing positive or custom buckets.

negative_spans: Vec<Span>

Sparse spans describing negative buckets.

count: f64

Total number of observations.

zero_count: f64

Number of observations in the zero bucket.

positive_buckets: Vec<f64>

Absolute counts for positive or custom buckets.

negative_buckets: Vec<f64>

Absolute counts for negative buckets.

Implementations

impl NativeHistogram

fn uses_custom_buckets(&self) -> bool

fn compatible_with(&self, other: &Self) -> bool

pub fn zero_like(&self) -> Self

Returns a histogram with the same layout and metadata but zeroed payload values.

fn combine_exact( &self, other: &Self, reset_hint: CounterResetHint, op: impl Fn(f64, f64) -> f64 + Copy, ) -> Option<Self>

pub fn add(&self, other: &Self) -> Option<Self>

Adds two histograms after reconciling compatible bucket layouts.

Returns None when the layouts are invalid or cannot be reconciled.

pub fn sub(&self, other: &Self) -> Option<Self>

Subtracts other after reconciling compatible bucket layouts.

Returns None when the layouts are invalid or cannot be reconciled.

pub fn negated(self) -> Self

Negates every payload value and marks the result as a gauge histogram.

pub fn into_gauge(self) -> Self

Marks this histogram as a gauge without changing its payload.

pub fn counter_reset_hints_contradict(&self, other: &Self) -> bool

Returns whether the histograms carry explicit, contradictory reset hints.

pub fn needs_custom_reconciliation(&self, other: &Self) -> bool

Returns whether two custom histograms use different bucket bounds.

pub fn promql_eq(&self, other: &Self) -> bool

Compares PromQL-visible payload values by their exact bit patterns.

Reset hints and start timestamps are ignored.

pub fn promql_string(&self) -> String

Formats this histogram using PromQL native histogram sample notation.

pub fn estimated_stdvar(&self) -> f64

Estimates the population variance using each populated bucket’s midpoint.

pub fn estimated_stddev(&self) -> f64

Estimates the population standard deviation from Self::estimated_stdvar.

pub fn scale(self, factor: f64) -> Self

Multiplies every payload value by factor.

A negative factor marks the result as a gauge histogram.

pub fn divide_by(self, divisor: f64) -> Self

Divides every payload value by divisor.

A negative divisor marks the result as a gauge histogram.

fn compact(self) -> Option<Self>

pub fn detect_reset(&self, previous: &Self) -> bool

Detects a reset from the explicit hint and histogram payload.

fn detect_start_timestamp_reset( &self, previous: &Self, previous_ts: i64, current_ts: i64, ) -> bool

pub fn detect_counter_reset( &self, previous: &Self, previous_ts: i64, current_ts: i64, ) -> bool

Detects a counter reset using start timestamps, hints, and payload values.

fn all_buckets(&self) -> Option<Vec<Bucket>>

fn side_buckets(&self, positive: bool) -> Option<Vec<Bucket>>

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

Estimates the value at quantile q.

Returns negative or positive infinity outside [0, 1], and NaN when the quantile cannot be estimated.

pub fn fraction(&self, lower: f64, upper: f64) -> f64

Estimates the fraction of observations between lower and upper.

pub fn to_prometheus_buckets(&self) -> Option<Vec<(u8, String, String, String)>>

Converts populated buckets to (boundary rule, lower, upper, count) strings.

fn interpolate_rank( &self, bucket: &Bucket, rank: f64, value: f64, zero_bucket: bool, ) -> f64

fn bucket_midpoint(&self, bucket: &Bucket) -> f64

fn side_has_reset(&self, positive: bool, previous: &Self) -> bool

fn reconcile(&self, other: &Self) -> Option<(Self, Self)>

impl NativeHistogram

fn copy_to_schema(&self, target_schema: i32) -> Option<Self>

fn copy_to_custom_values(&self, custom_values: Vec<f64>) -> Option<Self>

fn grow_zero_threshold(&mut self, zero_threshold: f64) -> Option<()>

fn expanded_zero_threshold(&self, zero_threshold: f64) -> Option<f64>

Trait Implementations

impl Clone for NativeHistogram

fn clone(&self) -> NativeHistogram

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NativeHistogram

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

Formats the value using the given formatter.

impl PartialEq for NativeHistogram

fn eq(&self, other: &NativeHistogram) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NativeHistogram