Interface IRequestTelemetry

This defines the contract for request telemetry items that are passed to Application Insights API (track)

interface IRequestTelemetry {
    duration: number;
    id: string;
    measurements?: {
        [key: string]: number;
    };
    name?: string;
    properties?: {
        [key: string]: any;
    };
    responseCode: number;
    source?: string;
    success: boolean;
    url?: string;
}

Hierarchy

  • IPartC
    • IRequestTelemetry

Properties

duration id measurements? name? properties? responseCode source? success url?

Properties

duration

duration: number

Request duration in milliseconds.

id

id: string

Identifier of a request call instance. Used for correlation between request and other telemetry items.

Optionalmeasurements

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

Property bag to contain additional custom measurements (Part C)

Deprecated

-- please use properties instead

Optionalname

name?: string

Name of the request. Represents code path taken to process request. Low cardinality value to allow better grouping of requests. For HTTP requests it represents the HTTP method and URL path template like 'GET /values/{id}'.

Optionalproperties

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

Property bag to contain additional custom properties (Part C)

responseCode

responseCode: number

Result of a request execution. HTTP status code for HTTP requests.

Optionalsource

source?: string

Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.

success

success: boolean

Indication of successful or unsuccessful call.

Optionalurl

url?: string

Request URL with all query string parameters.

Settings

Member Visibility

On This Page

Properties