Package io.camunda.zeebe.util.health

Class CriticalComponentsHealthMonitor

java.lang.Object

io.camunda.zeebe.util.health.CriticalComponentsHealthMonitor

All Implemented Interfaces:

HealthMonitor, HealthMonitorable

public class CriticalComponentsHealthMonitor
extends Object
implements HealthMonitor

Healthy only if all components are healthy

Constructor Summary

Constructors

Constructor	Description
CriticalComponentsHealthMonitor(String name, ActorControl actor, org.slf4j.Logger log)

Method Summary

Modifier and Type	Method	Description
void	addFailureListener(FailureListener failureListener)	Register a failure observer.
HealthReport	getHealthReport()	Used by a HealthMonitor to get the health status of this component, typically invoked periodically.
String	getName()	Used by a HealthMonitor to get the name of this component.
void	monitorComponent(String componentName)	Add a component name to be monitored.
void	registerComponent(String componentName, HealthMonitorable component)	Register the component to be monitored
void	removeComponent(String componentName)	Stop monitoring the component.
void	removeFailureListener(FailureListener failureListener)	Removes a previously registered listener.
void	startMonitoring()	Starts necessary services for monitoring.

Methods inherited from class java.lang.Object

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

Constructor Details

CriticalComponentsHealthMonitor

public CriticalComponentsHealthMonitor(String name,
 ActorControl actor,
 org.slf4j.Logger log)

Method Details

startMonitoring

public void startMonitoring()

Description copied from interface: HealthMonitor

Starts necessary services for monitoring. Typically implemented by a monitor to start periodic monitoring.

Specified by:

startMonitoring in interface HealthMonitor

monitorComponent

public void monitorComponent(String componentName)

Description copied from interface: HealthMonitor

Add a component name to be monitored. The component will be marked not healthy until the component is registered using HealthMonitor.registerComponent(String, HealthMonitorable)

Specified by:

monitorComponent in interface HealthMonitor

removeComponent

public void removeComponent(String componentName)

Description copied from interface: HealthMonitor

Stop monitoring the component.

Specified by:

removeComponent in interface HealthMonitor

registerComponent

public void registerComponent(String componentName,
 HealthMonitorable component)

Description copied from interface: HealthMonitor

Register the component to be monitored

Specified by:

registerComponent in interface HealthMonitor

getName

public String getName()

Description copied from interface: HealthMonitorable

Used by a HealthMonitor to get the name of this component. Most `HealthMonitorable`s override this method to return their actor name. If they don't override the method, the name of the class is returned.

Specified by:

getName in interface HealthMonitorable

Returns:

the name of this component

getHealthReport

public HealthReport getHealthReport()

Description copied from interface: HealthMonitorable

Used by a HealthMonitor to get the health status of this component, typically invoked periodically.

Specified by:

getHealthReport in interface HealthMonitorable

Returns:

health status

addFailureListener

public void addFailureListener(FailureListener failureListener)

Description copied from interface: HealthMonitorable

Register a failure observer.

Specified by:

addFailureListener in interface HealthMonitorable

Parameters:

failureListener - failure observer to be invoked when a failure that affects the health status of this component occurs

removeFailureListener

public void removeFailureListener(FailureListener failureListener)

Description copied from interface: HealthMonitorable

Removes a previously registered listener. Should do nothing if it was not previously registered.

Specified by:

removeFailureListener in interface HealthMonitorable

Parameters:

failureListener - the failure listener to remove