Package com.atlassian.bamboo.beehive

Class BambooClusterNodeHeartbeatServiceImpl

java.lang.Object

com.atlassian.bamboo.beehive.BambooClusterNodeHeartbeatServiceImpl

All Implemented Interfaces:

BambooClusterNodeHeartbeatService

public class BambooClusterNodeHeartbeatServiceImpl
extends Object
implements BambooClusterNodeHeartbeatService

Field Summary

Fields

Modifier and Type	Field	Description
static final long	CLUSTER_HEARTBEAT_ALIVE_TIMEOUT_IN_MILLIS

Constructor Summary

Constructors

Constructor	Description
BambooClusterNodeHeartbeatServiceImpl(@NotNull ClusterNodeHeartbeatDao clusterNodeHeartbeatDao, @NotNull BambooClusterLockDao bambooClusterLockDao, @NotNull NodeLifeStateService nodeLifeStateService, @NotNull AutowiringJobFactory bootstrapJobFactory)

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<String>	findLiveNodes()	Returns all nodes IDs that have sent a heartbeat within the default threshold time.
@NotNull Collection<String>	findLiveNodes(long thresholdInMillis)	Returns all nodes that have sent a heartbeat within the given threshold.
@NotNull Collection<BambooNodeStatus>	findLiveNodesStatuses()	Returns all nodes objects that have sent a heartbeat within the default threshold time.
@NotNull io.atlassian.fugue.Either<Exception,List<BambooNodeInfo>>	getAllNodesInfo()	Get info of all nodes (dead and alive).
Optional<String>	getClusterPrimaryNodeId()	Retrieves the node ID of the current primary node in the cluster, if available.
@Nullable Long	getLastHeartbeatTime(@NotNull String nodeId)	Returns the last time a heartbeat was sent by the given node.
int	getLiveNodeCount()	Gets a number of live nodes in the cluster.
@NotNull String	getNodeId()	Returns the node ID for this node.
@NotNull String	getNodeName()
@NotNull List<BambooNodeStatus>	getNodeStatuses()	Get status of all nodes if DC license applied otherwise empty list.
boolean	isCurrentNodePrimaryBuffered()
boolean	isNodeHeartbeatStarted()
boolean	isNodeLive()	Checks whether the current cluster node is considered "live".
boolean	isNodeLive(@NotNull String nodeId)	Checks whether the given cluster node is considered "live".
boolean	performHeartbeatAction()	Performs the heartbeat action for the current node and refreshes live nodes.
void	refreshLiveNodes()	Refreshes the list of live nodes.
void	removeNode(@NotNull String nodeId)	Remove node by the given id.
void	renouncePrimaryRole(boolean panicMode)	Renounce primary role.
void	setCurrentNodePrimary(boolean isPrimary)	Set current node's primary flag.
void	shutdown()	Stop the heartbeat scheduler service.
void	startNodeHeartbeat()	Starts registering heartbeats for the current node.

Methods inherited from class java.lang.Object

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

Field Details

CLUSTER_HEARTBEAT_ALIVE_TIMEOUT_IN_MILLIS

public static final long CLUSTER_HEARTBEAT_ALIVE_TIMEOUT_IN_MILLIS

Constructor Details

BambooClusterNodeHeartbeatServiceImpl

@Inject
public BambooClusterNodeHeartbeatServiceImpl(@NotNull
 @NotNull ClusterNodeHeartbeatDao clusterNodeHeartbeatDao,
 @NotNull
 @NotNull BambooClusterLockDao bambooClusterLockDao,
 @NotNull
 @NotNull NodeLifeStateService nodeLifeStateService,
 @NotNull
 @NotNull AutowiringJobFactory bootstrapJobFactory)
                                      throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

Method Details

startNodeHeartbeat

public void startNodeHeartbeat()
                        throws Exception

Description copied from interface: BambooClusterNodeHeartbeatService

