/// import * as http from "http"; import { SpanContext } from "@opentelemetry/api"; import { Span } from "@opentelemetry/sdk-trace-base"; import { ICorrelationContext, HttpRequest, DistributedTracingModes, AzureFnContext } from "./types"; import { TelemetryClient } from "./telemetryClient"; import * as Contracts from "../declarations/contracts"; export { Contracts, DistributedTracingModes, HttpRequest, TelemetryClient }; /** * The default client, initialized when setup was called. To initialize a different client * with its own configuration, use `new TelemetryClient(instrumentationKey?)`. */ export declare let defaultClient: TelemetryClient; /** * Initializes the default client. Should be called after setting * configuration options. * * @param setupString the Connection String or Instrumentation Key to use. Optional, if * this is not specified, the value will be read from the environment * variable APPLICATIONINSIGHTS_CONNECTION_STRING or APPINSIGHTS_INSTRUMENTATIONKEY. * @returns {Configuration} the configuration class to initialize * and start the SDK. */ export declare function setup(setupString?: string): typeof Configuration; /** * Starts automatic collection of telemetry. Prior to calling start no * telemetry will be *automatically* collected, though manual collection * is enabled. * @returns {ApplicationInsights} this class */ export declare function start(): typeof Configuration; /** * 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. * * Do not store sensitive information here. * Custom properties set on this object can be exposed in a future SDK * release via outgoing HTTP headers. * This is to allow for correlating data cross-component. * * 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. */ export declare function getCorrelationContext(): ICorrelationContext; /** * **(Experimental!)** * Starts a fresh context or propagates the current internal one. */ export declare function startOperation(arg1: AzureFnContext | (http.IncomingMessage | AzureFnContext) | SpanContext | Span, arg2?: HttpRequest | string): ICorrelationContext | 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. */ export declare function wrapWithCorrelationContext(fn: T, context?: ICorrelationContext): T; /** * The active configuration for global SDK behaviors, such as auto collection. */ export declare class Configuration { static start: typeof start; /** * Only W3C traing mode is currently suppported so this method informs the user if they attempt to set the value. */ static setDistributedTracingMode(value: number): typeof Configuration; /** * Sets the state of console and logger tracking (enabled by default for third-party loggers only) * @param value if true logger activity will be sent to Application Insights * @param collectConsoleLog if true, logger autocollection will include console.log calls (default false) * @returns {Configuration} this class */ static setAutoCollectConsole(value: boolean, collectConsoleLog?: boolean): typeof Configuration; /** * Sets the state of exception tracking (enabled by default) * @param value if true uncaught exceptions will be sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectExceptions(value: boolean): typeof Configuration; /** * 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 * @param collectExtendedMetrics if true, extended metrics counters will be collected every minute and sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectPerformance(value: boolean, collectExtendedMetrics: any): typeof Configuration; /** * Sets the state of pre aggregated metrics tracking (enabled by default) * @param value if true pre aggregated metrics will be collected every minute and sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectPreAggregatedMetrics(value: boolean): typeof Configuration; /** * Sets the state of request tracking (enabled by default) * @param value if true HeartBeat metric data will be collected every 15 minutes and sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectHeartbeat(value: boolean): typeof Configuration; /** * Sets the state of Web snippet injection * @param value if true Web snippet will try to be injected in server response * @param WebSnippetConnectionString if provided, Web snippet injection will use this ConnectionString. Default to use the connectionString in Node.js app initialization. * @returns {Configuration} this class */ static enableWebInstrumentation(value: boolean, WebSnippetConnectionString?: string): typeof Configuration; /** * Sets the state of request tracking (enabled by default) * @param value if true requests will be sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectRequests(value: boolean): typeof Configuration; /** * Sets the state of dependency tracking (enabled by default) * @param value if true dependencies will be sent to Application Insights * @returns {Configuration} this class */ static setAutoCollectDependencies(value: boolean): typeof Configuration; /** * Sets the state of automatic dependency correlation (enabled by default) * @param value if true dependencies will be correlated with requests * @param useAsyncHooks if true, forces use of experimental async_hooks module to provide correlation. If false, instead uses only patching-based techniques. If left blank, the best option is chosen for you based on your version of Node.js. * @returns {Configuration} this class */ static setAutoDependencyCorrelation(value: boolean, useAsyncHooks?: boolean): typeof Configuration; /** * Enable or disable disk-backed retry caching to cache events when client is offline (enabled by default) * Note that this method only applies to the default client. Disk-backed retry caching is disabled by default for additional clients. * For enable for additional clients, use client.channel.setUseDiskRetryCaching(true). * These cached events are stored in your system or user's temporary directory and access restricted to your user when possible. * @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. * @param maxBytesOnDisk The maximum size (in bytes) that the created temporary directory for cache events can grow to, before caching is disabled. * @returns {Configuration} this class */ static setUseDiskRetryCaching(value: boolean, resendInterval?: number, maxBytesOnDisk?: number): typeof Configuration; /** * Enables debug and warning Logger for AppInsights itself. * @param enableDebugLogger if true, enables debug Logger * @param enableWarningLogger if true, enables warning Logger * @returns {Configuration} this class */ static setInternalLogging(enableDebugLogger?: boolean, enableWarningLogger?: boolean): typeof Configuration; /** * Enable automatic incoming request tracking when using Azure Functions * @param value if true auto collection of incoming requests will be enabled * @returns {Configuration} this class */ static setAutoCollectIncomingRequestAzureFunctions(value: boolean): typeof Configuration; /** * Enables communication with Application Insights Live Metrics. * @param enable if true, enables communication with the live metrics service */ static setSendLiveMetrics(enable?: boolean): typeof Configuration; } /** * Disposes the default client and all the auto collectors so they can be reinitialized with different configuration */ export declare function dispose(): void;