Skip to main content

MetricSpec

Struct MetricSpec 

Source
pub struct MetricSpec {
    pub value: String,
    pub family: Option<String>,
    pub kind: Option<MetricKind>,
    pub unit: Option<String>,
    pub format: Option<String>,
    pub cell: BTreeMap<String, String>,
}
Expand description

SRD-40b §1 schema for one synthetic-metric declaration on an op template.

Fields§

§value: String

Required. A Polydat expression evaluated in the op’s bound scope. A bare binding name is the canonical form when the formula belongs in a bindings: block; any GK expression that produces a numeric result is also valid. See SRD-40b §4.

§family: Option<String>

Optional override of the family name. Defaults to the map key on ParsedOp.metrics. SRD-40b §1.

§kind: Option<MetricKind>

Optional metric type. Defaults to Gauge per SRD-40b §1.

§unit: Option<String>

Optional OpenMetrics unit suffix (ms, bytes, …). When set, lands in BOTH the family-name suffix and the metric_family.unit column per SRD-40a §4.3.

§format: Option<String>

Optional generation-time numeric sanitiser using Excel-style hash patterns (#.##, 0.000, etc.). Translated at registration time into a round op that runs before the value is recorded on the instrument; storage holds the sanitised number. SRD-40b §1.

§cell: BTreeMap<String, String>

Optional dimensional placement: dimension name → a Polydat expression producing that dimension’s value for this sample.

A metric identity is its label set with the family name promoted into it, a closed 1:1 association. cell: therefore does not attach a label to a sample — it selects the dimensional CELL the sample belongs to, REFINING the identity its registration site already composes. One value per cell, one family per cell, and the existing duplicate-family check keeps working unchanged.

BTreeMap so synthesis order is deterministic: the coordinate’s rendering is what keys a cell, and a map that iterated differently between runs would key the same coordinate two ways.

Trait Implementations§

Source§

impl Clone for MetricSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetricSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MetricSpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MetricSpec

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.