com.microsoft.applicationinsights.telemetry

Class EventTelemetry

java.lang.Object

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

com.microsoft.applicationinsights.telemetry.BaseSampleSourceTelemetry<EventData>

com.microsoft.applicationinsights.telemetry.EventTelemetry

All Implemented Interfaces:

JsonSerializable, SupportSampling, Telemetry

public final class EventTelemetry
extends BaseSampleSourceTelemetry<EventData>

Telemetry type used to track custom events in Azure Application Insights.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_TYPE Base Type for this telemetry.
static java.lang.String	ENVELOPE_NAME Envelope Name for this telemetry.

Fields inherited from class com.microsoft.applicationinsights.telemetry.BaseTelemetry

TELEMETRY_NAME_PREFIX

Constructor Summary

Constructors

Constructor and Description
EventTelemetry() Default initialization for a new instance.
EventTelemetry(java.lang.String name) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	additionalSanitize() Deprecated. Sanitize name and metrics.
java.lang.String	getBaseTypeName()
protected EventData	getData() Fetches the data structure the instance works with
java.lang.String	getEnvelopName()
java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.Double>	getMetrics() Gets a map of application-defined event metrics.
java.lang.String	getName() Gets the name of the event.
java.lang.Double	getSamplingPercentage()
int	getVer()
void	setName(java.lang.String name) Sets the name of the event.
void	setSamplingPercentage(java.lang.Double samplingPercentage)

Methods inherited from class com.microsoft.applicationinsights.telemetry.BaseSampleSourceTelemetry

reset, setSampleRate

Methods inherited from class com.microsoft.applicationinsights.telemetry.BaseTelemetry

getContext, getProperties, getSequence, getTelemetryName, getTimestamp, initialize, normalizeInstrumentationKey, sanitize, serialize, setSequence, setTimestamp, toString

Methods inherited from class java.lang.Object

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

Field Detail

ENVELOPE_NAME

public static final java.lang.String ENVELOPE_NAME

Envelope Name for this telemetry.

See Also:

Constant Field Values

BASE_TYPE

public static final java.lang.String BASE_TYPE

Base Type for this telemetry.

See Also:

Constant Field Values

Constructor Detail

EventTelemetry

public EventTelemetry()

Default initialization for a new instance.

EventTelemetry

public EventTelemetry(java.lang.String name)

Initializes a new instance.

Parameters:

name - The event's name. Max length 150.

Method Detail

getVer

public int getVer()

Specified by:

getVer in class BaseTelemetry<EventData>

getMetrics

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

Gets a map of application-defined event metrics. These metrics appear along with the event in Search and Analytics, but appear under 'Custom Metrics' in Metrics Explorer.

Returns:

The map of metrics

getName

public java.lang.String getName()

Gets the name of the event.

Returns:

The name

setName

public void setName(java.lang.String name)

Sets the name of the event.

Parameters:

name - Name of the event. Max length 150.

additionalSanitize

@Deprecated
protected void additionalSanitize()

Deprecated. Sanitize name and metrics.

Description copied from class: BaseTelemetry

Concrete classes should implement this method

Specified by:

additionalSanitize in class BaseTelemetry<EventData>

getData

protected EventData getData()

Fetches the data structure the instance works with

Specified by:

getData in class BaseTelemetry<EventData>

Returns:

The inner data structure.

getSamplingPercentage

public java.lang.Double getSamplingPercentage()

setSamplingPercentage

public void setSamplingPercentage(java.lang.Double samplingPercentage)

getEnvelopName

public java.lang.String getEnvelopName()

Overrides:

getEnvelopName in class BaseTelemetry<EventData>

getBaseTypeName

public java.lang.String getBaseTypeName()

Overrides:

getBaseTypeName in class BaseTelemetry<EventData>