Share via


IMetricSeriesAggregator Interface

Definition

The abstraction for a metric aggregator. An aggregator is a data processing type that inspects all values tracked for a metric series across an aggregation period and creates an aggregate that summarizes the period when it is completed. The most common aggregator is the Microsoft.ApplicationInsights.Metrics.MeasurementAggregator, which produces aggregates that contain the Min, Max, Sum and Count of values tracked over the aggregation time period.

public interface IMetricSeriesAggregator
type IMetricSeriesAggregator = interface
Public Interface IMetricSeriesAggregator

Properties

DataSeries

Gets the data series aggregated by this aggregator.

Methods

CompleteAggregation(DateTimeOffset)

Wraps up the ongping aggregation period and procudes the resulting aggregate.

CreateAggregateUnsafe(DateTimeOffset)

Creates the aggregate for the ongoing aggregation period without completing the period. May not be thread safe.

Reset(DateTimeOffset, IMetricValueFilter)

Resets this aggregator and prepares it for a new aggregation period.

Reset(DateTimeOffset)

Resets this aggregator and prepares it for a new aggregation period.

TrackValue(Double)

Adds a value to the aggregation.

TrackValue(Object)

Adds a value to the aggregation.

TryRecycle()

Attempts to reset this aggregator so it ban be reused for a new aggregation period.

Applies to