public final class TelemetryConfiguration
extends java.lang.Object
TelemetryContext
objects are initialized using the
'Active' (returned by the 'getActive' static method) telemetry configuration provided by this class.Constructor and Description |
---|
TelemetryConfiguration() |
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() |
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.
|
public static TelemetryConfiguration getActive()
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.public static TelemetryConfiguration createDefault()
public TelemetryChannel getChannel()
TelemetryChannel
public void setChannel(TelemetryChannel channel)
channel
- An instance of TelemetryChannel
public boolean isTrackingDisabled()
TelemetryClient
instances created in the application.public void setTrackingIsDisabled(boolean disable)
TelemetryClient
instances created in the application.disable
- True to disable tracking.public java.util.List<ContextInitializer> getContextInitializers()
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.public java.util.List<TelemetryInitializer> getTelemetryInitializers()
public java.util.List<TelemetryModule> getTelemetryModules()
public java.lang.String getInstrumentationKey()
TelemetryClient
instances created in the application. This value can be overwritten by setting the Instrumentation Key in
TelemetryContext
classpublic void setInstrumentationKey(java.lang.String key)
TelemetryClient
instances created in the application. This value can be overwritten by setting the Instrumentation Key in
TelemetryContext
classkey
- The instrumentation keyjava.lang.IllegalArgumentException
- when the new value is null or empty