@microsoft/applicationinsights-common 2.8.0-beta.2203-01 → 2.8.0-beta.2203-02

package/src/Interfaces/Contracts/DataPointType.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Type of the metric data measurement.
+ */
+export const enum DataPointType {
+    Measurement = 0,
+    Aggregation = 1
+}

package/src/Interfaces/Contracts/DependencyKind.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Identifies the type of dependency.
+ */
+export const enum DependencyKind {
+    SQL = 0,
+    Http = 1,
+    Other = 2
+}

package/src/Interfaces/Contracts/DependencySourceType.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Identifies the source of the dependency.
+ */
+export const enum DependencySourceType {
+    Undefined = 0,
+    Aic = 1,
+    Apmc = 2
+}

package/src/Interfaces/Contracts/IBase.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Data struct to contain only C section with custom fields.
+ */
+export interface IBase {
+
+    /**
+     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
+     */
+    baseType: string;
+}

package/src/Interfaces/Contracts/IData.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IBase } from "./IBase";
+
+/**
+ * Data struct to contain both B and C sections.
+ */
+export interface IData<TDomain> extends IBase {
+    /**
+     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
+     */
+    baseType: string;
+
+    /**
+     * Container for data item (B section).
+     */
+    baseData: TDomain;
+}

package/src/Interfaces/Contracts/IDataPoint.ts

@@ -0,0 +1,44 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+import { DataPointType } from "./DataPointType";
+
+/**
+ * Metric data single measurement.
+ */
+export interface IDataPoint {
+
+    /**
+     * Name of the metric.
+     */
+    name: string;
+
+    /**
+     * Metric type. Single measurement or the aggregated value.
+     */
+    kind: DataPointType;
+
+    /**
+     * Single value for measurement. Sum of individual measurements for the aggregation.
+     */
+    value: number;
+
+    /**
+     * Metric weight of the aggregated metric. Should not be set for a measurement.
+     */
+    count: number;
+
+    /**
+     * Minimum value of the aggregated metric. Should not be set for a measurement.
+     */
+    min: number;
+
+    /**
+     * Maximum value of the aggregated metric. Should not be set for a measurement.
+     */
+    max: number;
+
+    /**
+     * Standard deviation of the aggregated metric. Should not be set for a measurement.
+     */
+    stdDev: number;
+}

package/src/Interfaces/Contracts/IDomain.ts

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * The abstract common base of all domains.
+ */
+export interface IDomain {
+}

package/src/Interfaces/Contracts/IEnvelope.ts

@@ -0,0 +1,50 @@
+// // Copyright (c) Microsoft Corporation. All rights reserved.
+// // Licensed under the MIT License.
+
+// import { IBase } from "./IBase";
+
+// /**
+//  * System variables for a telemetry item.
+//  */
+// export interface IEnvelope {
+
+//     /**
+//      * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.
+//      */
+//     ver: number; /* 1 */
+
+//     /**
+//      * Type name of telemetry data item.
+//      */
+//     name: string;
+
+//     /**
+//      * Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.
+//      */
+//     time: string;
+
+//     /**
+//      * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+//      */
+//     sampleRate: number; /* 100.0 */
+
+//     /**
+//      * Sequence field used to track absolute order of uploaded events.
+//      */
+//     seq: string;
+
+//     /**
+//      * The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.
+//      */
+//     iKey: string;
+
+//     /**
+//      * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+//      */
+//     tags: any; /* {} */
+
+//     /**
+//      * Telemetry data item.
+//      */
+//     data: IBase;
+// }

