applicationinsights

property start

static start: () => typeof Configuration;

method enableWebInstrumentation

static enableWebInstrumentation: (
    value: boolean,
    WebSnippetConnectionString?: string
) => typeof Configuration;

• Sets the state of Web snippet injection

  Parameter value

  if true Web snippet will try to be injected in server response

  Parameter WebSnippetConnectionString

  if provided, Web snippet injection will use this ConnectionString. Default to use the connectionString in Node.js app initialization.

  Returns

  {Configuration} this class

method setAutoCollectConsole

static setAutoCollectConsole: (
    value: boolean,
    collectConsoleLog?: boolean
) => typeof Configuration;

• Sets the state of console and logger tracking (enabled by default for third-party loggers only)

  Parameter value

  if true logger activity will be sent to Application Insights

  Parameter collectConsoleLog

  if true, logger autocollection will include console.log calls (default false)

  Returns

  {Configuration} this class

method setAutoCollectDependencies

static setAutoCollectDependencies: (value: boolean) => typeof Configuration;

• Sets the state of dependency tracking (enabled by default)

  Parameter value

  if true dependencies will be sent to Application Insights

  Returns

  {Configuration} this class

method setAutoCollectExceptions

static setAutoCollectExceptions: (value: boolean) => typeof Configuration;

• Sets the state of exception tracking (enabled by default)

  Parameter value

  if true uncaught exceptions will be sent to Application Insights

  Returns

  {Configuration} this class

method setAutoCollectHeartbeat

static setAutoCollectHeartbeat: (value: boolean) => typeof Configuration;

• Sets the state of request tracking (enabled by default)

  Parameter value

  if true HeartBeat metric data will be collected every 15 minutes and sent to Application Insights

  Returns

  {Configuration} this class

method setAutoCollectIncomingRequestAzureFunctions

static setAutoCollectIncomingRequestAzureFunctions: (
    value: boolean
) => typeof Configuration;

• Enable automatic incoming request tracking when using Azure Functions

  Parameter value

  if true auto collection of incoming requests will be enabled

  Returns

  {Configuration} this class

method setAutoCollectPerformance

static setAutoCollectPerformance: (
    value: boolean,
    collectExtendedMetrics: any
) => typeof Configuration;

• Sets the state of performance tracking (enabled by default)

  Parameter value

  if true performance counters will be collected every second and sent to Application Insights

  Parameter collectExtendedMetrics

  if true, extended metrics counters will be collected every minute and sent to Application Insights

  Returns

  {Configuration} this class

method setAutoCollectPreAggregatedMetrics

static setAutoCollectPreAggregatedMetrics: (
    value: boolean
) => typeof Configuration;

• Sets the state of pre aggregated metrics tracking (enabled by default)

  Parameter value

  if true pre aggregated metrics will be collected every minute and sent to Application Insights

  Returns

  {Configuration} this class

method setAutoCollectRequests

static setAutoCollectRequests: (value: boolean) => typeof Configuration;

• Sets the state of request tracking (enabled by default)

  Parameter value

  if true requests will be sent to Application Insights

  Returns

  {Configuration} this class

method setAutoDependencyCorrelation

static setAutoDependencyCorrelation: (
    value: boolean,
    useAsyncHooks?: boolean
) => typeof Configuration;

• Sets the state of automatic dependency correlation (enabled by default)

  Parameter value

  if true dependencies will be correlated with requests

  Parameter 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

method setAzureMonitorOptions

static setAzureMonitorOptions: (
    value: AzureMonitorOpenTelemetryOptions
) => typeof Configuration;

• Set the options for @azure/monitor-opentelemetry

  Parameter value

  the options to set

  Returns

  {Configuration} this class

method setDistributedTracingMode

static setDistributedTracingMode: (value: number) => typeof Configuration;

• Only W3C traing mode is currently suppported so this method informs the user if they attempt to set the value.

method setInternalLogging

static setInternalLogging: (
    enableDebugLogger?: boolean,
    enableWarningLogger?: boolean
) => typeof Configuration;

• Enables debug and warning Logger for AppInsights itself.

  Parameter enableDebugLogger

  if true, enables debug Logger

  Parameter enableWarningLogger

  if true, enables warning Logger

  Returns

  {Configuration} this class

