com.microsoft.applicationinsights.internal.heartbeat

Interface HeartBeatProviderInterface

All Known Implementing Classes:

HeartBeatProvider

public interface HeartBeatProviderInterface

Interface for HeartBeat Properties

This interface defines an implementation for configuring the properties of Application Insights SDK. It allows users to set and get the configuration properties of HeartBeat module. A user can create or bring his own custom implementation of Heartbeat module if wished provided that he abides to the contracts set by this Interface. Default concrete Implementation HeartBeatProvider

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_HEARTBEAT_INTERVAL Default interval in seconds to transmit heartbeat pulse.
static long	MINIMUM_HEARTBEAT_INTERVAL Minimum interval which can be configured by user to transmit heartbeat pulse.

Method Summary

Modifier and Type	Method and Description
boolean	addHeartBeatProperty(java.lang.String propertyName, java.lang.String propertyValue, boolean isHealthy) Adds the heartbeat property to the heartbeat payload.
boolean	containsHeartBeatProperty(java.lang.String Key) Returns true if the HeartBeat provider has the given HeartBeat Property
java.util.List<java.lang.String>	getExcludedHeartBeatProperties() Returns the list of excluded heartbeat properties.
java.util.List<java.lang.String>	getExcludedHeartBeatPropertyProviders() This returns the list of Excluded Heart Beat Providers
long	getHeartBeatInterval() Gets the currently set heartbeat interval.
java.lang.String	getInstrumentationKey() Gets the instrumentation key used by telemetry client sending heartbeat.
void	initialize(TelemetryConfiguration configuration) This method initializes the concrete module.
boolean	isHeartBeatEnabled() Returns if heartbeat is enabled or not.
void	setExcludedHeartBeatProperties(java.util.List<java.lang.String> excludedHeartBeatProperties) Sets the list of properties to be excluded from heartbeat payload.
void	setExcludedHeartBeatPropertyProviders(java.util.List<java.lang.String> excludedHeartBeatPropertyProviders) Sets the list of excluded heartbeat providers.
void	setHeartBeatEnabled(boolean isEnabled) Enables or disables heartbeat module.
void	setHeartBeatInterval(long timeUnit) Sets the time interval of heartbeat in seconds.
boolean	setHeartBeatProperty(java.lang.String propertyName, java.lang.String propertyValue, boolean isHealthy) Sets the value of already existing heartbeat property in the payload.
void	setInstrumentationKey(java.lang.String key) Sets the instrumentation key

Field Detail

DEFAULT_HEARTBEAT_INTERVAL

static final long DEFAULT_HEARTBEAT_INTERVAL

Default interval in seconds to transmit heartbeat pulse.

MINIMUM_HEARTBEAT_INTERVAL

static final long MINIMUM_HEARTBEAT_INTERVAL

Minimum interval which can be configured by user to transmit heartbeat pulse.

Method Detail

getInstrumentationKey

java.lang.String getInstrumentationKey()

Gets the instrumentation key used by telemetry client sending heartbeat.

Returns:

InstrumentationKey

setInstrumentationKey

void setInstrumentationKey(java.lang.String key)

Sets the instrumentation key

Parameters:

key - Key to be set

initialize

void initialize(TelemetryConfiguration configuration)

This method initializes the concrete module.

Parameters:

configuration - TelemetryConfiguration

addHeartBeatProperty

boolean addHeartBeatProperty(java.lang.String propertyName,
                             java.lang.String propertyValue,
                             boolean isHealthy)

Adds the heartbeat property to the heartbeat payload.

Parameters:

propertyName - Name of the property to be added in Heartbeat payload

propertyValue - Value of the property to be added in Heartbeat payload

isHealthy - indicates if heartbeat is healthy

Returns:

true if property is added successfully

setHeartBeatProperty

boolean setHeartBeatProperty(java.lang.String propertyName,
                             java.lang.String propertyValue,
                             boolean isHealthy)

Sets the value of already existing heartbeat property in the payload.

Parameters:

propertyName - Name of the property to be added in Heartbeat payload

propertyValue - Value of the property to be added in Heartbeat payload

isHealthy - indicates if heartbeat is healthy

Returns:

true if property is added successfully

isHeartBeatEnabled

boolean isHeartBeatEnabled()

Returns if heartbeat is enabled or not.

Returns:

true if heartbeat is enabled

setHeartBeatEnabled

void setHeartBeatEnabled(boolean isEnabled)

Enables or disables heartbeat module.

Parameters:

isEnabled - state of the heartbeat (enabled/disabled)

getExcludedHeartBeatPropertyProviders

java.util.List<java.lang.String> getExcludedHeartBeatPropertyProviders()

This returns the list of Excluded Heart Beat Providers

Returns:

list of excluded heartbeat providers

setExcludedHeartBeatPropertyProviders

void setExcludedHeartBeatPropertyProviders(java.util.List<java.lang.String> excludedHeartBeatPropertyProviders)

Sets the list of excluded heartbeat providers.

Parameters:

excludedHeartBeatPropertyProviders - List of heartbeat providers to be excluded

getHeartBeatInterval

long getHeartBeatInterval()

Gets the currently set heartbeat interval.

Returns:

returns the time interval of heartbeat

setHeartBeatInterval

void setHeartBeatInterval(long timeUnit)

Sets the time interval of heartbeat in seconds.

Parameters:

timeUnit - Heartbeat interval in seconds

getExcludedHeartBeatProperties

java.util.List<java.lang.String> getExcludedHeartBeatProperties()

Returns the list of excluded heartbeat properties.

Returns:

List of excluded heartbeat properties

setExcludedHeartBeatProperties

void setExcludedHeartBeatProperties(java.util.List<java.lang.String> excludedHeartBeatProperties)

Sets the list of properties to be excluded from heartbeat payload.

Parameters:

excludedHeartBeatProperties - List of properties to be excluded

containsHeartBeatProperty

boolean containsHeartBeatProperty(java.lang.String Key)

Returns true if the HeartBeat provider has the given HeartBeat Property

Parameters:

Key -

Returns: