Enum MetricValue

Source

pub enum MetricValue {
    Counter {
        value: f64,
    },
    Gauge {
        value: f64,
    },
    Set {
        values: BTreeSet<String>,
    },
    Distribution {
        samples: Vec<Sample>,
        statistic: StatisticKind,
    },
    AggregatedHistogram {
        buckets: Vec<Bucket>,
        count: u64,
        sum: f64,
    },
    AggregatedSummary {
        quantiles: Vec<Quantile>,
        count: u64,
        sum: f64,
    },
    Sketch {
        sketch: MetricSketch,
    },
}

Expand description

Metric value. Container for the actual value of a metric.

Variants§

§

Counter

A cumulative numerical value that can only increase or be reset to zero.

Fields

§value: f64

The value of the counter.

§

Gauge

A single numerical value that can arbitrarily go up and down.

Fields

§value: f64

The value of the gauge.

§

Set

A set of (unordered) unique values for a key.

Fields

§values: BTreeSet<String>

The values in the set.

§

Distribution

A set of observations without any aggregation or sampling.

Fields

§samples: Vec<Sample>

The observed values within this distribution.

§statistic: StatisticKind

The type of statistics to derive for this distribution.

§

AggregatedHistogram

A set of observations which are counted into buckets.

It also contains the total count of all observations and their sum to allow calculating the mean.

Fields

§buckets: Vec<Bucket>

The buckets within this histogram.

§count: u64

The total number of observations contained within this histogram.

§sum: f64

The sum of all observations contained within this histogram.

§

AggregatedSummary

A set of observations which are represented by quantiles.

Each quantile contains the upper value of the quantile (0 <= φ <= 1). It also contains the total count of all observations and their sum to allow calculating the mean.

Fields

§quantiles: Vec<Quantile>

The quantiles measured from this summary.

§count: u64

The total number of observations contained within this summary.

§sum: f64

The sum of all observations contained within this histogram.

§

Sketch

A data structure that can answer questions about the cumulative distribution of the contained samples in space-efficient way.

Sketches represent the data in a way that queries over it have bounded error guarantees without needing to hold every single sample in memory. They are also, typically, able to be merged with other sketches of the same type such that client-side and server-side aggregation can be accomplished without loss of accuracy in the queries.

Fields

§sketch: MetricSketch

Enum MetricValueCopy item path

Variants§

Counter

Fields

Gauge

Fields

Set

Fields

Distribution

Fields

AggregatedHistogram

Fields

AggregatedSummary

Fields

Sketch

Fields

Implementations§

impl MetricValue

pub fn is_empty(&self) -> bool

pub fn as_name(&self) -> &'static str

pub fn distribution_to_agg_histogram( &self, buckets: &[f64], ) -> Option<MetricValue>

pub fn distribution_to_sketch(&self) -> Option<MetricValue>

pub fn zero(&mut self)

pub fn add(&mut self, other: &MetricValue) -> bool

pub fn subtract(&mut self, other: &MetricValue) -> bool

Trait Implementations§

impl AsRef<MetricValue> for Metric

fn as_ref(&self) -> &MetricValue

impl ByteSizeOf for MetricValue

fn allocated_bytes(&self) -> usize

fn size_of(&self) -> usize

impl Clone for MetricValue

fn clone(&self) -> MetricValue

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

impl Configurable for MetricValue

fn referenceable_name() -> Option<&'static str>

fn metadata() -> Metadata

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

fn is_optional() -> boolwhere Self: Sized,

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>where Self: Sized,

fn as_configurable_ref() -> ConfigurableRefwhere Self: Sized + 'static,

impl Debug for MetricValue

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

impl<'de> Deserialize<'de> for MetricValue

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

impl Display for MetricValue

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

impl From<AgentDDSketch> for MetricValue

fn from(ddsketch: AgentDDSketch) -> MetricValue

impl From<Value> for MetricValue

fn from(value: Value) -> MetricValue

impl From<MetricValue> for Value

fn from(value: MetricValue) -> Value

impl From<MetricValue> for Value

fn from(value: MetricValue) -> Value

impl PartialEq for MetricValue

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

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

impl Serialize for MetricValue

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

impl ToValue for MetricValue

fn to_value(&self) -> Value

Auto Trait Implementations§

impl Freeze for MetricValue

impl RefUnwindSafe for MetricValue

impl Send for MetricValue

impl Sync for MetricValue

impl Unpin for MetricValue

impl UnwindSafe for MetricValue

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

Enum MetricValue

fn is_optional() -> bool
where Self: Sized,

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>
where Self: Sized,

fn as_configurable_ref() -> ConfigurableRef
where Self: Sized + 'static,

fn deserialize<D>( deserializer: D, ) -> Result<MetricValue, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

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

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

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

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

fn conv<T>(self) -> T
where Self: Into<T>,

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

impl<D> DeserializeWith<JsonFormat> for D
where D: DeserializeOwned,

fn deserialize_with<'async_trait>( body: ResponseBody, ) -> Pin<Box<dyn Future<Output = Result<D, Error>> + Send + 'async_trait>>
where D: 'async_trait,

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

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

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

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

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,