Interface IMetricTelemetry

interface IMetricTelemetry {
    average: number;
    iKey?: string;
    max?: number;
    measurements?: {
        [key: string]: number;
    };
    min?: number;
    name: string;
    properties?: {
        [key: string]: any;
    };
    sampleCount?: number;
    stdDev?: number;
}

Hierarchy

  • IPartC
    • IMetricTelemetry

Properties

average iKey? max? measurements? min? name properties? sampleCount? stdDev?

Properties

average

average: number

Description

(required) - Recorded value/average for this metric

OptionaliKey

iKey?: string

Description

custom defined iKey

Optionalmax

max?: number

Description

(optional) The largest measurement in the sample. Defaults to the average.

Default

max=average

Optionalmeasurements

measurements?: {
    [key: string]: number;
}

Property bag to contain additional custom measurements (Part C)

Deprecated

-- please use properties instead

Optionalmin

min?: number

Description

(optional) The smallest measurement in the sample. Defaults to the average

Default

min=average

name

name: string

Description

(required) - name of this metric

Optionalproperties

properties?: {
    [key: string]: any;
}

Property bag to contain additional custom properties (Part C)

OptionalsampleCount

sampleCount?: number

Description

(optional) Number of samples represented by the average.

Default

sampleCount=1

OptionalstdDev

stdDev?: number

(optional) The standard deviation measurement in the sample, Defaults to undefined which results in zero.

Settings

Member Visibility

On This Page

Properties