Struct SummaryDataPoint

pub struct SummaryDataPoint {
    pub attributes: Vec<KeyValue>,
    pub start_time_unix_nano: u64,
    pub time_unix_nano: u64,
    pub count: u64,
    pub sum: f64,
    pub quantile_values: Vec<ValueAtQuantile>,
    pub flags: u32,
}

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

SummaryDataPoint is a single data point in a timeseries that describes the time-varying values of a Summary metric.

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.

sum: 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#summary

quantile_values: Vec<ValueAtQuantile>

(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.

flags: u32

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

Trait Implementations

impl Clone for SummaryDataPoint

fn clone(&self) -> SummaryDataPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryDataPoint

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

Formats the value using the given formatter.

impl Default for SummaryDataPoint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SummaryDataPoint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SummaryDataPoint

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 SummaryDataPoint

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

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 SummaryDataPoint