[Shim] Add Auto-Collection Methods, TelemetryClient, and Config

applicationinsights.ts

@@ -0,0 +1,14 @@
+export { 
+    setup,
+    start,
+    getCorrelationContext,
+    startOperation,
+    wrapWithCorrelationContext,
+    Configuration,
+    defaultClient,
+    Contracts, 
+    DistributedTracingModes,
+    HttpRequest,
+    TelemetryClient,
+    dispose,
+} from "./src/shim/shim-applicationinsights";

src/index.ts

@@ -1,6 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-
 export { TelemetryClient } from "./shim/telemetryClient";
 export { ApplicationInsightsOptions } from "./types";
 export { KnownSeverityLevel } from "./declarations/generated";
@@ -15,4 +14,7 @@ export {
 
 // To support previous versions of Beta, will be removed before GA release
 export { ApplicationInsightsClient } from "./applicationInsightsClient";
-export { ApplicationInsightsConfig } from "./applicationInsightsConfig";
+export { ApplicationInsightsConfig } from "./applicationInsightsConfig";
+
+// To support the shim
+export * from "../applicationinsights";

src/shim/NodeClient.ts

@@ -0,0 +1,34 @@
+import { Logger } from "./logging";
+import { Contracts, TelemetryClient } from "./shim-applicationinsights";
+
+class NodeClient extends TelemetryClient {
+    /**
+     * Log RequestTelemetry from HTTP request and response. This method will log immediately without waiting for request completion
+     * and it requires duration parameter to be specified on NodeHttpRequestTelemetry object.
+     * Use trackNodeHttpRequest function to log the telemetry after request completion
+     * @param telemetry Object encapsulating incoming request, response and duration information
+     */
+    public trackNodeHttpRequestSync(telemetry: Contracts.NodeHttpRequestTelemetry) {
+        Logger.getInstance().warn("trackNodeHttpRequestSync is not implemented and is a no-op.");
+    }
+
+    /**
+     * Log RequestTelemetry from HTTP request and response. This method will `follow` the request to completion.
+     * Use trackNodeHttpRequestSync function to log telemetry immediately without waiting for request completion
+     * @param telemetry Object encapsulating incoming request and response information
+     */
+    public trackNodeHttpRequest(telemetry: Contracts.NodeHttpRequestTelemetry) {
+        Logger.getInstance().warn("trackNodeHttpRequest is not implemented and is a no-op.");
+    }
+
+    /**
+     * Log DependencyTelemetry from outgoing HTTP request. This method will instrument the outgoing request and append
+     * the specified headers and will log the telemetry when outgoing request is complete
+     * @param telemetry Object encapsulating outgoing request information
+     */
+    public trackNodeHttpDependency(telemetry: Contracts.NodeHttpRequestTelemetry) {
+        Logger.getInstance().warn("trackNodeHttpDependency is not implemented and is a no-op.");
+    }
+}
+
+export = NodeClient;

src/shim/configuration/config.ts

@@ -0,0 +1,148 @@
+import { DistributedTracingModes, IConfig, IDisabledExtendedMetrics, IWebInstrumentationConfig } from "../types";
+import http = require("http");
+import https = require("https");
+import azureCoreAuth = require("@azure/core-auth");
+import { Logger } from "../logging";
+import constants = require("../../declarations/constants");
+
+class config implements IConfig {
+
+    public static ENV_azurePrefix = "APPSETTING_"; // Azure adds this prefix to all environment variables
+    public static ENV_iKey = "APPINSIGHTS_INSTRUMENTATIONKEY"; // This key is provided in the readme
+    public static legacy_ENV_iKey = "APPINSIGHTS_INSTRUMENTATION_KEY";
+    public static ENV_profileQueryEndpoint = "APPINSIGHTS_PROFILE_QUERY_ENDPOINT";
+    public static ENV_quickPulseHost = "APPINSIGHTS_QUICKPULSE_HOST";
+
+    public endpointUrl: string;
+    public maxBatchSize: number;
+    public maxBatchIntervalMs: number;
+    public disableAppInsights: boolean;
+    public samplingPercentage: number;
+    public correlationIdRetryIntervalMs: number;
+    public correlationHeaderExcludedDomains: string[];
+    public proxyHttpUrl: string;
+    public proxyHttpsUrl: string;
+    public httpAgent: http.Agent;
+    public httpsAgent: https.Agent;
+    public ignoreLegacyHeaders: boolean;
+    public aadTokenCredential?: azureCoreAuth.TokenCredential;
+    public enableAutoCollectConsole: boolean;
+    public enableLoggerErrorToTrace: boolean;
+    public enableAutoCollectExceptions: boolean;
+    public enableAutoCollectPerformance: boolean;
+    public enableAutoCollectExternalLoggers: boolean;
+    public enableAutoCollectPreAggregatedMetrics: boolean;
+    public enableAutoCollectHeartbeat: boolean;
+    public enableAutoCollectRequests: boolean;
+    public enableAutoCollectDependencies: boolean;
+    public enableAutoDependencyCorrelation: boolean;
+    public enableAutoCollectIncomingRequestAzureFunctions: boolean;
+    public enableSendLiveMetrics: boolean;
+    public enableUseDiskRetryCaching: boolean;
+    public enableUseAsyncHooks: boolean;
+    public distributedTracingMode: DistributedTracingModes;
+
+    public enableAutoCollectExtendedMetrics: boolean | IDisabledExtendedMetrics;
+    public enableResendInterval: number;
+    public enableMaxBytesOnDisk: number;
+    public enableInternalDebugLogging: boolean;
+    public enableInternalWarningLogging: boolean;
+    public disableAllExtendedMetrics: boolean;
+    public disableStatsbeat: boolean; // TODO: Implement this as a way to shutoff statsbeat
+    public extendedMetricDisablers: string;
+    public quickPulseHost: string; // TODO: This is not noted in the README
+    public enableWebInstrumentation: boolean;
+    public webInstrumentationConfig: IWebInstrumentationConfig[];
+    public webInstrumentationSrc: string;
+    public noPatchModules: string;
+    public noHttpAgentKeepAlive: boolean;
+
+    // To Be deprecated.
+    public enableAutoWebSnippetInjection: boolean;
+
+    public correlationId: string; // TODO: Should be private NOTE: This is not noted in the README
+    private _connectionString: string;
+    private _endpointBase: string = constants.DEFAULT_BREEZE_ENDPOINT;
+
+    private _instrumentationKey: string;
+    public _webInstrumentationConnectionString: string;
+
+    // Added to maintain parity between JSON config and setting manually in the shim
+    public noDiagnosticChannel: boolean;
+
+    constructor(setupString?: string) {
+        this.instrumentationKey = setupString;
+
+        this.maxBatchSize = this.maxBatchSize || 250;
+        this.maxBatchIntervalMs = this.maxBatchIntervalMs || 15000;
+        this.disableAppInsights = this.disableAppInsights || false;
+        this.samplingPercentage = this.samplingPercentage || 100;
+        this.correlationIdRetryIntervalMs = this.correlationIdRetryIntervalMs || 30 * 1000;
+        // this.enableWebInstrumentation = this.enableWebInstrumentation || this.enableAutoWebSnippetInjection || false;
+        this.webInstrumentationConfig = this.webInstrumentationConfig || null;
+        // this.enableAutoWebSnippetInjection = this.enableWebInstrumentation;
+        this.correlationHeaderExcludedDomains =
+            this.correlationHeaderExcludedDomains ||
+            [
+                "*.core.windows.net",
+                "*.core.chinacloudapi.cn",
+                "*.core.cloudapi.de",
+                "*.core.usgovcloudapi.net",
+                "*.core.microsoft.scloud",
+                "*.core.eaglex.ic.gov"
+            ];
+
+        this.ignoreLegacyHeaders = true;
+        this.webInstrumentationConnectionString = this.webInstrumentationConnectionString || this._webInstrumentationConnectionString || "";
+        this.webSnippetConnectionString = this.webInstrumentationConnectionString;
+    }
+
+    public set instrumentationKey(iKey: string) {
+        if (!config._validateInstrumentationKey(iKey)) {
+            Logger.getInstance().warn("An invalid instrumentation key was provided. There may be resulting telemetry loss", this.instrumentationKey);
+        }
+        this._instrumentationKey = iKey;
+    }
+
+    public get instrumentationKey(): string {
+        return this._instrumentationKey;
+    }
+
+    public set webSnippetConnectionString(connectionString: string) {
+        this._webInstrumentationConnectionString = connectionString;
+    }
+
+    public get webSnippetConnectionString(): string {
+        return this._webInstrumentationConnectionString;
+    }
+
+    public set webInstrumentationConnectionString(connectionString: string) {
+        this._webInstrumentationConnectionString = connectionString;
+    }
+
+    public get webInstrumentationConnectionString() {
+        return this._webInstrumentationConnectionString;
+    }
+
+    /**
+    * Validate UUID Format
+    * Specs taken from breeze repo
+    * The definition of a VALID instrumentation key is as follows:
+    * Not none
+    * Not empty
+    * Every character is a hex character [0-9a-f]
+    * 32 characters are separated into 5 sections via 4 dashes
+    * First section has 8 characters
+    * Second section has 4 characters
+    * Third section has 4 characters
+    * Fourth section has 4 characters
+    * Fifth section has 12 characters
+    */
+    private static _validateInstrumentationKey(iKey: string): boolean {
+        const UUID_Regex = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$";
+        const regexp = new RegExp(UUID_Regex);
+        return regexp.test(iKey);
+    }
+}
+
+export = config;

src/shim/context.ts

@@ -1,12 +1,14 @@
-export class Context {
-    public keys: any;
+import ContextTagKeys = require("./util/contextTagKeys");
+
+export class Context {
+    public keys: ContextTagKeys;
     public tags: { [key: string]: string };
     public static DefaultRoleName = "Web";
     public static appVersion: { [path: string]: string } = {};
     public static sdkVersion: string = null;
 
     constructor(packageJsonPath?: string) {
-        this.keys = {};
+        this.keys = new ContextTagKeys();
         this.tags = <{ [key: string]: string }>{};
     }
 }