Struct opentelemetry::sdk::metrics::aggregators::DDSKetchAggregator

pub struct DDSKetchAggregator { /* fields omitted */ }

This is supported on crate feature metrics only.

DDSKetch quantile sketch algorithm

It can give q-quantiles with α-accurate for any 0<=q<=1.

Here the accurate is calculated based on relative-error rate. Thus, the error guarantee adapts the scale of the output data. With relative error guarantee, the histogram can be more accurate in the area of low data density. For example, the long tail of response time data.

For example, if the actual percentile is 1 second, and relative-error guarantee is 2%, then the value should within the range of 0.98 to 1.02 second. But if the actual percentile is 1 millisecond, with the same relative-error guarantee, the value returned should within the range of 0.98 to 1.02 millisecond.

In order to support both negative and positive inputs, DDSketchAggregator has two DDSketch store within itself to store the negative and positive inputs.

Implementations

impl DDSKetchAggregator

pub fn new(config: &DDSketchConfig, kind: NumberKind) -> DDSKetchAggregator

Create a new DDSKetchAggregator that would yield a quantile with relative error rate less than alpha

The input should have a granularity larger than key_epsilon

Trait Implementations

impl Aggregator for DDSKetchAggregator

pub fn update(&self, number: &Number, descriptor: &Descriptor) -> Result<()>

Update receives a new measured value and incorporates it into the aggregation. Update calls may be called concurrently.

pub fn synchronized_move(
    &self,
    destination: &Arc<dyn Aggregator + Send + Sync>,
    descriptor: &Descriptor
) -> Result<()>

This method is called during collection to finish one period of aggregation by atomically saving the currently-updating state into the argument Aggregator.

pub fn merge(
    &self,
    other: &(dyn Aggregator + Send + Sync),
    _descriptor: &Descriptor
) -> Result<()>

This combines the checkpointed state from the argument Aggregator into this Aggregator. merge is not synchronized with respect to update or synchronized_move.

pub fn as_any(&self) -> &dyn Any

Returns the implementing aggregator as Any for downcasting.

impl Count for DDSKetchAggregator

pub fn count(&self) -> Result<u64>

The count of the currently aggregated metrics

impl Debug for DDSKetchAggregator

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

Formats the value using the given formatter.

impl Default for DDSKetchAggregator

pub fn default() -> Self

Returns the "default value" for a type.

impl Distribution for DDSKetchAggregator

impl Max for DDSKetchAggregator

pub fn max(&self) -> Result<Number>

The max of the currently aggregated metrics

impl Min for DDSKetchAggregator

pub fn min(&self) -> Result<Number>

The min of the currently aggregated metrics

impl MinMaxSumCount for DDSKetchAggregator

impl Quantile for DDSKetchAggregator

pub fn quantile(&self, q: f64) -> Result<Number>

The quantile of the currently aggregated metrics

impl Sum for DDSKetchAggregator

pub fn sum(&self) -> Result<Number>

The sum of the currently aggregated metrics