applicationinsights.ts

import CorrelationContextManager = require("./AutoCollection/CorrelationContextManager"); // Keep this first
import AutoCollectConsole = require("./AutoCollection/Console");
import AutoCollectExceptions = require("./AutoCollection/Exceptions");
import AutoCollectPerformance = require("./AutoCollection/Performance");
import AutoCollectClientRequests = require("./AutoCollection/ClientRequests");
import AutoCollectServerRequests = require("./AutoCollection/ServerRequests");
import Client = require("./Library/Client");
import Config = require("./Library/Config");
import Context = require("./Library/Context");
import Logging = require("./Library/Logging");
import Util = require("./Library/Util");

/**
 * The singleton meta class for the default client of the client. This class is used to setup/start and configure
 * the auto-collection behavior of the application insights module.
 */
class ApplicationInsights {

    public static client: Client;

    private static _isConsole = true;
    private static _isExceptions = true;
    private static _isPerformance = true;
    private static _isRequests = true;
    private static _isDependencies = true;
    private static _isOfflineMode = false;
    private static _isCorrelating = false;

    private static _console: AutoCollectConsole;
    private static _exceptions: AutoCollectExceptions;
    private static _performance: AutoCollectPerformance;
    private static _serverRequests: AutoCollectServerRequests;
    private static _clientRequests: AutoCollectClientRequests;

    private static _isStarted = false;

    /**
     * Initializes a client with the given instrumentation key, if this is not specified, the value will be
     * read from the environment variable APPINSIGHTS_INSTRUMENTATIONKEY
     * @returns {ApplicationInsights/Client} a new client
     */
    public static getClient(instrumentationKey?: string) {
        return new Client(instrumentationKey);
    }

    /**
     * Initializes the default client of the client and sets the default configuration
     * @param instrumentationKey the instrumentation key to use. Optional, if this is not specified, the value will be
     * read from the environment variable APPINSIGHTS_INSTRUMENTATIONKEY
     * @returns {ApplicationInsights} this class
     */
    public static setup(instrumentationKey?: string) {
        if(!ApplicationInsights.client) {
            ApplicationInsights.client = ApplicationInsights.getClient(instrumentationKey);
            ApplicationInsights._console = new AutoCollectConsole(ApplicationInsights.client);
            ApplicationInsights._exceptions = new AutoCollectExceptions(ApplicationInsights.client);
            ApplicationInsights._performance = new AutoCollectPerformance(ApplicationInsights.client);
            ApplicationInsights._serverRequests = new AutoCollectServerRequests(ApplicationInsights.client);
            ApplicationInsights._clientRequests = new AutoCollectClientRequests(ApplicationInsights.client);
        } else {
            Logging.info("The default client is already setup");
        }

        if (ApplicationInsights.client && ApplicationInsights.client.channel) {
            ApplicationInsights.client.channel.setOfflineMode(ApplicationInsights._isOfflineMode);
        }

        return ApplicationInsights;
    }

    /**
     * Starts automatic collection of telemetry. Prior to calling start no telemetry will be collected
     * @returns {ApplicationInsights} this class
     */
    public static start() {
        if(!!this.client) {
            ApplicationInsights._isStarted = true;
            ApplicationInsights._console.enable(ApplicationInsights._isConsole);
            ApplicationInsights._exceptions.enable(ApplicationInsights._isExceptions);
            ApplicationInsights._performance.enable(ApplicationInsights._isPerformance);
            ApplicationInsights._serverRequests.useAutoCorrelation(ApplicationInsights._isCorrelating);
            ApplicationInsights._serverRequests.enable(ApplicationInsights._isRequests);
            ApplicationInsights._clientRequests.enable(ApplicationInsights._isDependencies);
        } else {
            Logging.warn("Start cannot be called before setup");
        }

        return ApplicationInsights;
    }

    /**
     * Returns an object that is shared across all code handling a given request. This can be used similarly to thread-local storage in other languages.
     * Properties set on this object will be available to telemetry processors.
     * 
     * This method will return null if automatic dependency correlation is disabled.
     * @returns A plain object for request storage or null if automatic dependency correlation is disabled.
     */
    public static getCorrelationContext(): CorrelationContextManager.CorrelationContext {
        if (this._isCorrelating) {
            return CorrelationContextManager.CorrelationContextManager.getCurrentContext();
        }

        return null;
    }

    /**
     * Returns a function that will get the same correlation context within its function body as the code executing this function.
     * Use this method if automatic dependency correlation is not propagating correctly to an asynchronous callback.
     */
    public static wrapWithCorrelationContext<T extends Function>(fn: T): T {
        return CorrelationContextManager.CorrelationContextManager.wrapCallback(fn);
    }

