com.microsoft.applicationinsights.channel.concrete

Class TelemetryChannelBase<T>

java.lang.Object

com.microsoft.applicationinsights.channel.concrete.TelemetryChannelBase<T>

Type Parameters:

T - The type of the telemetry being stored in the buffer.

All Implemented Interfaces:

TelemetryChannel

Direct Known Subclasses:

InProcessTelemetryChannel

public abstract class TelemetryChannelBase<T>
extends java.lang.Object
implements TelemetryChannel

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FLUSH_BUFFER_TIMEOUT_IN_SECONDS
static int	DEFAULT_MAX_INSTANT_RETRY
static int	DEFAULT_MAX_TELEMETRY_BUFFER_CAPACITY
static java.lang.String	DEVELOPER_MODE_NAME
static java.lang.String	DEVELOPER_MODE_SYSTEM_PROPRETY_NAME
static java.lang.String	ENDPOINT_ADDRESS_NAME
static java.lang.String	FLUSH_BUFFER_TIMEOUT_IN_SECONDS_NAME
static java.lang.String	INSTANT_RETRY_NAME
protected boolean	isInitailized
static int	LOG_TELEMETRY_ITEMS_MODULUS
static int	MAX_FLUSH_BUFFER_TIMEOUT_IN_SECONDS
static int	MAX_MAX_TELEMETRY_BUFFER_CAPACITY
static java.lang.String	MAX_TELEMETRY_BUFFER_CAPACITY_NAME
static java.lang.String	MAX_TRANSMISSION_STORAGE_CAPACITY_NAME
static int	MIN_FLUSH_BUFFER_TIMEOUT_IN_SECONDS
static int	MIN_MAX_TELEMETRY_BUFFER_CAPACITY
protected boolean	stopped
protected TelemetriesTransmitter<T>	telemetriesTransmitter
protected TelemetryBuffer<T>	telemetryBuffer
protected TelemetrySampler	telemetrySampler
static java.lang.String	THROTTLING_ENABLED_NAME

Constructor Summary

Constructors

Constructor and Description
TelemetryChannelBase() Deprecated. Use TelemetryChannelBase(TelemetryConfiguration)
TelemetryChannelBase(java.util.Map<java.lang.String,java.lang.String> namesAndValues) Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, Map).
TelemetryChannelBase(java.lang.String endpointAddress, boolean developerMode, int maxTelemetryBufferCapacity, int sendIntervalInMillis) Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, String, boolean, int, int, boolean, int). Use TelemetryConfiguration.setConnectionString(String) to set ingestion endpoint, if needed.
TelemetryChannelBase(java.lang.String endpointAddress, java.lang.String maxTransmissionStorageCapacity, boolean developerMode, int maxTelemetryBufferCapacity, int sendIntervalInMillis, boolean throttling, int maxInstantRetries) Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, String, boolean, int, int, boolean, int). Use TelemetryConfiguration.setConnectionString(String) to set ingestion endpoint, if needed.
TelemetryChannelBase(TelemetryConfiguration configuration)
TelemetryChannelBase(TelemetryConfiguration configuration, java.util.Map<java.lang.String,java.lang.String> namesAndValues)
TelemetryChannelBase(TelemetryConfiguration configuration, java.lang.String maxTransmissionStorageCapacity, boolean developerMode, int maxTelemetryBufferCapacity, int sendIntervalInMillis, boolean throttling, int maxInstantRetries)

Method Summary

