com.microsoft.applicationinsights.telemetry

Interface Telemetry

All Superinterfaces:

JsonSerializable

All Known Implementing Classes:

BaseSampleSourceTelemetry, BaseTelemetry, EventTelemetry, ExceptionTelemetry, MetricTelemetry, PageViewTelemetry, PerformanceCounterTelemetry, RemoteDependencyTelemetry, RequestTelemetry, SessionStateTelemetry, TraceTelemetry

public interface Telemetry
extends JsonSerializable

The base telemetry type interface for application insights.

Method Summary

Modifier and Type	Method and Description
TelemetryContext	getContext() Gets the context associated with this telemetry instance.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets the map of application-defined property names and values.
java.lang.String	getSequence() Sequence field used to track absolute order of uploaded events.
java.util.Date	getTimestamp() Gets the time when telemetry was recorded
void	reset()
void	sanitize() Deprecated. Sanitizes the properties of the telemetry item based on DP constraints.
void	serialize(JsonTelemetryDataSerializer writer) Serializes itself to Json using the JsonTelemetryDataSerializer
void	setSequence(java.lang.String sequence) Sets the sequence.
void	setTimestamp(java.util.Date date) Sets the time when telemetry was recorded

Method Detail

getTimestamp

java.util.Date getTimestamp()

Gets the time when telemetry was recorded

Returns:

Recorded time.

getSequence

java.lang.String getSequence()

Sequence field used to track absolute order of uploaded events. It is a two-part value that includes a stable identifier for the current boot session and an incrementing identifier for each event added to the upload queue The Sequence helps track how many events were fired and how many events were uploaded and enables identification of data lost during upload and de-duplication of events on the ingress server. Gets the current sequence.

Returns:

The current sequence.

setSequence

void setSequence(java.lang.String sequence)

Sets the sequence.

Parameters:

sequence - The sequence.

setTimestamp

void setTimestamp(java.util.Date date)

Sets the time when telemetry was recorded

Parameters:

date - Recorded time.

getContext

TelemetryContext getContext()

Gets the context associated with this telemetry instance.

Returns:

Context associated with this instance.

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Gets the map of application-defined property names and values.

Returns:

Map of properties.

sanitize

@Deprecated
void sanitize()

Deprecated. Sanitizes the properties of the telemetry item based on DP constraints.

serialize

void serialize(JsonTelemetryDataSerializer writer)
        throws java.io.IOException

Serializes itself to Json using the JsonTelemetryDataSerializer

Specified by:

serialize in interface JsonSerializable

Parameters:

writer - The writer that helps with serializing into Json format

Throws:

java.io.IOException - a possible exception

reset

void reset()