package/src/Interfaces/Contracts/IEventData.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IDomain } from "./IDomain";
+
+/**
+ * Instances of Event represent structured event records that can be grouped and searched by their properties. Event data item also creates a metric of event count by name.
+ */
+export interface IEventData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    ver: number; /* 2 */
+
+    /**
+     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
+     */
+    name: string;
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IExceptionData.ts

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IExceptionDetails } from "./IExceptionDetails";
+import { IDomain } from "./IDomain";
+import { SeverityLevel } from "./SeverityLevel";
+
+/**
+ * An instance of Exception represents a handled or unhandled exception that occurred during execution of the monitored application.
+ */
+export interface IExceptionData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    ver: number; /* 2 */
+
+    /**
+     * Exception chain - list of inner exceptions.
+     */
+    exceptions: IExceptionDetails[]; /* [] */
+
+    /**
+     * Severity level. Mostly used to indicate exception severity level when it is reported by logging library.
+     */
+    severityLevel: SeverityLevel;
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IExceptionDetails.ts

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IStackFrame } from "./IStackFrame";
+
+/**
+ * Exception details of the exception in a chain.
+ */
+export interface IExceptionDetails {
+
+    /**
+     * In case exception is nested (outer exception contains inner one), the id and outerId properties are used to represent the nesting.
+     */
+    id: number;
+
+    /**
+     * The value of outerId is a reference to an element in ExceptionDetails that represents the outer exception
+     */
+    outerId: number;
+
+    /**
+     * Exception type name.
+     */
+    typeName: string;
+    
+    /**
+     * Exception message.
+     */
+    message: string;
+
+    /**
+     * Indicates if full exception stack is provided in the exception. The stack may be trimmed, such as in the case of a StackOverflow exception.
+     */
+    hasFullStack: boolean;
+
+    /**
+     * Text describing the stack. Either stack or parsedStack should have a value.
+     */
+    stack: string;
+
+    /**
+     * List of stack frames. Either stack or parsedStack should have a value.
+     */
+    parsedStack: IStackFrame[]; /* [] */
+}

package/src/Interfaces/Contracts/IMessageData.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IDomain } from "./IDomain";
+import { SeverityLevel } from "./SeverityLevel";
+
+/**
+ * Instances of Message represent printf-like trace statements that are text-searched. Log4Net, NLog and other text-based log file entries are translated into intances of this type. The message does not have measurements.
+ */
+export interface IMessageData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    ver: number; /* 2 */
+
+    /**
+     * Trace message
+     */
+    message: string;
+
+    /**
+     * Trace severity level.
+     */
+    severityLevel: SeverityLevel;
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IMetricData.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IDomain } from "./IDomain";
+import { IDataPoint } from "./IDataPoint";
+
+/**
+ * An instance of the Metric item is a list of measurements (single data points) and/or aggregations.
+ */
+export interface IMetricData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    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.
+     */
+    metrics: IDataPoint[]; /* [] */
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IPageViewData.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// THIS FILE WAS AUTOGENERATED
+import { IEventData } from "./IEventData";
+
+/**
+ * An instance of PageView represents a generic action on a page like a button click. It is also the base type for PageView.
+ */
+export interface IPageViewData extends IEventData {
+
+    /**
+     * Request URL with all query string parameters
+     */
+    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.
+     */
+    duration: string;
+
+    /**
+     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
+     */
+    id: string;
+}