Modifier and Type	Method and Description
protected LimitsEnforcer	createDefaultMaxTelemetryBufferCapacityEnforcer(java.lang.Integer currentValue)
protected LimitsEnforcer	createDefaultSendIntervalInSecondsEnforcer(java.lang.Integer currentValue)
protected abstract TransmitterFactory<T>	createTransmitterFactory()
protected abstract boolean	doSend(Telemetry telemetry)
void	flush() Flushes the data that the channel might have internally.
protected TransmitterFactory<T>	getTransmitterFactory()
protected void	initialize(java.lang.String endpointAddress, java.lang.String maxTransmissionStorageCapacity, boolean developerMode, LimitsEnforcer maxTelemetryBufferCapacityEnforcer, LimitsEnforcer sendIntervalInSeconds, boolean throttling, int maxInstantRetry) Deprecated. Use initialize(TelemetryConfiguration, String, String, boolean, LimitsEnforcer, LimitsEnforcer, boolean, int)
protected void	initialize(TelemetryConfiguration configuration, java.lang.String endpointAddress, java.lang.String maxTransmissionStorageCapacity, boolean developerMode, LimitsEnforcer maxTelemetryBufferCapacityEnforcer, LimitsEnforcer sendIntervalInSeconds, boolean throttling, int maxInstantRetry)
boolean	isDeveloperMode() Gets value indicating whether this channel is in developer mode.
protected void	makeSureEndpointAddressIsValid(java.lang.String endpointAddress) The method will throw IllegalArgumentException if the endpointAddress is not a valid URI.
void	send(Telemetry telemetry) Sends a Telemetry instance through the channel.
void	setDeveloperMode(boolean developerMode) Sets value indicating whether this channel is in developer mode.
void	setMaxTelemetriesInBatch(int maxTelemetriesInBatch) Sets the buffer size
void	setSampler(TelemetrySampler telemetrySampler) Sets an optional Sampler that can sample out telemetries Currently, we don't allow to replace a valid telemtry sampler.
void	setTransmitBufferTimeoutInSeconds(int transmitBufferTimeoutInSeconds) Sets the time tow wait before flushing the internal buffer
void	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Stops on going work

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_INSTANT_RETRY

public static final int DEFAULT_MAX_INSTANT_RETRY

See Also:

Constant Field Values

DEFAULT_MAX_TELEMETRY_BUFFER_CAPACITY

public static final int DEFAULT_MAX_TELEMETRY_BUFFER_CAPACITY

See Also:

Constant Field Values

DEFAULT_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

public static final int DEFAULT_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

MIN_MAX_TELEMETRY_BUFFER_CAPACITY

public static final int MIN_MAX_TELEMETRY_BUFFER_CAPACITY

See Also:

Constant Field Values

MAX_MAX_TELEMETRY_BUFFER_CAPACITY

public static final int MAX_MAX_TELEMETRY_BUFFER_CAPACITY

See Also:

Constant Field Values

MIN_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

public static final int MIN_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

MAX_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

public static final int MAX_FLUSH_BUFFER_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

DEVELOPER_MODE_SYSTEM_PROPRETY_NAME

public static final java.lang.String DEVELOPER_MODE_SYSTEM_PROPRETY_NAME

See Also:

Constant Field Values

MAX_TELEMETRY_BUFFER_CAPACITY_NAME

public static final java.lang.String MAX_TELEMETRY_BUFFER_CAPACITY_NAME

See Also:

Constant Field Values

INSTANT_RETRY_NAME

public static final java.lang.String INSTANT_RETRY_NAME

See Also:

Constant Field Values

FLUSH_BUFFER_TIMEOUT_IN_SECONDS_NAME

public static final java.lang.String FLUSH_BUFFER_TIMEOUT_IN_SECONDS_NAME

See Also:

Constant Field Values

DEVELOPER_MODE_NAME

public static final java.lang.String DEVELOPER_MODE_NAME

See Also:

Constant Field Values

ENDPOINT_ADDRESS_NAME

public static final java.lang.String ENDPOINT_ADDRESS_NAME

See Also:

Constant Field Values

MAX_TRANSMISSION_STORAGE_CAPACITY_NAME

public static final java.lang.String MAX_TRANSMISSION_STORAGE_CAPACITY_NAME

See Also:

Constant Field Values

LOG_TELEMETRY_ITEMS_MODULUS

public static final int LOG_TELEMETRY_ITEMS_MODULUS

