Struct tremor_otelapis::opentelemetry::proto::metrics::v1::Metric

pub struct Metric {
    pub name: String,
    pub description: String,
    pub unit: String,
    pub data: Option<Data>,
}

Defines a Metric which has one or more timeseries.

The data model and relation between entities is shown in the diagram below. Here, “DataPoint” is the term used to refer to any one of the specific data point value types, and “points” is the term used to refer to any one of the lists of points contained in the Metric.

• Metric is composed of a metadata and data.

• Metadata part contains a name, description, unit.

• Data is one of the possible types (Gauge, Sum, Histogram, etc.).

• DataPoint contains timestamps, labels, and one of the possible value type fields.

  Metric +————+ |name | |description | |unit | +————————————+ |data |—> |Gauge, Sum, Histogram, Summary, … | +————+ +————————————+

  Data [One of Gauge, Sum, Histogram, Summary, …] +———–+ |… | // Metadata about the Data. |points |–+ +———–+ | | +—————————+ | |DataPoint 1 | v |+——+——+ +——+ | +—–+ ||label |label |…|label | | | 1 |–>||value1|value2|…|valueN| | +—–+ |+——+——+ +——+ | | . | |+—–+ | | . | ||value| | | . | |+—–+ | | . | +—————————+ | . | . | . | . | . | . | . | +—————————+ | . | |DataPoint M | +—–+ |+——+——+ +——+ | | M |–>||label |label |…|label | | +—–+ ||value1|value2|…|valueN| | |+——+——+ +——+ | |+—–+ | ||value| | |+—–+ | +—————————+

All DataPoint types have three common fields:

• Labels zero or more key-value pairs associated with the data point.
• StartTimeUnixNano MUST be set to the start of the interval when the data’s type includes an AggregationTemporality. This field is not set otherwise.
• TimeUnixNano MUST be set to:
  • the moment when an aggregation is reported (independent of the aggregation temporality).
  • the instantaneous time of the event.

Fields

name: String

name of the metric, including its DNS name prefix. It must be unique.

description: String

description of the metric, which can be used in documentation.

unit: String

unit in which the metric value is reported. Follows the format described by http://unitsofmeasure.org/ucum.html.

data: Option<Data>

Data determines the aggregation type (if any) of the metric, what is the reported value type for the data points, as well as the relatationship to the time interval over which they are reported.

TODO: Update table after the decision on: https://github.com/open-telemetry/opentelemetry-specification/issues/731. By default, metrics recording using the OpenTelemetry API are exported as (the table does not include MeasurementValueType to avoid extra rows):

Instrument Type

Counter Sum(aggregation_temporality=delta;is_monotonic=true) UpDownCounter Sum(aggregation_temporality=delta;is_monotonic=false) ValueRecorder TBD SumObserver Sum(aggregation_temporality=cumulative;is_monotonic=true) UpDownSumObserver Sum(aggregation_temporality=cumulative;is_monotonic=false) ValueObserver Gauge()

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl Default for Metric

fn default() -> Self

Returns the “default value” for a type.

impl Message for Metric

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

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

Decodes an instance of the message from a buffer.

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

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

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

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

impl PartialEq<Metric> for Metric

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Metric