com.microsoft.applicationinsights.library

Class TelemetryClient

java.lang.Object

com.microsoft.applicationinsights.library.TelemetryClient

public class TelemetryClient
extends java.lang.Object

The public API for recording application insights telemetry.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TelemetryClient(boolean telemetryEnabled) Restrict access to the default constructor

Method Summary

Modifier and Type	Method and Description
protected void	disableAutoAppearanceTracking() Disable auto appearance management tracking.
protected void	disableAutoPageViewTracking() Disable auto page view tracking.
protected void	disableAutoSessionManagement() Disable auto session management tracking.
protected void	enableAutoAppearanceTracking() Enable auto appearance management tracking.
protected void	enableAutoPageViewTracking() Enable auto page view tracking.
protected void	enableAutoSessionManagement() Enable auto session management tracking.
static TelemetryClient	getInstance()
protected static void	initialize(boolean telemetryEnabled, Application application) Initialize the INSTANCE of the telemetryclient
protected boolean	isTelemetryEnabled() Determines, whether tracking telemetry data is enabled or not.
protected static void	startAutoCollection(TelemetryContext context, Configuration config, boolean autoAppearanceEnabled, boolean autoPageViewsEnabled, boolean autoSessionManagementEnabled) Start auto collection features.
protected void	startSyncWhenBackgrounding()
void	track(TelemetryData telemetry) Sends information about any object that extend TelemetryData interface to Application Insights.
void	trackEvent(java.lang.String eventName) properties defaults to null.
void	trackEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.String> properties) measurements defaults to null.
void	trackEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.Double> measurements) Sends information about an event to Application Insights.
void	trackMetric(java.lang.String name, double value) Sends information about an aggregated metric to Application Insights.
void	trackMetric(java.lang.String name, double value, java.util.Map<java.lang.String,java.lang.String> properties) Sends information about an aggregated metric to Application Insights.
void	trackNewSession() Sends information about a new Session to Application Insights.
void	trackPageView(java.lang.String pageName) properties defaults to null.
void	trackPageView(java.lang.String pageName, java.util.Map<java.lang.String,java.lang.String> properties) measurements defaults to null.
void	trackPageView(java.lang.String pageName, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.Double> measurements)
void	trackTrace(java.lang.String message) measurements defaults to null.
void	trackTrace(java.lang.String message, java.util.Map<java.lang.String,java.lang.String> properties) Sends tracing information to Application Insights.

Methods inherited from class java.lang.Object

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

Constructor Detail

TelemetryClient

protected TelemetryClient(boolean telemetryEnabled)

Restrict access to the default constructor

Parameters:

telemetryEnabled - YES if tracking telemetry data manually should be enabled

Method Detail

initialize

protected static void initialize(boolean telemetryEnabled,
                                 Application application)

Initialize the INSTANCE of the telemetryclient

Parameters:

telemetryEnabled - YES if tracking telemetry data manually should be enabled

application - application used for auto collection features

startAutoCollection

protected static void startAutoCollection(TelemetryContext context,
                                          Configuration config,
                                          boolean autoAppearanceEnabled,
                                          boolean autoPageViewsEnabled,
                                          boolean autoSessionManagementEnabled)

Start auto collection features.

getInstance

public static TelemetryClient getInstance()

Returns:

the INSTANCE of persistence or null if not yet initialized

trackEvent

public void trackEvent(java.lang.String eventName)

properties defaults to null. measurements defaults to null.

See Also:

trackEvent(String, Map, Map)

trackEvent

public void trackEvent(java.lang.String eventName,
                       java.util.Map<java.lang.String,java.lang.String> properties)

measurements defaults to null.

See Also:

trackEvent(String, Map, Map)

track

public void track(TelemetryData telemetry)

Sends information about any object that extend TelemetryData interface to Application Insights. For most use-cases, the other tracking methods will be sufficient. Providing this generic method for very specific uses.

Parameters:

telemetry - an object that extends TelemetryData

trackEvent

public void trackEvent(java.lang.String eventName,
                       java.util.Map<java.lang.String,java.lang.String> properties,
                       java.util.Map<java.lang.String,java.lang.Double> measurements)

Sends information about an event to Application Insights.

Parameters:

eventName - The name of the event

properties - Custom properties associated with the event. Note: values set here will supersede values set in ApplicationInsights.setCommonProperties(java.util.Map<java.lang.String, java.lang.String>).

measurements - Custom measurements associated with the event.

trackTrace

public void trackTrace(java.lang.String message)

measurements defaults to null.

See Also:

trackTrace(String, Map)

trackTrace

public void trackTrace(java.lang.String message,
                       java.util.Map<java.lang.String,java.lang.String> properties)

Sends tracing information to Application Insights.

Parameters:

message - The message associated with this trace.

properties - Custom properties associated with the event. Note: values set here will supersede values set in ApplicationInsights.setCommonProperties(java.util.Map<java.lang.String, java.lang.String>).

trackMetric

public void trackMetric(java.lang.String name,
                        double value)

Sends information about an aggregated metric to Application Insights. Note: all data sent via this method will be aggregated. To log non-aggregated data use trackEvent(String, Map, Map) with measurements.

Parameters:

name - The name of the metric

value - The value of the metric

trackMetric

public void trackMetric(java.lang.String name,
                        double value,
                        java.util.Map<java.lang.String,java.lang.String> properties)

Sends information about an aggregated metric to Application Insights. Note: all data sent via this method will be aggregated. To log non-aggregated data use trackEvent(String, Map, Map) with measurements.

Parameters:

name - The name of the metric

value - The value of the metric

trackPageView

public void trackPageView(java.lang.String pageName)

properties defaults to null. measurements defaults to null.

See Also:

trackPageView(String, Map, Map)

trackPageView

public void trackPageView(java.lang.String pageName,
                          java.util.Map<java.lang.String,java.lang.String> properties)

measurements defaults to null.

See Also:

trackPageView(String, Map, Map)

trackPageView

public void trackPageView(java.lang.String pageName,
                          java.util.Map<java.lang.String,java.lang.String> properties,
                          java.util.Map<java.lang.String,java.lang.Double> measurements)

See Also:

trackPageView(String, Map, Map)

trackNewSession

public void trackNewSession()

Sends information about a new Session to Application Insights.

isTelemetryEnabled

protected boolean isTelemetryEnabled()

Determines, whether tracking telemetry data is enabled or not.

Returns:

YES if telemetry data can be tracked

enableAutoPageViewTracking

protected void enableAutoPageViewTracking()

Enable auto page view tracking. This feature only works if initialize(boolean, Application) has been called before.

disableAutoPageViewTracking

protected void disableAutoPageViewTracking()

Disable auto page view tracking. This feature only works if initialize(boolean, Application) has been called before.

enableAutoSessionManagement

protected void enableAutoSessionManagement()

Enable auto session management tracking. This feature only works if initialize(boolean, Application) has been called before.

disableAutoSessionManagement

protected void disableAutoSessionManagement()

Disable auto session management tracking. This feature only works if initialize(boolean, Application) has been called before.

enableAutoAppearanceTracking

protected void enableAutoAppearanceTracking()

Enable auto appearance management tracking. This feature only works if initialize(boolean, Application) has been called before.

disableAutoAppearanceTracking

protected void disableAutoAppearanceTracking()

Disable auto appearance management tracking. This feature only works if initialize(boolean, Application) has been called before.

startSyncWhenBackgrounding

protected void startSyncWhenBackgrounding()