method setSendLiveMetrics

static setSendLiveMetrics: (enable?: boolean) => typeof Configuration;

• Enables communication with Application Insights Live Metrics.

  Parameter enable

  if true, enables communication with the live metrics service

method setUseDiskRetryCaching

static setUseDiskRetryCaching: (
    value: boolean,
    resendInterval?: number,
    maxBytesOnDisk?: number
) => 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.

  Parameter value

  if true events that occured while client is offline will be cached on disk

  Parameter resendInterval

  The wait interval for resending cached events.

  Parameter 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

constructor

constructor(input?: string);

• Constructs a new instance of TelemetryClient

  Parameter setupString

  the Connection String or Instrumentation Key to use (read from environment variable if not specified)

property commonProperties

commonProperties: { [key: string]: string };

property config

config: Config;

property context

context: Context;

method addTelemetryProcessor

addTelemetryProcessor: (
    telemetryProcessor: (
        envelope: Envelope,
        contextObjects?: { [name: string]: any }
    ) => boolean
) => void;

• Adds telemetry processor to the collection. Telemetry processors will be called one by one before telemetry item is pushed for sending and in the order they were added.

  Parameter telemetryProcessor

  function, takes Envelope, and optional context object and returns boolean

method clearTelemetryProcessors

clearTelemetryProcessors: () => void;

method flush

flush: () => Promise<void>;

• Immediately send all queued telemetry.

method getAuthorizationHandler

getAuthorizationHandler: (config: Config) => void;

• Get Authorization handler

method getStatsbeat

getStatsbeat: () => any;

method initialize

initialize: () => void;

method pushWarningToLog

pushWarningToLog: (warning: string) => void;

method setAutoPopulateAzureProperties

setAutoPopulateAzureProperties: () => void;

• Automatically populate telemetry properties like RoleName when running in Azure

  Parameter value

  if true properties will be populated

method setUseDiskRetryCaching

setUseDiskRetryCaching: (
    value: boolean,
    resendInterval?: number,
    maxBytesOnDisk?: number
) => void;

method shutdown

shutdown: () => Promise<void>;

• Shutdown client

method track

track: (
    telemetry: Contracts.Telemetry,
    telemetryType: Contracts.TelemetryType
) => void;

• Generic track method for all telemetry types

  Parameter data

  the telemetry to send

  Parameter telemetryType

  specify the type of telemetry you are tracking from the list of Contracts.DataTypes

method trackAvailability

trackAvailability: (telemetry: Contracts.AvailabilityTelemetry) => void;

• Log information about availability of an application

  Parameter telemetry

  Object encapsulating tracking options

method trackDependency

trackDependency: (telemetry: Contracts.DependencyTelemetry) => void;

• Log a dependency. Note that the default client will attempt to collect dependencies automatically so only use this for dependencies that aren't automatically captured or if you've disabled automatic dependency collection.

  Parameter telemetry

  Object encapsulating tracking option

method trackEvent

trackEvent: (telemetry: Contracts.EventTelemetry) => void;

• Log a user action or other occurrence.

  Parameter telemetry

  Object encapsulating tracking options

method trackException

trackException: (telemetry: Contracts.ExceptionTelemetry) => void;

• Log an exception

  Parameter telemetry

  Object encapsulating tracking options

method trackMetric

trackMetric: (
    telemetry: Contracts.MetricPointTelemetry & Contracts.MetricTelemetry
) => void;

• Log a numeric value that is not associated with a specific event. Typically used to send regular reports of performance indicators. To send a single measurement, use just the first two parameters. If you take measurements very frequently, you can reduce the telemetry bandwidth by aggregating multiple measurements and sending the resulting average at intervals.

  Parameter telemetry

  Object encapsulating tracking options

method trackNodeHttpDependency

trackNodeHttpDependency: (telemetry: Contracts.NodeHttpRequestTelemetry) => void;

method trackNodeHttpRequest

trackNodeHttpRequest: (telemetry: Contracts.NodeHttpRequestTelemetry) => void;

method trackNodeHttpRequestSync