Starts registering heartbeats for the current node. The first heartbeat is synchronous and will be performed before this method returns. In case of initial heartbeat failure, the method will kill the current node.

Specified by:

startNodeHeartbeat in interface BambooClusterNodeHeartbeatService

Throws:

Exception

getNodeId

@NotNull
public @NotNull String getNodeId()

Description copied from interface: BambooClusterNodeHeartbeatService

Returns the node ID for this node.

Specified by:

getNodeId in interface BambooClusterNodeHeartbeatService

Returns:

the node ID for this node.

getNodeName

@NotNull
public @NotNull String getNodeName()

Specified by:

getNodeName in interface BambooClusterNodeHeartbeatService

Returns:

the node name for this node.

isNodeLive

public boolean isNodeLive(@NotNull
 @NotNull String nodeId)

Description copied from interface: BambooClusterNodeHeartbeatService

Checks whether the given cluster node is considered "live".

Each live node will be writing a heartbeat on a set schedule (eg once a minute). A node is considered live if it has written a heartbeat within a reasonable tolerance level (eg 5 minutes).

The tolerance level needs to be large enough to avoid certain expected slow-downs in the system including GC pauses, or just general slowness in the JVM / scheduler / network / database of the remote node.

This method is database sensitive and will return false if the database operations could not be performed.

Specified by:

isNodeLive in interface BambooClusterNodeHeartbeatService

Parameters:

nodeId - the cluster node to check

Returns:

true iff the given cluster node is still "live".

isNodeLive

public boolean isNodeLive()

Description copied from interface: BambooClusterNodeHeartbeatService

Checks whether the current cluster node is considered "live".

Each live node will be writing a heartbeat on a set schedule (eg once a minute). A node is considered live if it has written a heartbeat within a reasonable tolerance level (eg 5 minutes).

The tolerance level needs to be large enough to avoid certain expected slow-downs in the system including GC pauses, or just general slowness in the JVM / scheduler / network / database of the remote node.

This method is NOT database sensitive and the returned value will be evaluated properly, even without a database connection.

Specified by:

isNodeLive in interface BambooClusterNodeHeartbeatService

Returns:

true iff the given cluster node is still "live".

getLastHeartbeatTime

@Nullable
public @Nullable Long getLastHeartbeatTime(@NotNull
 @NotNull String nodeId)

Description copied from interface: BambooClusterNodeHeartbeatService

Returns the last time a heartbeat was sent by the given node.

A null value indicates no heartbeats have ever been sent by the given node.

Specified by:

getLastHeartbeatTime in interface BambooClusterNodeHeartbeatService

Parameters:

nodeId - the node

Returns:

the last time a heartbeat was sent by the given node.

findLiveNodes

@NotNull
public @NotNull Collection<String> findLiveNodes()

Description copied from interface: BambooClusterNodeHeartbeatService

Returns all nodes IDs that have sent a heartbeat within the default threshold time.

Specified by:

findLiveNodes in interface BambooClusterNodeHeartbeatService

Returns:

all nodes IDs that have sent a heartbeat within the default threshold time.

findLiveNodes

@NotNull
public @NotNull Collection<String> findLiveNodes(long thresholdInMillis)

Description copied from interface: BambooClusterNodeHeartbeatService

Returns all nodes that have sent a heartbeat within the given threshold.

Specified by:

findLiveNodes in interface BambooClusterNodeHeartbeatService

Parameters:

thresholdInMillis - the threshold in milliseconds

Returns:

all nodes IDs that have sent a heartbeat within the given threshold.

findLiveNodesStatuses

@NotNull
public @NotNull Collection<BambooNodeStatus> findLiveNodesStatuses()

Description copied from interface: BambooClusterNodeHeartbeatService

Returns all nodes objects that have sent a heartbeat within the default threshold time. The returned nodes are buffered and may not be up to date. Use BambooClusterNodeHeartbeatService.refreshLiveNodes() to perform an update.

Specified by:

