com.microsoft.applicationinsights.telemetry

Class BaseTelemetry<T extends SendableData>

java.lang.Object

com.microsoft.applicationinsights.telemetry.BaseTelemetry<T>

All Implemented Interfaces:

JsonSerializable, Telemetry

Direct Known Subclasses:

EventTelemetry, ExceptionTelemetry, HttpRequestTelemetry, MetricTelemetry, PageViewTelemetry, RemoteDependencyTelemetry, SessionStateTelemetry, TraceTelemetry

public abstract class BaseTelemetry<T extends SendableData>
extends java.lang.Object
implements Telemetry

Superclass for all telemetry data classes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTelemetry()

Method Summary

Modifier and Type	Method and Description
protected abstract void	additionalSanitize() Concrete classes should implement this method
TelemetryContext	getContext() Gets the context associated with the current telemetry item.
protected abstract T	getData() Concrete classes should implement this method which supplies the data structure that this instance works with, which needs to implement SendableData
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets a dictionary of application-defined property names and values providing additional information about this event.
java.lang.String	getSequence() Sequence field used to track absolute order of uploaded events.
java.util.Date	getTimestamp() Gets date and time when event was recorded.
protected void	initialize(java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> properties) Initializes the instance with the context properties
void	sanitize() Makes sure the data to send is sanitized from bad chars, proper length etc.
void	serialize(JsonTelemetryDataSerializer writer) Serializes this object in JSON format.
void	setSequence(java.lang.String sequence) Sets the value that defines absolute order of the telemetry item.
void	setTimestamp(java.util.Date date) Sets date and time when event was recorded.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTelemetry

protected BaseTelemetry()

Method Detail

initialize

protected void initialize(java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> properties)

Initializes the instance with the context properties

Parameters:

properties - The context properties

getSequence

public 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 value that defines absolute order of the telemetry item.

Specified by:

getSequence in interface Telemetry

Returns:

The sequence of the Telemetry.

setSequence

public void setSequence(java.lang.String sequence)

Sets the value that defines absolute order of the telemetry item.

Specified by:

setSequence in interface Telemetry

Parameters:

sequence - The sequence of the Telemetry.

getTimestamp

public java.util.Date getTimestamp()

Gets date and time when event was recorded.

Specified by:

getTimestamp in interface Telemetry

Returns:

The timestamp as Date

setTimestamp

public void setTimestamp(java.util.Date date)

Sets date and time when event was recorded.

Specified by:

setTimestamp in interface Telemetry

Parameters:

date - The timestamp as Date.

getContext

public TelemetryContext getContext()

Gets the context associated with the current telemetry item.

Specified by:

getContext in interface Telemetry

Returns:

The context

getProperties

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

Gets a dictionary of application-defined property names and values providing additional information about this event.

Specified by:

getProperties in interface Telemetry

Returns:

The properties

sanitize

public void sanitize()

Makes sure the data to send is sanitized from bad chars, proper length etc.

Specified by:

sanitize in interface Telemetry

serialize

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

Serializes this object in JSON format.

Specified by:

serialize in interface JsonSerializable

Specified by:

serialize in interface Telemetry

Parameters:

writer - The writer that helps with serializing into Json format

Throws:

java.io.IOException - The exception that might be thrown during the serialization

additionalSanitize

protected abstract void additionalSanitize()

Concrete classes should implement this method

getData

protected abstract T getData()

Concrete classes should implement this method which supplies the data structure that this instance works with, which needs to implement SendableData

Returns:

The inner data structure