Struct HistogramDataPoint

pub struct HistogramDataPoint {
    pub attributes: Vec<KeyValue>,
    pub start_time_unix_nano: u64,
    pub time_unix_nano: u64,
    pub count: u64,
    pub sum: Option<f64>,
    pub bucket_counts: Vec<u64>,
    pub explicit_bounds: Vec<f64>,
    pub exemplars: Vec<Exemplar>,
    pub flags: u32,
    pub min: Option<f64>,
    pub max: Option<f64>,
}

Available on crate features gen-tonic-messages and metrics only.

HistogramDataPoint is a single data point in a timeseries that describes the time-varying values of a Histogram. A Histogram contains summary statistics for a population of values, it may optionally contain the distribution of those values across a set of buckets.

If the histogram contains the distribution of values, then both “explicit_bounds” and “bucket counts” fields must be defined. If the histogram does not contain the distribution of values, then both “explicit_bounds” and “bucket_counts” must be omitted and only “count” and “sum” are known.

Fields

attributes: Vec<KeyValue>

The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements). Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

start_time_unix_nano: u64

StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

time_unix_nano: u64

TimeUnixNano is required, see the detailed comments above Metric.

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

count: u64

count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the “count” fields in buckets if a histogram is provided.

sum: Option<f64>

sum of the values in the population. If count is zero then this field must be zero.

Note: Sum should only be filled out when measuring non-negative discrete events, and is assumed to be monotonic over the values of these events. Negative events can be recorded, but sum should not be filled out when doing so. This is specifically to enforce compatibility w/ OpenMetrics, see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram

bucket_counts: Vec<u64>

bucket_counts is an optional field contains the count values of histogram for each bucket.

The sum of the bucket_counts must equal the value in the count field.

The number of elements in bucket_counts array must be by one greater than the number of elements in explicit_bounds array.

explicit_bounds: Vec<f64>

explicit_bounds specifies buckets with explicitly defined bounds for values.

The boundaries for bucket at index i are:

(-infinity, explicit_bounds[i]] for i == 0 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds) (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)

The values in the explicit_bounds array must be strictly increasing.

Histogram buckets are inclusive of their upper boundary, except the last bucket where the boundary is at infinity. This format is intentionally compatible with the OpenMetrics histogram definition.

exemplars: Vec<Exemplar>

(Optional) List of exemplars collected from measurements that were used to form the data point

flags: u32

Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.

min: Option<f64>

min is the minimum value over (start_time, end_time].

max: Option<f64>

max is the maximum value over (start_time, end_time].

Implementations

impl HistogramDataPoint

pub fn sum(&self) -> f64

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

pub fn min(&self) -> f64

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

pub fn max(&self) -> f64

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

Trait Implementations

impl Clone for HistogramDataPoint

fn clone(&self) -> HistogramDataPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramDataPoint

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

Formats the value using the given formatter.

impl Default for HistogramDataPoint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistogramDataPoint

where HistogramDataPoint: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for HistogramDataPoint

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 PartialEq for HistogramDataPoint

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HistogramDataPoint