See Also:

Constant Field Values

THROTTLING_ENABLED_NAME

public static final java.lang.String THROTTLING_ENABLED_NAME

See Also:

Constant Field Values

stopped

protected boolean stopped

isInitailized

protected boolean isInitailized

telemetriesTransmitter

protected TelemetriesTransmitter<T> telemetriesTransmitter

telemetrySampler

protected volatile TelemetrySampler telemetrySampler

telemetryBuffer

protected TelemetryBuffer<T> telemetryBuffer

Constructor Detail

TelemetryChannelBase

public TelemetryChannelBase(TelemetryConfiguration configuration)

TelemetryChannelBase

public TelemetryChannelBase(TelemetryConfiguration configuration,
                            java.lang.String maxTransmissionStorageCapacity,
                            boolean developerMode,
                            int maxTelemetryBufferCapacity,
                            int sendIntervalInMillis,
                            boolean throttling,
                            int maxInstantRetries)

Parameters:

configuration - The telemetry configuration to use for finding endpoints.

maxTransmissionStorageCapacity - This limits the size of the saved telemetry files which encountered an error during sending.

developerMode - 'non-production' mode for easier debugging. This forces maxTelemetryBufferCapacity=1 and when logger is enabled, it prints serialized telemetry to log.

maxTelemetryBufferCapacity - Max number of Telemetries we keep in the buffer, when reached we will send the buffer Note, value should be between TRANSMIT_BUFFER_MIN_TIMEOUT_IN_MILLIS and TRANSMIT_BUFFER_MAX_TIMEOUT_IN_MILLIS, inclusive

sendIntervalInMillis - The maximum number of milliseconds to wait before we send the buffer Note, value should be between MIN_MAX_TELEMETRY_BUFFER_CAPACITY and MAX_MAX_TELEMETRY_BUFFER_CAPACITY, inclusive

throttling - enables throttling when true

maxInstantRetries - number of retries before starting incremental back-off.

TelemetryChannelBase

@Deprecated
public TelemetryChannelBase()

Deprecated. Use TelemetryChannelBase(TelemetryConfiguration)

TelemetryChannelBase

@Deprecated
public TelemetryChannelBase(java.lang.String endpointAddress,
                                         boolean developerMode,
                                         int maxTelemetryBufferCapacity,
                                         int sendIntervalInMillis)

Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, String, boolean, int, int, boolean, int). Use TelemetryConfiguration.setConnectionString(String) to set ingestion endpoint, if needed.

TelemetryChannelBase

@Deprecated
public TelemetryChannelBase(java.lang.String endpointAddress,
                                         java.lang.String maxTransmissionStorageCapacity,
                                         boolean developerMode,
                                         int maxTelemetryBufferCapacity,
                                         int sendIntervalInMillis,
                                         boolean throttling,
                                         int maxInstantRetries)

Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, String, boolean, int, int, boolean, int). Use TelemetryConfiguration.setConnectionString(String) to set ingestion endpoint, if needed.

TelemetryChannelBase

@Deprecated
public TelemetryChannelBase(java.util.Map<java.lang.String,java.lang.String> namesAndValues)

Deprecated. Use TelemetryChannelBase(TelemetryConfiguration, Map).

TelemetryChannelBase

public TelemetryChannelBase(TelemetryConfiguration configuration,
                            java.util.Map<java.lang.String,java.lang.String> namesAndValues)

Parameters:

configuration - The configuration for the current TelemetryClient

namesAndValues - Key/Value pairs for channel configuration options

Method Detail

initialize

@Deprecated
protected void initialize(java.lang.String endpointAddress,
                                       java.lang.String maxTransmissionStorageCapacity,
                                       boolean developerMode,
                                       LimitsEnforcer maxTelemetryBufferCapacityEnforcer,
                                       LimitsEnforcer sendIntervalInSeconds,
                                       boolean throttling,
                                       int maxInstantRetry)

