Share via


MetricAggregate Class

Definition

Holds the metric aggregation results of a particular metric data series over an aggregation time period. The specific data fields on instanced of this class are not strongly typed (property bag) which allows using this aggregate type for aggregates of any aggregation kind.

public class MetricAggregate
type MetricAggregate = class
Public Class MetricAggregate
Inheritance
MetricAggregate

Constructors

MetricAggregate(String, String, String)

Ceates a new metric aggregate.

Properties

AggregationKindMoniker

Gets the moniker defining the kind of the aggregation used for the respective metric.

AggregationPeriodDuration

Gets or sets the length of the aggregation period summarized by this aggregate.

AggregationPeriodStart

Gets or sets the start of the aggregation period summarized by this aggregate.

Data

Gets the property bag that contains the actual aggregate data. For example, if the aggregate was produced for a metric of the aggregation kind Measurement, the look-up key for this property bag are accessible via Microsoft.ApplicationInsights.Metrics.MetricSeriesConfigurationForMeasurement.Constants.AggregateKindDataKeys.

Dimensions

Gets get table of dimension name-values that specify the data series that produced this agregate within the overall metric.

MetricId

Gets the id (name) of the metric that produced this aggregate.

MetricNamespace

Gets the namespace of the metric that produces this aggregate.

Methods

GetDataValue<T>(String, T)

This is a convenience method to retrieve the object at Data[dataKey]. It attempts to convert that object to the specified type T. If the conversion fails, the specified defaultValue is returned.

Applies to