flux.audittrail.status

Interface Heartbeat

All Superinterfaces:

AbstractAuditTrailEvent

All Known Subinterfaces:

EngineDatabaseCommandsFailing, EngineMainBlocked, EngineMainStopped, ErrorCondition, Ok

public interface Heartbeat
extends AbstractAuditTrailEvent

This abstract heartbeat event contains general diagnostic information about the health of the Flux engine instance that generated it. This event is generated according to the frequency specified in the HEARTBEAT_FREQUENCY engine configuration property. However, some heartbeat events are generated as soon as they occur. In particular, the EngineDatabaseCommandsFailing heartbeart event is generated and delivered as soon as it occurs.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
long	getFreeMemory() Returns the free memory available in the Java Virtual Machine (JVM).
int	getLocallyRunningFlowChartCount() Returns the number of flow charts currently executing within this Flux engine.
int	getMaximumDatabaseConnections() Returns the maximum number of database connections that this Flux engine is configured to use.
int	getOccupiedDatabaseConnectionCount() Returns the actual number of database connections that this Flux engine is currently using.
long	getTotalMemory() Returns the total memory available in the Java Virtual Machine (JVM).
boolean	isErrorCondition() Indicates whether this heartbeat event constitutes an error condition, which indicates that a severe failure in the Flux engine has been detected.

Methods inherited from interface flux.audittrail.AbstractAuditTrailEvent

getEngineName, getName

Method Detail

getFreeMemory

long getFreeMemory()

Returns the free memory available in the Java Virtual Machine (JVM).

Returns:

The free memory available in the Java Virtual Machine (JVM).

getMaximumDatabaseConnections

int getMaximumDatabaseConnections()

Returns the maximum number of database connections that this Flux engine is configured to use.

Returns:

The maximum number of database connections that this Flux engine is configured to use.

getLocallyRunningFlowChartCount

int getLocallyRunningFlowChartCount()

Returns the number of flow charts currently executing within this Flux engine.

Returns:

The number of flow charts currently executing within this Flux engine.

getOccupiedDatabaseConnectionCount

int getOccupiedDatabaseConnectionCount()

Returns the actual number of database connections that this Flux engine is currently using.

Returns:

The actual number of database connections that this Flux engine is currently using.

getTotalMemory

long getTotalMemory()

Returns the total memory available in the Java Virtual Machine (JVM).

Returns:

The total memory available in the Java Virtual Machine (JVM).

isErrorCondition

boolean isErrorCondition()

Indicates whether this heartbeat event constitutes an error condition, which indicates that a severe failure in the Flux engine has been detected. Formally, a heartbeat event is considered an error condition if the concrete heartbeat event extends the flux.audittrail.status.ErrorCondition interface.

Returns:

Whether this heartbeat event constitutes an error condition, which indicates that a severe failure in the Flux engine has been detected.

See Also:

ErrorCondition