com.microsoft.applicationinsights.library

Enum ApplicationInsights

java.lang.Object

java.lang.Enum<ApplicationInsights>

com.microsoft.applicationinsights.library.ApplicationInsights

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ApplicationInsights>

public enum ApplicationInsights
extends java.lang.Enum<ApplicationInsights>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
static void	disableAutoAppearanceTracking() Disable auto appearance management tracking before calling start() or at runtime.
static void	disableAutoCollection() disables all auto-collection features
static void	disableAutoPageViewTracking() Disable auto page view tracking before calling start() or at runtime.
static void	disableAutoSessionManagement() Disable auto session management tracking before calling start() or at runtime.
static void	enableAutoAppearanceTracking() Enable auto appearance management tracking before calling start() or at runtime.
static void	enableAutoCollection() Enables all auto-collection features.
static void	enableAutoPageViewTracking() Enable auto page view tracking before calling start() or at runtime.
static void	enableAutoSessionManagement() Enable auto session management tracking before calling start() or at runtime.
static ChannelType	getChannelType() Gets the currently used channel type
static java.util.Map<java.lang.String,java.lang.String>	getCommonProperties() Gets the properties which are common to all telemetry sent from this client.
static Configuration	getConfiguration() Gets the configuration for the ApplicationInsights instance
protected static java.lang.String	getInstrumentationKey() Get the instrumentation key associated with this app.
static TelemetryContext	getTelemetryContext() Gets the configuration for the ApplicationInsights instance
static boolean	isDeveloperMode() Check if developerMode is activated
static void	renewSession(java.lang.String sessionId) Force Application Insights to create a new session with a custom sessionID.
static void	sendPendingData() Triggers persisting and if applicable sending of queued data note: this will be called Configuration.maxBatchIntervalMs after tracking any telemetry so it is not necessary to call this in most cases.
static void	setChannelType(ChannelType channelType) Sets the channel type to be used for logging
static void	setCommonProperties(java.util.Map<java.lang.String,java.lang.String> commonProperties) Sets properties which are common to all telemetry sent form this client.
static void	setDeveloperMode(boolean developerMode) Activates the developer mode which.
static void	setTelemetryDisabled(boolean disabled) Enable / disable tracking of telemetry data.
static void	setup(Context context, Application application) Configure Application Insights Note: This should be called before start
static void	setup(Context context, Application application, java.lang.String instrumentationKey) Configure Application Insights Note: This should be called before start
static void	start() Start ApplicationInsights Note: This should be called after isConfigured
static ApplicationInsights	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ApplicationInsights[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ApplicationInsights INSTANCE

Method Detail

values

public static ApplicationInsights[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ApplicationInsights c : ApplicationInsights.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ApplicationInsights valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

setup

public static void setup(Context context,
                         Application application)

Configure Application Insights Note: This should be called before start

Parameters:

application - the application context the application needed for auto collecting telemetry data

setup

public static void setup(Context context,
                         Application application,
                         java.lang.String instrumentationKey)

Configure Application Insights Note: This should be called before start

Parameters:

context - the application context associated with Application Insights

application - the application needed for auto collecting telemetry data

instrumentationKey - the instrumentation key associated with the app

start

public static void start()

Start ApplicationInsights Note: This should be called after isConfigured

sendPendingData

public static void sendPendingData()

Triggers persisting and if applicable sending of queued data note: this will be called Configuration.maxBatchIntervalMs after tracking any telemetry so it is not necessary to call this in most cases.

enableAutoCollection

public static void enableAutoCollection()

Enables all auto-collection features. Call this before start() or when ApplicationInsights is already running to change AutoCollection settings at runtime. Requires ApplicationInsights to be setup with an Application object

disableAutoCollection

public static void disableAutoCollection()

disables all auto-collection features

enableAutoPageViewTracking

public static void enableAutoPageViewTracking()

Enable auto page view tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

disableAutoPageViewTracking

public static void disableAutoPageViewTracking()

Disable auto page view tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

enableAutoSessionManagement

public static void enableAutoSessionManagement()

Enable auto session management tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

disableAutoSessionManagement

public static void disableAutoSessionManagement()

Disable auto session management tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

enableAutoAppearanceTracking

public static void enableAutoAppearanceTracking()

Enable auto appearance management tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

disableAutoAppearanceTracking

public static void disableAutoAppearanceTracking()

Disable auto appearance management tracking before calling start() or at runtime. This feature only works if ApplicationInsights has been setup with an application.

setTelemetryDisabled

public static void setTelemetryDisabled(boolean disabled)

Enable / disable tracking of telemetry data.

Parameters:

disabled - if set to true, the telemetry feature will be disabled

getCommonProperties

public static java.util.Map<java.lang.String,java.lang.String> getCommonProperties()

Gets the properties which are common to all telemetry sent from this client.

Returns:

common properties for this telemetry client

setCommonProperties

public static void setCommonProperties(java.util.Map<java.lang.String,java.lang.String> commonProperties)

Sets properties which are common to all telemetry sent form this client.

Parameters:

commonProperties - a dictionary of properties to log with all telemetry.

setDeveloperMode

public static void setDeveloperMode(boolean developerMode)

Activates the developer mode which. It enables extensive logging as well as use different settings for batching. Batch Size in debug mode is 5 and sending interval is 3s.

Parameters:

developerMode - if true, developer mode will be activated

isDeveloperMode

public static boolean isDeveloperMode()

Check if developerMode is activated

Returns:

flag indicating activated developer mode

getConfiguration

public static Configuration getConfiguration()

Gets the configuration for the ApplicationInsights instance

Returns:

the Configuration object

getTelemetryContext

public static TelemetryContext getTelemetryContext()

Gets the configuration for the ApplicationInsights instance

Returns:

the instance ApplicationInsights configuration

renewSession

public static void renewSession(java.lang.String sessionId)

Force Application Insights to create a new session with a custom sessionID.

Parameters:

sessionId - a custom session ID used of the session to create

setChannelType

public static void setChannelType(ChannelType channelType)

Sets the channel type to be used for logging

Parameters:

channelType - The channel type to use

getChannelType

public static ChannelType getChannelType()

Gets the currently used channel type

Returns:

The current channel type.

getInstrumentationKey

protected static java.lang.String getInstrumentationKey()

Get the instrumentation key associated with this app.

Returns:

the Application Insights instrumentation key set for this app