com.microsoft.applicationinsights.telemetry

Class TelemetryContext

java.lang.Object

com.microsoft.applicationinsights.telemetry.TelemetryContext

public final class TelemetryContext
extends java.lang.Object

Represents a context for sending telemetry to the Application Insights service. The context holds data that is sent with every telemetry item. It includes the instrumentation key; the current operation id, for correlating related telemetry items; and user, session and device data. You can also set properties that are added to every telemetry item, and can be used in the portal to filter the telemetry that used this context.

Constructor Summary

Constructors

Constructor and Description
TelemetryContext() Default Ctor

Method Summary

Modifier and Type	Method and Description
ComponentContext	getComponent() Gets the object describing the component (application) tracked by this instance.
DeviceContext	getDevice() Gets the object describing the device tracked by this instance.
java.lang.String	getInstrumentationKey() Gets the default instrumentation key for all Telemetry objects logged in this TelemetryContext.
InternalContext	getInternal()
LocationContext	getLocation() Gets the object describing a location tracked by this instance.
OperationContext	getOperation() Gets the current operation (typically an HTTP request).
java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	getProperties() Gets a dictionary of application-defined property values.
SessionContext	getSession() Gets the object describing a user session tracked by this instance.
java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	getTags() Gets a dictionary of context tags.
UserContext	getUser() Gets the object describing a user tracked by this instance.
void	initialize(TelemetryContext source)
void	setInstrumentationKey(java.lang.String instrumentationKey) Sets the default instrumentation key for all Telemetry objects logged in this TelemetryContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

TelemetryContext

public TelemetryContext()

Default Ctor

Method Detail

getComponent

public ComponentContext getComponent()

Gets the object describing the component (application) tracked by this instance.

Returns:

The component.

getDevice

public DeviceContext getDevice()

Gets the object describing the device tracked by this instance.

Returns:

The device.

getSession

public SessionContext getSession()

Gets the object describing a user session tracked by this instance.

Returns:

The user's session.

getUser

public UserContext getUser()

Gets the object describing a user tracked by this instance.

Returns:

The user.

getOperation

public OperationContext getOperation()

Gets the current operation (typically an HTTP request). Used to correlate events - for example, exceptions generated while processing a request.

Returns:

The operation.

getLocation

public LocationContext getLocation()

Gets the object describing a location tracked by this instance.

Returns:

The location.

getInstrumentationKey

public java.lang.String getInstrumentationKey()

Gets the default instrumentation key for all Telemetry objects logged in this TelemetryContext. By default, this property is initialized with the InstrumentationKey value which is in TelemetryConfiguration of the 'Active' instance. You can specify it for all telemetry tracked via a particular TelemetryClient or for a specific Telemetry

Returns:

The instrumentation key

setInstrumentationKey

public void setInstrumentationKey(java.lang.String instrumentationKey)

Sets the default instrumentation key for all Telemetry objects logged in this TelemetryContext. By default, this property is initialized with the InstrumentationKey value which is in TelemetryConfiguration of the 'Active' instance. You can specify it for all telemetry tracked via a particular TelemetryClient or for a specific Telemetry

Parameters:

instrumentationKey - The instrumentation key

getProperties

public java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> getProperties()

Gets a dictionary of application-defined property values.

Returns:

The application-defined property values.

getTags

public java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> getTags()

Gets a dictionary of context tags.

Returns:

The tags.

initialize

public void initialize(TelemetryContext source)

getInternal

public InternalContext getInternal()