Deprecated. Use initialize(TelemetryConfiguration, String, String, boolean, LimitsEnforcer, LimitsEnforcer, boolean, int)

initialize

protected void initialize(TelemetryConfiguration configuration,
                          java.lang.String endpointAddress,
                          java.lang.String maxTransmissionStorageCapacity,
                          boolean developerMode,
                          LimitsEnforcer maxTelemetryBufferCapacityEnforcer,
                          LimitsEnforcer sendIntervalInSeconds,
                          boolean throttling,
                          int maxInstantRetry)

getTransmitterFactory

protected TransmitterFactory<T> getTransmitterFactory()

isDeveloperMode

public boolean isDeveloperMode()

Gets value indicating whether this channel is in developer mode.

Specified by:

isDeveloperMode in interface TelemetryChannel

Returns:

The developer mode.

setDeveloperMode

public void setDeveloperMode(boolean developerMode)

Sets value indicating whether this channel is in developer mode. If true, this also forces maxTelemetriesInBatch to be 1 (affects TelemetryBuffer).

Specified by:

setDeveloperMode in interface TelemetryChannel

Parameters:

developerMode - true or false

stop

public void stop(long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

Stops on going work

Specified by:

stop in interface TelemetryChannel

Parameters:

timeout - Time to try and stop

timeUnit - The units of the 'timeout' parameter

setTransmitBufferTimeoutInSeconds

public void setTransmitBufferTimeoutInSeconds(int transmitBufferTimeoutInSeconds)

Sets the time tow wait before flushing the internal buffer

Parameters:

transmitBufferTimeoutInSeconds - should be between MIN_FLUSH_BUFFER_TIMEOUT_IN_SECONDS and MAX_FLUSH_BUFFER_TIMEOUT_IN_SECONDS inclusive if the number is lower than the minimum then the minimum will be used if the number is higher than the maximum then the maximum will be used

setMaxTelemetriesInBatch

public void setMaxTelemetriesInBatch(int maxTelemetriesInBatch)

Sets the buffer size

Parameters:

maxTelemetriesInBatch - should be between MIN_MAX_TELEMETRY_BUFFER_CAPACITY and MAX_MAX_TELEMETRY_BUFFER_CAPACITY inclusive if the number is lower than the minimum then the minimum will be used if the number is higher than the maximum then the maximum will be used

flush

public void flush()

Flushes the data that the channel might have internally.

Specified by:

flush in interface TelemetryChannel

setSampler

public void setSampler(TelemetrySampler telemetrySampler)

Sets an optional Sampler that can sample out telemetries Currently, we don't allow to replace a valid telemtry sampler.

Specified by:

setSampler in interface TelemetryChannel

Parameters:

telemetrySampler - - The sampler

send

public void send(Telemetry telemetry)

Sends a Telemetry instance through the channel.

Specified by:

send in interface TelemetryChannel

Parameters:

telemetry - The Telemetry item to send.

doSend

protected abstract boolean doSend(Telemetry telemetry)

Parameters:

telemetry -

Returns:

true, if the send was successful, false if there was an error

createTransmitterFactory

protected abstract TransmitterFactory<T> createTransmitterFactory()

createDefaultMaxTelemetryBufferCapacityEnforcer

protected LimitsEnforcer createDefaultMaxTelemetryBufferCapacityEnforcer(java.lang.Integer currentValue)

createDefaultSendIntervalInSecondsEnforcer

protected LimitsEnforcer createDefaultSendIntervalInSecondsEnforcer(java.lang.Integer currentValue)

makeSureEndpointAddressIsValid

protected void makeSureEndpointAddressIsValid(java.lang.String endpointAddress)

The method will throw IllegalArgumentException if the endpointAddress is not a valid URI. Please note that a null or empty string is valid as far as the class is concerned and thus considered valid

Parameters:

endpointAddress -

Throws:

java.lang.IllegalArgumentException - if the endpointAddress is invalid