trackNodeHttpRequestSync: (
    telemetry: Contracts.NodeHttpRequestTelemetry
) => void;

method trackPageView

trackPageView: (telemetry: Contracts.PageViewTelemetry) => void;

• Log a page view

  Parameter telemetry

  Object encapsulating tracking options

method trackRequest

trackRequest: (telemetry: Contracts.RequestTelemetry) => void;

• Log a request. Note that the default client will attempt to collect HTTP requests automatically so only use this for requests that aren't automatically captured or if you've disabled automatic request collection.

  Parameter telemetry

  Object encapsulating tracking options

method trackTrace

trackTrace: (telemetry: Contracts.TraceTelemetry) => void;

• Log a trace message

  Parameter telemetry

  Object encapsulating tracking options

property duration

duration: number;

• Request duration in ms

property id

id: string;

• Identifier of a test run. Use it to correlate steps of test run and telemetry generated by the service.

property measurements

measurements?: {
    [key: string]: number;
};

• Metrics associated with this event, displayed in Metrics Explorer on the portal.

property message

message: string;

• Diagnostic message for the result.

property name

name: string;

• Name of the test that these availability results represent.

property runLocation

runLocation: string;

• Name of the location where the test was run from.

property success

success: boolean;

• Success flag.

property enableAutoCollectDependencies

enableAutoCollectDependencies?: boolean;

property enableAutoCollectExceptions

enableAutoCollectExceptions?: boolean;

• Sets the state of exception tracking (enabled by default) if true uncaught exceptions will be sent to Application Insights

property enableAutoCollectPerformance

enableAutoCollectPerformance?: boolean;

• Sets the state of performance tracking (enabled by default) if true performance counters will be collected every second and sent to Azure Monitor

property enableAutoCollectRequests

enableAutoCollectRequests?: boolean;

property otlpLogExporterConfig

otlpLogExporterConfig?: OTLPExporterConfig;

• OTLP Log Exporter Configuration

property otlpMetricExporterConfig

otlpMetricExporterConfig?: OTLPExporterConfig;

• OTLP Metric Exporter Configuration

property otlpTraceExporterConfig

otlpTraceExporterConfig?: OTLPExporterConfig;

• OTLP Trace Exporter Configuration

property measurements

measurements?: {
    [key: string]: number;
};

• Metrics associated with this event, displayed in Metrics Explorer on the portal.

property name

name: string;

• Name of the event

property exception

exception: Error;

• Exception thrown

property measurements

measurements?: {
    [key: string]: number;
};

• Metrics associated with this exception, displayed in Metrics Explorer on the portal. Defaults to empty

property severity

severity?: SeverityLevel;

• Exception severity level

property headers

headers: {
    [key: string]: string;
};

property method

method: string | null;

property url

url: string;

property console

console?: InstrumentationConfig & {
    logSendingLevel?: SeverityNumber;
};

• Console Instrumentation Config

property duration

duration?: number;

• Request duration in milliseconds.

property id

id: string;

• Identifier of a page view instance. Used for correlation between page view and other telemetry items.

property measurements

measurements?: {
    [propertyName: string]: number;
};

• Collection of custom measurements.

property name

name: string;

• Event name. Keep it low cardinality to allow proper grouping and useful metrics.

property referredUri

referredUri?: string;

• Fully qualified page URI or URL of the referring page; if unknown, leave blank

property url

url?: string;

• Request URL with all query string parameters

property properties

properties?: {
    [key: string]: any;
};

• Additional data used to filter events and metrics in the portal. Defaults to empty.

property time

time?: Date;

• Telemetry time stamp. When it is not specified, current timestamp will be used.

property measurements

measurements?: {
    [propertyName: string]: number;
};

• Collection of custom measurements.

property message

message: string;

• Trace message

property severity

severity?: SeverityLevel;

• Trace severity level.

member AI

AI = 0

• Send Application Insights correlation headers

member AI_AND_W3C

AI_AND_W3C = 1

• (Default) Send both W3C Trace Context headers and back-compatibility Application Insights headers

member Critical

Critical = 'Critical'

member Error

Error = 'Error'

member Information

Information = 'Information'

member Verbose

Verbose = 'Verbose'

member Warning

Warning = 'Warning'