    /**
     * Sets the state of console tracking (enabled by default)
     * @param value if true console activity will be sent to Application Insights
     * @returns {ApplicationInsights} this class
     */
    public static setAutoCollectConsole(value: boolean) {
        ApplicationInsights._isConsole = value;
        if (ApplicationInsights._isStarted){
            ApplicationInsights._console.enable(value);
        }

        return ApplicationInsights;
    }

    /**
     * Sets the state of exception tracking (enabled by default)
     * @param value if true uncaught exceptions will be sent to Application Insights
     * @returns {ApplicationInsights} this class
     */
    public static setAutoCollectExceptions(value: boolean) {
        ApplicationInsights._isExceptions = value;
        if (ApplicationInsights._isStarted){
            ApplicationInsights._exceptions.enable(value);
        }

        return ApplicationInsights;
    }

    /**
     * Sets the state of performance tracking (enabled by default)
     * @param value if true performance counters will be collected every second and sent to Application Insights
     * @returns {ApplicationInsights} this class
     */
    public static setAutoCollectPerformance(value: boolean) {
        ApplicationInsights._isPerformance = value;
        if (ApplicationInsights._isStarted){
            ApplicationInsights._performance.enable(value);
        }

        return ApplicationInsights;
    }

    /**
     * Sets the state of request tracking (enabled by default)
     * @param value if true requests will be sent to Application Insights
     * @returns {ApplicationInsights} this class
     */
    public static setAutoCollectRequests(value: boolean) {
        ApplicationInsights._isRequests = value;
        if (ApplicationInsights._isStarted) {
            ApplicationInsights._serverRequests.enable(value);
        }

        return ApplicationInsights;
    }

    /**
     * Sets the state of dependency tracking (enabled by default)
     * @param value if true dependencies will be sent to Application Insights
     * @returns {ApplicationInsights} this class
     */
    public static setAutoCollectDependencies(value: boolean) {
        ApplicationInsights._isDependencies = value;
        if (ApplicationInsights._isStarted) {
            ApplicationInsights._clientRequests.enable(value);
        }

        return ApplicationInsights;
    }

    /**
     * Sets the state of automatic dependency correlation (enabled by default)
     * @param value if true dependencies will be correlated with requests
     * @returns {ApplicationInsights} this class
     */
    public static setAutoDependencyCorrelation(value: boolean) {
        ApplicationInsights._isCorrelating = value;
        if (ApplicationInsights._isStarted) {
            ApplicationInsights._serverRequests.useAutoCorrelation(value);
        }

        return ApplicationInsights;
    }

     /**
     * Enable or disable offline mode to cache events when client is offline (disabled by default)
     * @param value if true events that occured while client is offline will be cached on disk
     * @param resendInterval. The wait interval for resending cached events.
     * @returns {ApplicationInsights} this class
     */
    public static setOfflineMode(value: boolean, resendInterval?: number) {
        ApplicationInsights._isOfflineMode = value;
        if (ApplicationInsights.client && ApplicationInsights.client.channel){
            ApplicationInsights.client.channel.setOfflineMode(value, resendInterval);
        }

        return ApplicationInsights;
    }

    /**
     * Enables verbose debug logging
     * @returns {ApplicationInsights} this class
     */
    public static enableVerboseLogging(enableWarningLogging = true) {
        Logging.enableDebug = true;
        Logging.disableWarnings = !enableWarningLogging;
        return ApplicationInsights;
    }

    /**
     * Disables verbose debug and warning logging
     */
    public static disableConsoleLogging() {
        Logging.enableDebug = false;
        Logging.disableWarnings = true;
        return ApplicationInsights;
    }

    /**
      * Disposes the default client and all the auto collectors so they can be reinitialized with different configuration
      */
    public static dispose() {
        ApplicationInsights.client = null;
        ApplicationInsights._isStarted = false;
        if (ApplicationInsights._console) {
            ApplicationInsights._console.dispose();
        }
        if (ApplicationInsights._exceptions) {
	    ApplicationInsights._exceptions.dispose();
        }
        if (ApplicationInsights._performance) {
            ApplicationInsights._performance.dispose();
        }
        if(ApplicationInsights._serverRequests) {
            ApplicationInsights._serverRequests.dispose();
        }
        if(ApplicationInsights._clientRequests) {
            ApplicationInsights._clientRequests.dispose();
        }
    }
}

export = ApplicationInsights;