Struct vector::event::metric::Quantile

pub struct Quantile {
    pub quantile: f64,
    pub value: f64,
}

A single quantile observation.

Quantiles themselves are “cut points dividing the range of a probability distribution into continuous intervals with equal probabilities”. [1].

We use quantiles to measure the value along these probability distributions for representing client-side aggregations of distributions, which represent a collection of observations over a specific time window.

In general, we typically use the term “quantile” to represent the concept of percentiles, which deal with whole integers – 0, 1, 2, .., 99, 100 – even though quantiles are floating-point numbers and can represent higher-precision cut points, such as 0.9999, or the 99.99th percentile.

Fields

quantile: f64

The value of the quantile.

This value must be between 0.0 and 1.0, inclusive.

value: f64

The estimated value of the given quantile within the probability distribution.

Implementations

impl Quantile

pub fn to_percentile_string(&self) -> String

Renders this quantile as a string, scaled to be a percentile.

Up to four significant digits are maintained, but the resulting string will be without a decimal point.

For example, a quantile of 0.25, which represents a percentile of 25, will be rendered as “25” and a quantile of 0.9999, which represents a percentile of 99.99, will be rendered as “9999”. A quantile of 0.99999, which represents a percentile of 99.999, would also be rendered as “9999”, though.

pub fn to_quantile_string(&self) -> String

Renders this quantile as a string.

Up to four significant digits are maintained.

For example, a quantile of 0.25 will be rendered as “0.25”, and a quantile of 0.9999 will be rendered as “0.9999”, but a quantile of 0.99999 will be rendered as “0.9999”.

Trait Implementations

impl ByteSizeOf for Quantile

fn allocated_bytes(&self) -> usize

Returns the allocated bytes of this type

fn size_of(&self) -> usize

Returns the in-memory size of this type

impl Clone for Quantile

fn clone(&self) -> Quantile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for Quantile

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

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

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

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

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

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for Quantile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Quantile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Quantile> for SummaryQuantile

fn from(quantile: Quantile) -> SummaryQuantile

Converts to this type from the input type.

impl From<SummaryQuantile> for Quantile

fn from(quantile: SummaryQuantile) -> Quantile

Converts to this type from the input type.

impl PartialEq for Quantile

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Quantile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for Quantile

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Copy for Quantile