com.microsoft.applicationinsights

Class TelemetryConfiguration

java.lang.Object

com.microsoft.applicationinsights.TelemetryConfiguration

public final class TelemetryConfiguration
extends java.lang.Object

Encapsulates the global telemetry configuration typically loaded from the ApplicationInsights.xml file. All TelemetryContext objects are initialized using the 'Active' (returned by the 'getActive' static method) telemetry configuration provided by this class.

Constructor Summary

Constructors

Constructor and Description
TelemetryConfiguration()

Method Summary

Modifier and Type	Method and Description
static TelemetryConfiguration	createDefault() Creates a new instance loaded from the ApplicationInsights.xml file.
static TelemetryConfiguration	getActive() Gets the active TelemetryConfiguration instance loaded from the ApplicationInsights.xml file.
TelemetryChannel	getChannel() Gets the telemetry channel.
java.util.List<ContextInitializer>	getContextInitializers() Gets the list of ContextInitializer objects that supply additional information about application.
java.lang.String	getInstrumentationKey() Gets or sets the default instrumentation key for the application.
java.util.List<TelemetryInitializer>	getTelemetryInitializers() Gets the list of modules that automatically generate application telemetry.
java.util.List<TelemetryModule>	getTelemetryModules()
java.util.List<TelemetryProcessor>	getTelemetryProcessors()
boolean	isTrackingDisabled() Gets value indicating whether sending of telemetry to Application Insights is disabled.
void	setChannel(TelemetryChannel channel) Sets the telemetry channel.
void	setInstrumentationKey(java.lang.String key) Gets or sets the default instrumentation key for the application.
void	setTrackingIsDisabled(boolean disable) Sets value indicating whether sending of telemetry to Application Insights is disabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TelemetryConfiguration

public TelemetryConfiguration()

Method Detail

getActive

public static TelemetryConfiguration getActive()

Gets the active TelemetryConfiguration instance loaded from the ApplicationInsights.xml file. If the configuration file does not exist, the active configuration instance is initialized with minimum defaults needed to send telemetry to Application Insights.

Returns:

The 'Active' instance

createDefault

public static TelemetryConfiguration createDefault()

Creates a new instance loaded from the ApplicationInsights.xml file. If the configuration file does not exist, the new configuration instance is initialized with minimum defaults needed to send telemetry to Application Insights.

Returns:

Telemetry Configuration instance.

getChannel

public TelemetryChannel getChannel()

Gets the telemetry channel.

Returns:

An instance of TelemetryChannel

setChannel

public void setChannel(TelemetryChannel channel)

Sets the telemetry channel.

Parameters:

channel - An instance of TelemetryChannel

isTrackingDisabled

public boolean isTrackingDisabled()

Gets value indicating whether sending of telemetry to Application Insights is disabled. This disable tracking setting value is used by default by all TelemetryClient instances created in the application.

Returns:

True if tracking is disabled.

setTrackingIsDisabled

public void setTrackingIsDisabled(boolean disable)

Sets value indicating whether sending of telemetry to Application Insights is disabled. This disable tracking setting value is used by default by all TelemetryClient instances created in the application.

Parameters:

disable - True to disable tracking.

getContextInitializers

public java.util.List<ContextInitializer> getContextInitializers()

Gets the list of ContextInitializer objects that supply additional information about application. Context initializers extend Application Insights telemetry collection by supplying additional information about application environment, such as 'User' information (in TelemetryContext.getUser or Device (in TelemetryContext.getDevice invokes telemetry initializers each time the TelemetryClient's 'track' method is called The default list of telemetry initializers is provided by the SDK and can also be set from the ApplicationInsights.xml.

Returns:

Collection of Context Initializers

getTelemetryInitializers

public java.util.List<TelemetryInitializer> getTelemetryInitializers()

Gets the list of modules that automatically generate application telemetry. Telemetry modules automatically send telemetry describing the application to Application Insights. For example, a telemetry module can handle application exception events and automatically send

Returns:

List of Telemetry Initializers

getTelemetryModules

public java.util.List<TelemetryModule> getTelemetryModules()

getTelemetryProcessors

public java.util.List<TelemetryProcessor> getTelemetryProcessors()

getInstrumentationKey

public java.lang.String getInstrumentationKey()

Gets or sets the default instrumentation key for the application. This instrumentation key value is used by default by all TelemetryClient instances created in the application. This value can be overwritten by setting the Instrumentation Key in TelemetryContext class

Returns:

The instrumentation key

setInstrumentationKey

public void setInstrumentationKey(java.lang.String key)

Gets or sets the default instrumentation key for the application. This instrumentation key value is used by default by all TelemetryClient instances created in the application. This value can be overwritten by setting the Instrumentation Key in TelemetryContext class

Parameters:

key - The instrumentation key

Throws:

java.lang.IllegalArgumentException - when the new value is null or empty