Struct Aggregator

pub struct Aggregator { /* private fields */ }

A collector of Bucket submissions.

Aggregation

Each metric is dispatched into the a Bucket depending on its project key (DSN), name, type, unit, tags and timestamp. The bucket timestamp is rounded to the precision declared by the bucket_interval field on the AggregatorConfig configuration.

Each bucket stores the accumulated value of submitted metrics:

• Counter: Sum of values.
• Distribution: A list of values.
• Set: A unique set of hashed values.
• Gauge: A summary of the reported values, see GaugeValue.

Conflicts

Metrics are uniquely identified by the combination of their name, type and unit. It is allowed to send metrics of different types and units under the same name. For example, sending a metric once as set and once as distribution will result in two actual metrics being recorded.

Implementations

impl Aggregator

pub fn named(name: String, config: &AggregatorConfig) -> Self

Creates a new named Self.

pub fn name(&self) -> &str

Returns the name of the aggregator.

pub fn is_empty(&self) -> bool

Returns true if the aggregator contains any metric buckets.

pub fn merge( &mut self, project_key: ProjectKey, bucket: Bucket, ) -> Result<(), AggregateMetricsError>

Merge a bucket into this aggregator.

pub fn try_flush_next(&mut self, now: SystemTime) -> Result<Partition, Duration>

Attempts to flush the next batch from the aggregator.

If it is too early to flush the next batch, the error contains the timestamp when the flush should be retried. After a successful flush, retry immediately until an error is returned with the next flush time, this makes sure time is eventually synchronized.

pub fn next_flush_at(&mut self, now: SystemTime) -> Duration

Returns when the next partition is ready to be flushed using Self::try_flush_next.

pub fn into_partitions(self) -> impl Iterator<Item = Partition>

Consumes the aggregator and returns all contained partitions.

Trait Implementations

impl Debug for Aggregator

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

Formats the value using the given formatter.