Struct Exemplar

#[non_exhaustive]
pub struct Exemplar {
    pub value: f64,
    pub timestamp: Option<Timestamp>,
    pub attachments: Vec<Any>,
}

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: f64

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

timestamp: Option<Timestamp>

The observation (sampling) time of the above value.

attachments: Vec<Any>

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

Implementations

impl Exemplar

pub fn set_value<T: Into<f64>>(self, v: T) -> Self

Sets the value of value.

pub fn set_timestamp<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of timestamp.

pub fn set_attachments<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Any>,

Sets the value of attachments.

Trait Implementations

impl Clone for Exemplar

fn clone(&self) -> Exemplar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Exemplar

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

Formats the value using the given formatter.

impl Default for Exemplar

fn default() -> Exemplar

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Exemplar

where Exemplar: 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 Exemplar

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Exemplar

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

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 Exemplar