Struct ore::metrics::ThirdPartyMetric

pub struct ThirdPartyMetric<T: Collector + Clone> {
    pub(super) inner: T,
}

This is supported on crate feature metrics only.

A metric that can be made accessible to cloud infrastructure/orchestrators, that won’t betray the contents of the materialize instance that it details.

Fields

inner: T

Implementations

impl<T: MetricVecBuilder> ThirdPartyMetric<MetricVec<T>>

pub fn get_third_party_metric_with_label_values(
    &self,
    vals: &[&str]
) -> Result<T::M, Error>

Creates a metric that can be scraped by a third party, with the given label values.

pub fn third_party_metric_with_label_values(&self, vals: &[&str]) -> T::M

Creates a metric that can be scraped by a third party, with the given label values.

Panics

Panics if the metric can not be created.

impl<P: Atomic> ThirdPartyMetric<GenericCounterVec<P>>

pub fn get_third_party_delete_on_drop_counter<'a, L: PromLabelsExt<'a>>(
    &self,
    labels: L
) -> DeleteOnDropCounter<'a, P, L>

Creates a delete-on-drop counter that can be scraped by third parties.

impl<P: Atomic> ThirdPartyMetric<GenericGaugeVec<P>>

pub fn get_third_party_delete_on_drop_gauge<'a, L: PromLabelsExt<'a>>(
    &self,
    labels: L
) -> DeleteOnDropGauge<'a, P, L>

Creates a delete-on-drop gauge that can be scraped by third parties.

Methods from Deref<Target = GenericCounter<T>>

pub fn fq_name(&self) -> &str

The fully qualified name for this counter

This is the name with no labels, and corresponds to desc().fq_name on the Collector trait.

pub fn inc_by(&self, v: <P as Atomic>::T)

Increase the given value to the counter.

Panics

Panics in debug build if the value is < 0.

pub fn inc(&self)

Increase the counter by 1.

pub fn get(&self) -> <P as Atomic>::T

Return the counter value.

pub fn reset(&self)

Restart the counter, resetting its value back to 0.

pub fn local(&self) -> GenericLocalCounter<P>

Return a GenericLocalCounter for single thread usage.

Trait Implementations

impl<T: Clone + Collector> Clone for ThirdPartyMetric<T>

fn clone(&self) -> ThirdPartyMetric<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Collector + Clone> Debug for ThirdPartyMetric<T>

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

Formats the value using the given formatter.

impl<T> Deref for ThirdPartyMetric<GenericCounter<T>> where
    T: Atomic + 'static, 

type Target = GenericCounter<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Deref for ThirdPartyMetric<GenericGauge<T>> where
    T: Atomic + 'static, 

type Target = GenericGauge<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for ThirdPartyMetric<Histogram>

type Target = Histogram

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.