Struct Histogram

pub struct Histogram {

    pub sample_count: Option<u64>,
    pub sample_count_float: Option<f64>,
    pub sample_sum: Option<f64>,
    pub bucket: Vec<Bucket>,
    pub created_timestamp: Option<Timestamp>,
    pub schema: Option<i32>,
    pub zero_threshold: Option<f64>,
    pub zero_count: Option<u64>,
    pub zero_count_float: Option<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>,
}

Fields

sample_count: Option<u64>

sample_count_float: Option<f64>

Overrides sample_count if > 0.

sample_sum: Option<f64>

bucket: Vec<Bucket>

Buckets for the conventional histogram.

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

created_timestamp: Option<Timestamp>

schema: Option<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: Option<f64>

Breadth of the zero bucket.

zero_count: Option<u64>

Count in zero bucket.

zero_count_float: Option<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.

Implementations

impl Histogram

pub fn sample_count(&self) -> u64

Returns the value of sample_count, or the default value if sample_count is unset.

pub fn sample_sum(&self) -> f64

Returns the value of sample_sum, or the default value if sample_sum is unset.

pub fn sample_count_float(&self) -> f64

Returns the value of sample_count_float, or the default value if sample_count_float is unset.

pub fn schema(&self) -> i32

Returns the value of schema, or the default value if schema is unset.

pub fn zero_threshold(&self) -> f64

Returns the value of zero_threshold, or the default value if zero_threshold is unset.

pub fn zero_count(&self) -> u64

Returns the value of zero_count, or the default value if zero_count is unset.

pub fn zero_count_float(&self) -> f64

Returns the value of zero_count_float, or the default value if zero_count_float is unset.

Trait Implementations

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Histogram

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

Formats the value using the given formatter.

impl Default for Histogram

fn default() -> Self

Returns the “default value” for a type.

impl Message for Histogram

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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.

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.

impl Name for Histogram

const NAME: &'static str = "Histogram"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "io.prometheus.client"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for Histogram

fn eq(&self, other: &Histogram) -> 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 Histogram