Interface IAnalyticsConfig

Configuration interface specifically for AnalyticsPlugin This interface defines only the configuration properties that the Analytics plugin uses.

interface IAnalyticsConfig {
    autoTrackPageVisitTime?: boolean;
    disableExceptionTracking?: boolean;
    disableFlushOnBeforeUnload?: boolean;
    disableFlushOnUnload?: boolean;
    enableAutoRouteTracking?: boolean;
    enableDebug?: boolean;
    enableUnhandledPromiseRejectionTracking?: boolean;
    expCfg?: IExceptionConfig;
    isBrowserLinkTrackingEnabled?: boolean;
    isStorageUseDisabled?: boolean;
    namePrefix?: string;
    overridePageViewDuration?: boolean;
    routeTraceStrategy?: eRouteTraceStrategy;
    samplingPercentage?: number;
    sessionExpirationMs?: number;
    sessionRenewalMs?: number;
}

Properties

autoTrackPageVisitTime? disableExceptionTracking? disableFlushOnBeforeUnload? disableFlushOnUnload? enableAutoRouteTracking? enableDebug? enableUnhandledPromiseRejectionTracking? expCfg? isBrowserLinkTrackingEnabled? isStorageUseDisabled? namePrefix? overridePageViewDuration? routeTraceStrategy? samplingPercentage? sessionExpirationMs? sessionRenewalMs?

Properties

OptionalautoTrackPageVisitTime

autoTrackPageVisitTime?: boolean

If true, on a pageview, the previous instrumented page's view time is tracked and sent as telemetry and a new timer is started for the current pageview.

Default

false

OptionaldisableExceptionTracking

disableExceptionTracking?: boolean

If true, exceptions are not autocollected.

Default

false

OptionaldisableFlushOnBeforeUnload

disableFlushOnBeforeUnload?: boolean

If true, flush method will not be called when onBeforeUnload event triggers.

Default

false

OptionaldisableFlushOnUnload

disableFlushOnUnload?: boolean

If true, flush method will not be called when onPageHide or onVisibilityChange (hidden state) event(s) trigger.

Default

false

OptionalenableAutoRouteTracking

enableAutoRouteTracking?: boolean

Automatically track route changes in Single Page Applications (SPA). If true, each route change will send a new Pageview to Application Insights.

Default

false

OptionalenableDebug

enableDebug?: boolean

If true, debugging data is thrown as an exception by the logger.

Default

false

OptionalenableUnhandledPromiseRejectionTracking

enableUnhandledPromiseRejectionTracking?: boolean

Define whether to track unhandled promise rejections and report as JS errors.

Default

false

OptionalexpCfg

expCfg?: IExceptionConfig

Exception configuration for additional exception handling options.

Default

{ inclScripts: false, expLog: undefined, maxLogs: 50 }

OptionalisBrowserLinkTrackingEnabled

isBrowserLinkTrackingEnabled?: boolean

If true, the SDK will track all Browser Link requests.

Default

false

OptionalisStorageUseDisabled

isStorageUseDisabled?: boolean

If true, the SDK will not store or read any data from local and session storage.

Default

false

OptionalnamePrefix

namePrefix?: string

An optional value that will be used as name postfix for localStorage and session cookie name.

Default

""

Example

"MyApp" // Results in localStorage keys like "ai_session_MyApp"

OptionaloverridePageViewDuration

overridePageViewDuration?: boolean

If true, default behavior of trackPageView is changed to record end of page view duration interval when trackPageView is called.

Default

false

OptionalrouteTraceStrategy

routeTraceStrategy?: eRouteTraceStrategy

Controls the trace context strategy for SPA route changes. Determines how trace contexts are managed and correlated across virtual page views in Single Page Applications, affecting telemetry correlation and operation tracking.

Default

eRouteTraceStrategy.Server

Since

3.4.0

OptionalsamplingPercentage

samplingPercentage?: number

Percentage of events that will be sent. Value must be between 0 and 100.

Default

100

Example

50 // Only send 50% of events

OptionalsessionExpirationMs

sessionExpirationMs?: number

A session is logged if it has continued for this amount of time in milliseconds.

Default

86400000 (24 hours)

OptionalsessionRenewalMs

sessionRenewalMs?: number

A session is logged if the user is inactive for this amount of time in milliseconds.

Default

1800000 (30 minutes)

Settings

Member Visibility

On This Page

Properties