Skip to main content

MetricDef

Struct MetricDef 

Source
pub struct MetricDef {
Show 15 fields pub formula_cel: String, pub scope: Scope, pub value_type: String, pub label: Option<String>, pub name: Option<String>, pub short: Option<String>, pub description: Option<String>, pub remediation: Option<String>, pub formula_pretty: Option<String>, pub formula_js: Option<String>, pub direction: Option<String>, pub group: Option<String>, pub omit_at: f64, pub warning: Option<f64>, pub info: Option<f64>,
}
Expand description

One metric definition: a CEL formula plus the spec fields needed to emit it as a first-class, sortable, delta-coloured attribute. Spec fields are optional so a quick user formula needs only formula_cel.

Fields§

§formula_cel: String

CEL expression over other metric keys + the registered math functions.

§scope: Scope§value_type: String§label: Option<String>§name: Option<String>§short: Option<String>§description: Option<String>§remediation: Option<String>

How to fix a breach — the fix line in check diagnostics.

§formula_pretty: Option<String>

Human-readable formula shown in the viewer (display only).

§formula_js: Option<String>

JS expression the viewer re-runs with the node’s values to show the live “formula = numbers” line. When omitted, a node-scope metric falls back to its CEL formula_cel — valid JS for plain arithmetic / ternaries; if it uses CEL-only host functions (log2, pow, …) the viewer simply skips the line. Set formula_js explicitly to control it.

§direction: Option<String>

lower_better / higher_better.

§group: Option<String>§omit_at: f64

No-signal value at which the metric is omitted (the registry [defaults] omit_at when unset).

§warning: Option<f64>

Two-tier severity thresholds (the warning / info limits the scorecard and viewer badge against, like a built-in metric). When either is set the metric carries a Thresholds in its spec; the other tier falls back to it. Distinct from the [rules.thresholds.file] single-tier check gate.

§info: Option<f64>

Implementations§

Source§

impl MetricDef

Source

pub fn to_attribute_spec(&self) -> AttributeSpec

The viewer-facing AttributeSpec for this metric, so a config-defined metric renders as a named, sortable, delta-coloured column like any built-in — including the live “formula = numbers” tooltip line, driven by formula_js (defaulted from the CEL formula_cel for node-scope metrics).

Trait Implementations§

Source§

impl Clone for MetricDef

Source§

fn clone(&self) -> MetricDef

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 MetricDef

Source§

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

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

impl Default for MetricDef

Source§

fn default() -> MetricDef

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MetricDef

Source§

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

Deserialize this value from the given Serde deserializer. 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> AnyExt for T
where T: Any + ?Sized,

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T> AsDebug for T
where T: Debug,

Source§

fn as_debug(&self) -> &dyn Debug

Returns self as a &dyn Debug trait object.
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<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, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

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

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.