com.microsoft.applicationinsights.internal.heartbeat

Class HeartBeatModule

java.lang.Object

com.microsoft.applicationinsights.internal.heartbeat.HeartBeatModule

All Implemented Interfaces:

TelemetryModule

public class HeartBeatModule
extends java.lang.Object
implements TelemetryModule

HeartBeat Provider Module

This module is the core module which is is configured by default with default settings when ApplicationInsights SDK boots up. It is used to transmit diagnostic heartbeats to Application Insights backend.

Constructor Summary

Constructors

Constructor and Description
HeartBeatModule() Default constructor to initialize the default heartbeat configuration.
HeartBeatModule(java.util.Map<java.lang.String,java.lang.String> properties) Initializes the heartbeat configuration based on connfiguration properties specified in ApplicationInsights.xml file.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getExcludedHeartBeatProperties() Returns list of excluded heartbeat properties from payload
java.util.List<java.lang.String>	getExcludedHeartBeatPropertiesProvider() Gets list of excluded heartbeat properties provider.
long	getHeartBeatInterval() Returns the heartbeat interval in seconds.
void	initialize(TelemetryConfiguration configuration) Initializes the telemetry module.
boolean	isHeartBeatEnabled() Gets the current state of heartbeat
void	setExcludedHeartBeatProperties(java.util.List<java.lang.String> excludedHeartBeatProperties) Sets the list of excluded heartbeat properties
void	setExcludedHeartBeatPropertiesProvider(java.util.List<java.lang.String> excludedHeartBeatPropertiesProvider) Sets list of excluded heartbeat properties provider.
void	setHeartBeatEnabled(boolean heartBeatEnabled) Sets the state of heartbeat module
void	setHeartBeatInterval(long heartBeatInterval) Sets the heartbeat interval in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartBeatModule

public HeartBeatModule()

Default constructor to initialize the default heartbeat configuration.

HeartBeatModule

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

Initializes the heartbeat configuration based on connfiguration properties specified in ApplicationInsights.xml file.

Parameters:

properties - Map of properties

Method Detail

getHeartBeatInterval

public long getHeartBeatInterval()

Returns the heartbeat interval in seconds.

Returns:

heartbeat interval in seconds.

setHeartBeatInterval

public void setHeartBeatInterval(long heartBeatInterval)

Sets the heartbeat interval in seconds.

Parameters:

heartBeatInterval - Heartbeat interval to set in seconds.

getExcludedHeartBeatProperties

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

Returns list of excluded heartbeat properties from payload

Returns:

list of excluded heartbeat properties.

setExcludedHeartBeatProperties

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

Sets the list of excluded heartbeat properties

Parameters:

excludedHeartBeatProperties - List of heartbeat properties to exclude

getExcludedHeartBeatPropertiesProvider

public java.util.List<java.lang.String> getExcludedHeartBeatPropertiesProvider()

Gets list of excluded heartbeat properties provider.

Returns:

list of excluded heartbeat properties provider.

setExcludedHeartBeatPropertiesProvider

public void setExcludedHeartBeatPropertiesProvider(java.util.List<java.lang.String> excludedHeartBeatPropertiesProvider)

Sets list of excluded heartbeat properties provider.

Parameters:

excludedHeartBeatPropertiesProvider - list of excluded heartbeat properties provider to be excluded.

isHeartBeatEnabled

public boolean isHeartBeatEnabled()

Gets the current state of heartbeat

Returns:

true if enabled

setHeartBeatEnabled

public void setHeartBeatEnabled(boolean heartBeatEnabled)

Sets the state of heartbeat module

Parameters:

heartBeatEnabled - boolean true / false

initialize

public void initialize(TelemetryConfiguration configuration)

Description copied from interface: TelemetryModule

Initializes the telemetry module.

Specified by:

initialize in interface TelemetryModule

Parameters:

configuration - The configuration to used to initialize the module.