@microsoft/applicationinsights-common 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/src/Telemetry/Metric.ts

@@ -1,61 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../Constants";
-import { FieldType } from "../Enums";
-import { IMetricData } from "../Interfaces/Contracts/IMetricData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { DataPoint } from "./Common/DataPoint";
-import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString } from "./Common/DataSanitizer";
-
-export class Metric implements IMetricData, ISerializable {
-
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.Metric";
-    public static dataType = "MetricData";
-
-    public aiDataContract = {
-        ver: FieldType.Required,
-        metrics: FieldType.Required,
-        properties: FieldType.Default
-    }
-
-    /**
-     * Schema version
-     */
-    public ver: number; /* 2 */
-
-    /**
-     * List of metrics. Only one metric in the list is currently supported by Application Insights storage. If multiple data points were sent only the first one will be used.
-     */
-    public metrics: DataPoint[]; /* [] */
- 
-    /**
-     * Collection of custom properties.
-     */
-    properties: any; /* {} */
- 
-    /**
-     * Collection of custom measurements.
-     */
-    measurements: any; /* {} */
- 
-    /**
-     * Constructs a new instance of the MetricTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name: string, value: number, count?: number, min?: number, max?: number, stdDev?: number, properties?: any, measurements?: { [key: string]: number }) {
-        let _self = this;
-        _self.ver = 2;
-        const dataPoint = new DataPoint();
-        dataPoint.count = count > 0 ? count : undefined;
-        dataPoint.max = isNaN(max) || max === null ? undefined : max;
-        dataPoint.min = isNaN(min) || min === null ? undefined : min;
-        dataPoint.name = dataSanitizeString(logger, name) || strNotSpecified;
-        dataPoint.value = value;
-        dataPoint.stdDev = isNaN(stdDev) || stdDev === null ? undefined : stdDev;
-
-        _self.metrics = [dataPoint];
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-    }
-}

package/src/Telemetry/PageView.ts

@@ -1,79 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../Constants";
-import { FieldType } from "../Enums";
-import { msToTimeSpan } from "../HelperFuncs";
-import { IPageViewData } from "../Interfaces/Contracts/IPageViewData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import {
-    dataSanitizeId, dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString, dataSanitizeUrl
-} from "./Common/DataSanitizer";
-
-export class PageView implements IPageViewData, ISerializable {
-
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.Pageview";
-    public static dataType = "PageviewData";
-
-    public aiDataContract = {
-        ver: FieldType.Required,
-        name: FieldType.Default,
-        url: FieldType.Default,
-        duration: FieldType.Default,
-        properties: FieldType.Default,
-        measurements: FieldType.Default,
-        id: FieldType.Default
-    }
-
-    /**
-     * Schema version
-     */
-    public ver: number; // = 2;
-
-    /**
-     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
-     */
-    public name: string;
- 
-    /**
-     * Collection of custom properties.
-     */
-    public properties: any; // = {};
- 
-    /**
-     * Collection of custom measurements.
-     */
-    public measurements: any; // = {};
- 
-    /**
-     * Request URL with all query string parameters
-     */
-    public url: string;
-
-    /**
-     * Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days.
-     */
-    public duration: string;
- 
-    /**
-     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
-     */
-    public id: string;
- 
-    /**
-     * Constructs a new instance of the PageEventTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name?: string, url?: string, durationMs?: number, properties?: {[key: string]: string}, measurements?: {[key: string]: number}, id?: string) {
-        let _self = this;
-        _self.ver = 2;
-        _self.id = dataSanitizeId(logger, id);
-        _self.url = dataSanitizeUrl(logger, url);
-        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
-        if (!isNaN(durationMs)) {
-            _self.duration = msToTimeSpan(durationMs);
-        }
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-    }
-}

package/src/Telemetry/PageViewPerformance.ts

@@ -1,113 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../Constants";
-import { FieldType } from "../Enums";
-import { IPageViewPerfData } from "../Interfaces/Contracts/IPageViewPerfData";
-import { IPageViewPerformanceTelemetry } from "../Interfaces/IPageViewPerformanceTelemetry";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString, dataSanitizeUrl } from "./Common/DataSanitizer";
-
-export class PageViewPerformance implements IPageViewPerfData, ISerializable {
-
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.PageviewPerformance";
-    public static dataType = "PageviewPerformanceData";
-
-    public aiDataContract = {
-        ver: FieldType.Required,
-        name: FieldType.Default,
-        url: FieldType.Default,
-        duration: FieldType.Default,
-        perfTotal: FieldType.Default,
-        networkConnect: FieldType.Default,
-        sentRequest: FieldType.Default,
-        receivedResponse: FieldType.Default,
-        domProcessing: FieldType.Default,
-        properties: FieldType.Default,
-        measurements: FieldType.Default
-    };
-
-    /**
-     * Schema version
-     */
-    public ver: number; // = 2;
-
-    /**
-     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
-     */
-    public name: string;
-  
-    /**
-     * Collection of custom properties.
-     */
-    public properties: any; // = {};
-  
-    /**
-     * Collection of custom measurements.
-     */
-    public measurements: any; // = {};
-  
-    /**
-     * Request URL with all query string parameters
-     */
-    public url: string;
- 
-    /**
-     * Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days.
-     */
-    public duration: string;
-  
-    /**
-     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
-     */
-    public id: string;
-  
-    /**
-     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
-     */
-    public perfTotal: string;
-
-    /**
-     * Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
-     */
-    public networkConnect: string;
-  
-    /**
-     * Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
-     */
-    public sentRequest: string;
-  
-    /**
-     * Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
-     */
-    public receivedResponse: string;
-  
-    /**
-     * DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
-     */
-    public domProcessing: string;
-  
-    /**
-     * Constructs a new instance of the PageEventTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name: string, url: string, unused: number, properties?: { [key: string]: string }, measurements?: { [key: string]: number }, cs4BaseData?: IPageViewPerformanceTelemetry) {
-        let _self = this;
-
-        _self.ver = 2;
-        _self.url = dataSanitizeUrl(logger, url);
-        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
-
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-
-        if (cs4BaseData) {
-            _self.domProcessing = cs4BaseData.domProcessing;
-            _self.duration = cs4BaseData.duration;
-            _self.networkConnect = cs4BaseData.networkConnect;
-            _self.perfTotal = cs4BaseData.perfTotal;
-            _self.receivedResponse = cs4BaseData.receivedResponse;
-            _self.sentRequest = cs4BaseData.sentRequest;
-        }
-    }
-}

package/src/Telemetry/RemoteDependencyData.ts

@@ -1,122 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { msToTimeSpan } from "../HelperFuncs";
-import { IRemoteDependencyData } from "../Interfaces/Contracts/IRemoteDependencyData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { AjaxHelperParseDependencyPath } from "../Util";
-import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString, dataSanitizeUrl } from "./Common/DataSanitizer";
-
-export class RemoteDependencyData implements IRemoteDependencyData, ISerializable {
-
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.RemoteDependency";
-    public static dataType = "RemoteDependencyData";
-
-    public aiDataContract = {
-        id: FieldType.Required,
-        ver: FieldType.Required,
-        name: FieldType.Default,
-        resultCode: FieldType.Default,
-        duration: FieldType.Default,
-        success: FieldType.Default,
-        data: FieldType.Default,
-        target: FieldType.Default,
-        type: FieldType.Default,
-        properties: FieldType.Default,
-        measurements: FieldType.Default,
-
-        kind: FieldType.Default,
-        value: FieldType.Default,
-        count: FieldType.Default,
-        min: FieldType.Default,
-        max: FieldType.Default,
-        stdDev: FieldType.Default,
-        dependencyKind: FieldType.Default,
-        dependencySource: FieldType.Default,
-        commandName: FieldType.Default,
-        dependencyTypeName: FieldType.Default
-    }
-
-    /**
-     * Schema version
-     */
-    public ver: number; // = 2;
-
-    /**
-     * Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.
-     */
-    public name: string;
- 
-    /**
-     * Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.
-     */
-    public id: string;
- 
-    /**
-     * Result code of a dependency call. Examples are SQL error code and HTTP status code.
-     */
-    public resultCode: string;
- 
-    /**
-     * Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days.
-     */
-    public duration: string;
- 
-    /**
-     * Indication of successful or unsuccessful call.
-     */
-    public success: boolean; /* true */
- 
-    /**
-     * Command initiated by this dependency call. Examples are SQL statement and HTTP URL's with all query parameters.
-     */
-    public data: string;
- 
-    /**
-     * Target site of a dependency call. Examples are server name, host address.
-     */
-    public target: string;
- 
-    /**
-     * Dependency type name. Very low cardinality value for logical grouping of dependencies and interpretation of other fields like commandName and resultCode. Examples are SQL, Azure table, and HTTP.
-     */
-    public type: string;
- 
-    /**
-     * Collection of custom properties.
-     */
-    public properties: any; // = {};
- 
-    /**
-     * Collection of custom measurements.
-     */
-    public measurements: any; // = {};
- 
-    /**
-     * Constructs a new instance of the RemoteDependencyData object
-     */
-    constructor(logger: IDiagnosticLogger, id: string, absoluteUrl: string, commandName: string, value: number, success: boolean, resultCode: number, method?: string, requestAPI: string = "Ajax", correlationContext?: string, properties?: Object, measurements?: Object) {
-        let _self = this;
-
-        _self.ver = 2;
-        _self.id = id;
-        _self.duration = msToTimeSpan(value);
-        _self.success = success;
-        _self.resultCode = resultCode + "";
-
-        _self.type = dataSanitizeString(logger, requestAPI);
-
-        const dependencyFields = AjaxHelperParseDependencyPath(logger, absoluteUrl, method, commandName);
-        _self.data = dataSanitizeUrl(logger, commandName) || dependencyFields.data; // get a value from hosturl if commandName not available
-        _self.target = dataSanitizeString(logger, dependencyFields.target);
-        if (correlationContext) {
-            _self.target = `${_self.target} | ${correlationContext}`;
-        }
-        _self.name = dataSanitizeString(logger, dependencyFields.name);
-
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-    }
-}

package/src/Telemetry/Trace.ts

@@ -1,64 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { strNotSpecified } from "../Constants";
-import { FieldType } from "../Enums";
-import { IMessageData } from "../Interfaces/Contracts/IMessageData";
-import { SeverityLevel } from "../Interfaces/Contracts/SeverityLevel";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { dataSanitizeMeasurements, dataSanitizeMessage, dataSanitizeProperties } from "./Common/DataSanitizer";
-
-export class Trace implements IMessageData, ISerializable {
-
-    public static envelopeType = "Microsoft.ApplicationInsights.{0}.Message";
-    public static dataType = "MessageData";
-
-    public aiDataContract = {
-        ver: FieldType.Required,
-        message: FieldType.Required,
-        severityLevel: FieldType.Default,
-        properties: FieldType.Default
-    };
-
-    /**
-     * Schema version
-     */
-    public ver: number; // = 2;
-
-    /**
-     * Trace message
-     */
-    public message: string;
- 
-    /**
-     * Trace severity level.
-     */
-    public severityLevel: SeverityLevel;
- 
-    /**
-     * Collection of custom properties.
-     */
-    public properties: any;
- 
-    /**
-     * Collection of custom measurements.
-     */
-    public measurements: any;
- 
-    /**
-     * Constructs a new instance of the TraceTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, message: string, severityLevel?: SeverityLevel, properties?: any, measurements?: { [key: string]: number }) {
-        let _self = this;
-        _self.ver = 2;
-        message = message || strNotSpecified;
-        _self.message = dataSanitizeMessage(logger, message);
-        _self.properties = dataSanitizeProperties(logger, properties);
-        _self.measurements = dataSanitizeMeasurements(logger, measurements);
-
-        if (severityLevel) {
-            _self.severityLevel = severityLevel;
-        }
-    }
-}

package/src/TelemetryItemCreator.ts

@@ -1,75 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import {
-    IDiagnosticLogger, ITelemetryItem, isNullOrUndefined, objForEachKey, throwError, toISOString
-} from "@microsoft/applicationinsights-core-js";
-import { strIkey, strNotSpecified } from "./Constants";
-import { dataSanitizeString } from "./Telemetry/Common/DataSanitizer";
-
-/**
- * Create a telemetry item that the 1DS channel understands
- * @param item - domain specific properties; part B
- * @param baseType - telemetry item type. ie PageViewData
- * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
- * @param customProperties - user defined custom properties; part C
- * @param systemProperties - system properties that are added to the context; part A
- * @returns ITelemetryItem that is sent to channel
- */
-
-export function createTelemetryItem<T>(item: T,
-    baseType: string,
-    envelopeName: string,
-    logger: IDiagnosticLogger,
-    customProperties?: { [key: string]: any },
-    systemProperties?: { [key: string]: any }): ITelemetryItem {
-
-    envelopeName = dataSanitizeString(logger, envelopeName) || strNotSpecified;
-
-    if (isNullOrUndefined(item) ||
-        isNullOrUndefined(baseType) ||
-        isNullOrUndefined(envelopeName)) {
-        throwError("Input doesn't contain all required fields");
-    }
-    
-    let iKey = "";
-    if (item[strIkey]) {
-        iKey = item[strIkey];
-        delete item[strIkey];
-    }
-
-    const telemetryItem: ITelemetryItem = {
-        name: envelopeName,
-        time: toISOString(new Date()),
-        iKey: iKey, // this will be set in TelemetryContext
-        ext: systemProperties ? systemProperties : {}, // part A
-        tags: [],
-        data: {
-        },
-        baseType,
-        baseData: item // Part B
-    };
-
-    // Part C
-    if (!isNullOrUndefined(customProperties)) {
-        objForEachKey(customProperties, (prop, value) => {
-            telemetryItem.data[prop] = value;
-        });
-    }
-
-    return telemetryItem;
-}
-
-export class TelemetryItemCreator {
-    /**
-     * Create a telemetry item that the 1DS channel understands
-     * @param item - domain specific properties; part B
-     * @param baseType - telemetry item type. ie PageViewData
-     * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
-     * @param customProperties - user defined custom properties; part C
-     * @param systemProperties - system properties that are added to the context; part A
-     * @returns ITelemetryItem that is sent to channel
-     */
-
-     public static create = createTelemetryItem;
-}