com.microsoft.applicationinsights.telemetry

Class BaseTelemetry<T extends Domain>

java.lang.Object

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

All Implemented Interfaces:

JsonSerializable, Telemetry

Direct Known Subclasses:

BaseSampleSourceTelemetry, MetricTelemetry, PerformanceCounterTelemetry, SessionStateTelemetry

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

Superclass for all telemetry data classes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TELEMETRY_NAME_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTelemetry()

Method Summary

Modifier and Type	Method and Description
protected abstract void	additionalSanitize() Deprecated.
java.lang.String	getBaseTypeName()
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 JsonSerializable
java.lang.String	getEnvelopName()
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.
static java.lang.String	getTelemetryName(java.lang.String normalizedInstrumentationKey, java.lang.String envelopType)
java.util.Date	getTimestamp() Gets date and time when event was recorded.
abstract int	getVer()
protected void	initialize(java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> properties) Initializes the instance with the context properties
static java.lang.String	normalizeInstrumentationKey(java.lang.String instrumentationKey)
void	reset()
void	sanitize() Deprecated. Makes sure the data to send is sanitized from bad chars, proper length etc.
void	serialize(JsonTelemetryDataSerializer writer) Serializes this object in JSON format.
protected void	setSampleRate(Envelope envelope)
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.
java.lang.String	toString() THIS IS FOR DEBUGGING AND TESTING ONLY! DON'T USE THIS IN HAPPY-PATH, PRODUCTION CODE.

Methods inherited from class java.lang.Object

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

Field Detail

TELEMETRY_NAME_PREFIX

public static final java.lang.String TELEMETRY_NAME_PREFIX

See Also:

Constant Field Values

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

getVer

public abstract int getVer()

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

@Deprecated
public void sanitize()

Deprecated. 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

toString

public java.lang.String toString()

THIS IS FOR DEBUGGING AND TESTING ONLY! DON'T USE THIS IN HAPPY-PATH, PRODUCTION CODE.

Overrides:

toString in class java.lang.Object

Returns:

Json representation of this telemetry item.

reset

public void reset()

Specified by:

reset in interface Telemetry

additionalSanitize

@Deprecated
protected abstract void additionalSanitize()

Deprecated.

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 JsonSerializable

Returns:

The inner data structure

setSampleRate

protected void setSampleRate(Envelope envelope)

getEnvelopName

public java.lang.String getEnvelopName()

getBaseTypeName

public java.lang.String getBaseTypeName()

normalizeInstrumentationKey

public static java.lang.String normalizeInstrumentationKey(java.lang.String instrumentationKey)

getTelemetryName

public static java.lang.String getTelemetryName(java.lang.String normalizedInstrumentationKey,
                                                java.lang.String envelopType)