Skip to main content

Histogram

pub struct Histogram {
Show 16 fields pub sample_count: u64, pub sample_count_float: f64, pub sample_sum: f64, pub bucket: Vec<Bucket>, pub start_timestamp: Option<Timestamp>, pub schema: i32, pub zero_threshold: f64, pub zero_count: u64, pub zero_count_float: f64, pub negative_span: Vec<BucketSpan>, pub negative_delta: Vec<i64>, pub negative_count: Vec<f64>, pub positive_span: Vec<BucketSpan>, pub positive_delta: Vec<i64>, pub positive_count: Vec<f64>, pub exemplars: Vec<Exemplar>,
}
Available on crate feature prometheus_protobuf only.

Fields§

§sample_count: u64§sample_count_float: f64

Overrides sample_count if > 0.

§sample_sum: f64§bucket: Vec<Bucket>

Buckets for the classic histogram.

Ordered in increasing order of upper_bound, +Inf bucket is optional.

§start_timestamp: Option<Timestamp>§schema: i32

schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8. They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and then each power of two is divided into 2^n logarithmic buckets. Or in other words, each bucket boundary is the previous boundary times 2^(2^-n). In the future, more bucket schemas may be added using numbers < -4 or > 8.

§zero_threshold: f64

Breadth of the zero bucket.

§zero_count: u64

Count in zero bucket.

§zero_count_float: f64

Overrides sb_zero_count if > 0.

§negative_span: Vec<BucketSpan>

Negative buckets for the native histogram.

§negative_delta: Vec<i64>

Use either “negative_delta” or “negative_count”, the former for regular histograms with integer counts, the latter for float histograms.

Count delta of each bucket compared to previous one (or to zero for 1st bucket).

§negative_count: Vec<f64>

Absolute count of each bucket.

§positive_span: Vec<BucketSpan>

Positive buckets for the native histogram. Use a no-op span (offset 0, length 0) for a native histogram without any observations yet and with a zero_threshold of 0. Otherwise, it would be indistinguishable from a classic histogram.

§positive_delta: Vec<i64>

Use either “positive_delta” or “positive_count”, the former for regular histograms with integer counts, the latter for float histograms.

Count delta of each bucket compared to previous one (or to zero for 1st bucket).

§positive_count: Vec<f64>

Absolute count of each bucket.

§exemplars: Vec<Exemplar>

Only used for native histograms. These exemplars MUST have a timestamp.

Trait Implementations§

Source§

impl Clone for Histogram

Source§

fn clone(&self) -> Histogram

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Histogram

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Histogram

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for Histogram

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl PartialEq for Histogram

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Histogram

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.