findLiveNodesStatuses in interface BambooClusterNodeHeartbeatService

Returns:

collection of nodes

isNodeHeartbeatStarted

public boolean isNodeHeartbeatStarted()

Specified by:

isNodeHeartbeatStarted in interface BambooClusterNodeHeartbeatService

Returns:

true if node heartbeat has been started for the current node

renouncePrimaryRole

public void renouncePrimaryRole(boolean panicMode)

Description copied from interface: BambooClusterNodeHeartbeatService

Renounce primary role.

Specified by:

renouncePrimaryRole in interface BambooClusterNodeHeartbeatService

Parameters:

panicMode - indicates that this node is (supposedly) the primary but encountered irrecoverable error.

setCurrentNodePrimary

public void setCurrentNodePrimary(boolean isPrimary)

Description copied from interface: BambooClusterNodeHeartbeatService

Set current node's primary flag. Executed when the current node loses primary lock.

Specified by:

setCurrentNodePrimary in interface BambooClusterNodeHeartbeatService

isCurrentNodePrimaryBuffered

public boolean isCurrentNodePrimaryBuffered()

Specified by:

isCurrentNodePrimaryBuffered in interface BambooClusterNodeHeartbeatService

Returns:

true if current node has been recently (i.e. within timeout) successfully marked as alive.

getAllNodesInfo

@NotNull
public @NotNull io.atlassian.fugue.Either<Exception,List<BambooNodeInfo>> getAllNodesInfo()

Description copied from interface: BambooClusterNodeHeartbeatService

Get info of all nodes (dead and alive).

Specified by:

getAllNodesInfo in interface BambooClusterNodeHeartbeatService

Returns:

either list of nodes info or exception if something went wrong

getNodeStatuses

@NotNull
public @NotNull List<BambooNodeStatus> getNodeStatuses()

Description copied from interface: BambooClusterNodeHeartbeatService

Get status of all nodes if DC license applied otherwise empty list.

Specified by:

getNodeStatuses in interface BambooClusterNodeHeartbeatService

refreshLiveNodes

public void refreshLiveNodes()

Description copied from interface: BambooClusterNodeHeartbeatService

Refreshes the list of live nodes. Takes the information from the heartbeat table and give accurate information of which nodes are alive.

Specified by:

refreshLiveNodes in interface BambooClusterNodeHeartbeatService

performHeartbeatAction

public boolean performHeartbeatAction()

Description copied from interface: BambooClusterNodeHeartbeatService

Performs the heartbeat action for the current node and refreshes live nodes.

Specified by:

performHeartbeatAction in interface BambooClusterNodeHeartbeatService

Returns:

true if the action was successful, false otherwise

shutdown

public void shutdown()

Description copied from interface: BambooClusterNodeHeartbeatService

Stop the heartbeat scheduler service.

Specified by:

shutdown in interface BambooClusterNodeHeartbeatService

removeNode

public void removeNode(@NotNull
 @NotNull String nodeId)

Description copied from interface: BambooClusterNodeHeartbeatService

Remove node by the given id.

Specified by:

removeNode in interface BambooClusterNodeHeartbeatService

getLiveNodeCount

public int getLiveNodeCount()

Description copied from interface: BambooClusterNodeHeartbeatService

Gets a number of live nodes in the cluster.

Specified by:

getLiveNodeCount in interface BambooClusterNodeHeartbeatService

Returns:

number of live nodes

getClusterPrimaryNodeId

public Optional<String> getClusterPrimaryNodeId()

Description copied from interface: BambooClusterNodeHeartbeatService

Retrieves the node ID of the current primary node in the cluster, if available.

This method returns an Optional containing the node ID of the primary node if it is known, or an empty Optional if the primary node ID cannot be determined.

Specified by:

getClusterPrimaryNodeId in interface BambooClusterNodeHeartbeatService

Returns:

an Optional containing the node ID of the primary node, or an empty Optional if not available.