com.microsoft.applicationinsights

Class TelemetryClient

java.lang.Object

com.microsoft.applicationinsights.TelemetryClient

public class TelemetryClient
extends java.lang.Object

Created by gupele on 1/5/2015.

Constructor Summary

Constructors

Constructor and Description
TelemetryClient() Initializes a new instance of the TelemetryClient class, configured from the active configuration.
TelemetryClient(TelemetryConfiguration configuration) Initializes a new instance of the TelemetryClient class.

Method Summary

Modifier and Type	Method and Description
TelemetryContext	getContext() Gets the current context that will be used to augment telemetry you send.
boolean	isDisabled() Checks whether tracking is enabled or not.
void	track(Telemetry telemetry) This method is part of the Application Insights infrastructure.
void	trackEvent(EventTelemetry telemetry) Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.
void	trackEvent(java.lang.String name) Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.
void	trackEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.Double> metrics) Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.
void	trackException(java.lang.Exception exception) Sends an ExceptionTelemetry record for display in Diagnostic Search.
void	trackException(java.lang.Exception exception, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.Double> metrics) Sends an ExceptionTelemetry record for display in Diagnostic Search.
void	trackException(ExceptionTelemetry telemetry) Sends an ExceptionTelemetry record for display in Diagnostic Search.
void	trackHttpRequest(HttpRequestTelemetry request)
void	trackHttpRequest(java.lang.String name, java.util.Date timestamp, long duration, java.lang.String responseCode, boolean success) Sends a HttpRequestTelemetry record for display in Diagnostic Search.
void	trackMetric(MetricTelemetry telemetry) Send a MetricTelemetry record for aggregation in Metric Explorer.
void	trackMetric(java.lang.String name, double value) Sends a MetricTelemetry record for aggregation in Metric Explorer.
void	trackMetric(java.lang.String name, double value, int sampleCount, double min, double max, java.util.Map<java.lang.String,java.lang.String> properties) Sends a MetricTelemetry record for aggregation in Metric Explorer.
void	trackPageView(PageViewTelemetry telemetry) Send information about the page viewed in the application.
void	trackPageView(java.lang.String name)
void	trackRemoteDependency(RemoteDependencyTelemetry telemetry)
void	trackSessionState(SessionState sessionState) Sends the specified state of a user session to Application Insights.
void	trackTrace(java.lang.String message) Sends a TraceTelemetry record for display in Diagnostic Search.
void	trackTrace(java.lang.String message, SeverityLevel severityLevel)
void	trackTrace(java.lang.String message, SeverityLevel severityLevel, java.util.Map<java.lang.String,java.lang.String> properties) Sends a TraceTelemetry record for display in Diagnostic Search.
void	trackTrace(TraceTelemetry telemetry) Sends a TraceTelemetry record for display in Diagnostic Search.

Methods inherited from class java.lang.Object

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

Constructor Detail

TelemetryClient

public TelemetryClient(TelemetryConfiguration configuration)

Initializes a new instance of the TelemetryClient class. Send telemetry with the specified configuration.

Parameters:

configuration - The configuration this instance will work with.

TelemetryClient

public TelemetryClient()

Initializes a new instance of the TelemetryClient class, configured from the active configuration.

Method Detail

getContext

public TelemetryContext getContext()

Gets the current context that will be used to augment telemetry you send.

Returns:

A telemetry context used for all records. Changes to it will impact all future telemetry in this application session.

isDisabled

public boolean isDisabled()

Checks whether tracking is enabled or not.

Returns:

'true' if tracking is disabled, 'false' otherwise.

trackSessionState

public void trackSessionState(SessionState sessionState)

Sends the specified state of a user session to Application Insights.

Parameters:

sessionState - SessionState value indicating the state of a user session.

trackEvent

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

Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.

Parameters:

name - A name for the event.

properties - Named string values you can use to search and classify events.

metrics - Measurements associated with this event.

trackEvent

public void trackEvent(java.lang.String name)

Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.

Parameters:

name - A name for the event.

trackEvent

public void trackEvent(EventTelemetry telemetry)

Sends an EventTelemetry record for display in Diagnostic Search and aggregation in Metrics Explorer.

Parameters:

telemetry - An event log item.

trackTrace

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

Sends a TraceTelemetry record for display in Diagnostic Search.

Parameters:

message - A log message.

severityLevel - The severity level.

properties - Named string values you can use to search and classify trace messages.

trackTrace

public void trackTrace(java.lang.String message)

Sends a TraceTelemetry record for display in Diagnostic Search.

Parameters:

message - A log message.

trackTrace

public void trackTrace(java.lang.String message,
                       SeverityLevel severityLevel)

trackTrace

public void trackTrace(TraceTelemetry telemetry)

Sends a TraceTelemetry record for display in Diagnostic Search.

Parameters:

telemetry - The Telemetry instance.

trackMetric

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

Sends a MetricTelemetry record for aggregation in Metric Explorer.

Parameters:

name - The name of the measurement

value - The value of the measurement. Average if based on more than one sample count.

sampleCount - The sample count.

min - The minimum value of the sample.

max - The maximum value of the sample.

properties - Named string values you can use to search and classify trace messages.

trackMetric

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

Sends a MetricTelemetry record for aggregation in Metric Explorer.

Parameters:

name - The name of the measurement

value - The value of the measurement.

trackMetric

public void trackMetric(MetricTelemetry telemetry)

Send a MetricTelemetry record for aggregation in Metric Explorer.

Parameters:

telemetry - The Telemetry instance.

trackException

public void trackException(java.lang.Exception exception,
                           java.util.Map<java.lang.String,java.lang.String> properties,
                           java.util.Map<java.lang.String,java.lang.Double> metrics)

Sends an ExceptionTelemetry record for display in Diagnostic Search.

Parameters:

exception - The exception to log information about.

properties - Named string values you can use to search and classify trace messages.

metrics - Measurements associated with this exception event.

trackException

public void trackException(java.lang.Exception exception)

Sends an ExceptionTelemetry record for display in Diagnostic Search.

Parameters:

exception - The exception to log information about.

trackException

public void trackException(ExceptionTelemetry telemetry)

Sends an ExceptionTelemetry record for display in Diagnostic Search.

Parameters:

telemetry - An already constructed exception telemetry record.

trackHttpRequest

public void trackHttpRequest(java.lang.String name,
                             java.util.Date timestamp,
                             long duration,
                             java.lang.String responseCode,
                             boolean success)

Sends a HttpRequestTelemetry record for display in Diagnostic Search.

Parameters:

name - A user-friendly name for the request.

timestamp - The time of the request.

duration - The duration, in milliseconds, of the request processing.

responseCode - The HTTP response code.

success - 'true' if the request was a success, 'false' otherwise.

trackHttpRequest

public void trackHttpRequest(HttpRequestTelemetry request)

trackRemoteDependency

public void trackRemoteDependency(RemoteDependencyTelemetry telemetry)

trackPageView

public void trackPageView(java.lang.String name)

trackPageView

public void trackPageView(PageViewTelemetry telemetry)

Send information about the page viewed in the application.

Parameters:

telemetry - The telemetry to send

track

public void track(Telemetry telemetry)

This method is part of the Application Insights infrastructure. Do not call it directly.

Parameters:

telemetry - The Telemetry instance.