package/src/Interfaces/Contracts/IPageViewPerfData.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IPageViewData } from "./IPageViewData";
+
+/**
+ * An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.
+ */
+export interface IPageViewPerfData extends IPageViewData {
+
+    /**
+     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    perfTotal: string;
+
+    /**
+     * Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    networkConnect: string;
+
+    /**
+     * Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    sentRequest: string;
+
+    /**
+     * Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    receivedResponse: string;
+
+    /**
+     * DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    domProcessing: string;
+}

package/src/Interfaces/Contracts/IRemoteDependencyData.ts

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IDomain } from "./IDomain";
+
+/**
+ * An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.
+ */
+export interface IRemoteDependencyData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    ver: number; /* 2 */
+
+    /**
+     * Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.
+     */
+    name: string;
+
+    /**
+     * Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.
+     */
+    id: string;
+
+    /**
+     * Result code of a dependency call. Examples are SQL error code and HTTP status code.
+     */
+    resultCode: string;
+
+    /**
+     * Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days.
+     */
+    duration: string;
+
+    /**
+     * Indication of successful or unsuccessful call.
+     */
+    success: boolean; /* true */
+
+    /**
+     * Command initiated by this dependency call. Examples are SQL statement and HTTP URL's with all query parameters.
+     */
+    data: string;
+
+    /**
+     * Target site of a dependency call. Examples are server name, host address.
+     */
+    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.
+     */
+    type: string;
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IStackFrame.ts

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Stack frame information.
+ */
+export interface IStackFrame {
+
+    /**
+     * Level in the call stack. For the long stacks SDK may not report every function in a call stack.
+     */
+    level: number;
+
+    /**
+     * Method name.
+     */
+    method: string;
+
+    /**
+     * Name of the assembly (dll, jar, etc.) containing this function.
+     */
+    assembly: string;
+
+    /**
+     * File name or URL of the method implementation.
+     */
+    fileName: string;
+
+    /**
+     * Line number of the code implementation.
+     */
+    line: number;
+}

package/src/Interfaces/Contracts/RequestData.ts

@@ -0,0 +1,50 @@
+// // Copyright (c) Microsoft Corporation. All rights reserved.
+// // Licensed under the MIT License.
+
+// import { IDomain } from "./IDomain";
+
+// /**
+//  * An instance of Request represents completion of an external request to the application to do work and contains a summary of that request execution and the results.
+//  */
+// export class RequestData implements IDomain {
+
+//     /**
+//      * Schema version
+//      */
+//     public ver: number = 2;
+
+//     /**
+//      * Identifier of a request call instance. Used for correlation between request and other telemetry items.
+//      */
+//     public id: string;
+
+//     /**
+//      * Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.
+//      */
+//     public source: 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}'.
+//      */
+//     public name: string;
+
+//     /**
+//      * Indication of successful or unsuccessful call.
+//      */
+//     public success: boolean;
+
+//     /**
+//      * Request URL with all query string parameters.
+//      */
+//     public url: string;
+
+//     /**
+//      * Collection of custom properties.
+//      */
+//     public properties: any = {};
+
+//     /**
+//      * Collection of custom measurements.
+//      */
+//     public measurements: any = {};
+// }

package/src/Interfaces/Contracts/SeverityLevel.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// THIS FILE WAS AUTOGENERATED
+
+/**
+ * Defines the level of severity for the event.
+ */
+export enum SeverityLevel {
+    Verbose = 0,
+    Information = 1,
+    Warning = 2,
+    Error = 3,
+    Critical = 4,
+}

package/src/StorageHelperFuncs.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { dumpObj, getExceptionName, getGlobal, getGlobalInst, IDiagnosticLogger, isNullOrUndefined, LoggingSeverity, objForEachKey, _InternalMessageId } from "@microsoft/applicationinsights-core-js";
+import { dumpObj, getExceptionName, getGlobal, getGlobalInst, IDiagnosticLogger, isNullOrUndefined, eLoggingSeverity, objForEachKey, _InternalMessageId } from "@microsoft/applicationinsights-core-js";
 import { StorageType } from "./Enums";
 
 let _canUseLocalStorage: boolean = undefined;
@@ -79,7 +79,7 @@ export function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): str
             _canUseLocalStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotReadLocalStorage,
                 "Browser failed read of local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -98,7 +98,7 @@ export function utlSetLocalStorage(logger: IDiagnosticLogger, name: string, data
             _canUseLocalStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotWriteLocalStorage,
                 "Browser failed write to local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -117,7 +117,7 @@ export function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boole
             _canUseLocalStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserFailedRemovalFromLocalStorage,
                 "Browser failed removal of local storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -155,7 +155,7 @@ export function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): s
             _canUseSessionStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotReadSessionStorage,
                 "Browser failed read of session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -174,7 +174,7 @@ export function utlSetSessionStorage(logger: IDiagnosticLogger, name: string, da
             _canUseSessionStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotWriteSessionStorage,
                 "Browser failed write to session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -193,7 +193,7 @@ export function utlRemoveSessionStorage(logger: IDiagnosticLogger, name: string)
             _canUseSessionStorage = false;
 
             logger.throwInternal(
-                LoggingSeverity.WARNING,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserFailedRemovalFromSessionStorage,
                 "Browser failed removal of session storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });