io.appform.ranger.core.healthservice

Class ServiceHealthAggregator

java.lang.Object

io.appform.ranger.core.healthservice.ServiceHealthAggregator

All Implemented Interfaces:

Healthcheck, HealthService<HealthcheckStatus>

public class ServiceHealthAggregator
extends Object
implements HealthService<HealthcheckStatus>, Healthcheck

This is a simple HealthService implementation, which can be used to register a set of IsolatedHealthMonitors and get an aggregated health of the service. The aggregated health is maintained by scheduling and running the set of registered (enabled) monitors at regular intervals.

Constructor Summary

Constructors

Constructor and Description
ServiceHealthAggregator()

Method Summary

Modifier and Type	Method and Description
void	addInlineMonitor(Monitor<HealthcheckStatus> monitor) this method can be used to add a Monitor this monitor will not be scheduled in a separate isolated thread, but instead its execution will happen inline, in a single thread, along with other inline monitors
void	addIsolatedMonitor(IsolatedHealthMonitor<HealthcheckStatus> monitor) this method can be used to add a IsolatedHealthMonitor which will later be scheduled at regular intervals and monitored to generate and maintain an aggregated health of the service the scheduling will happen in an isolated thread
HealthcheckStatus	check() return healthy/unhealthy status of the service
HealthcheckStatus	getServiceHealth() aggregate all registered (enabled) monitors, collect individual monitor healths, and aggregate them accordingly
void	start() start monitoring all registered monitors (triggers a scheduled execution of all registered monitors) and saves their futures for later reference)
void	stop() stop all running monitors

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceHealthAggregator

public ServiceHealthAggregator()

Method Detail

addIsolatedMonitor

public void addIsolatedMonitor(IsolatedHealthMonitor<HealthcheckStatus> monitor)

this method can be used to add a IsolatedHealthMonitor which will later be scheduled at regular intervals and monitored to generate and maintain an aggregated health of the service the scheduling will happen in an isolated thread

Specified by:

addIsolatedMonitor in interface HealthService<HealthcheckStatus>

Parameters:

monitor - any extension of the IsolatedHealthMonitor

addInlineMonitor

public void addInlineMonitor(Monitor<HealthcheckStatus> monitor)

this method can be used to add a Monitor this monitor will not be scheduled in a separate isolated thread, but instead its execution will happen inline, in a single thread, along with other inline monitors

Specified by:

addInlineMonitor in interface HealthService<HealthcheckStatus>

Parameters:

monitor - an implementation of line Monitor

start

public void start()

start monitoring all registered monitors (triggers a scheduled execution of all registered monitors) and saves their futures for later reference)

Specified by:

start in interface HealthService<HealthcheckStatus>

stop

public void stop()

stop all running monitors

Specified by:

stop in interface HealthService<HealthcheckStatus>

getServiceHealth

public HealthcheckStatus getServiceHealth()

aggregate all registered (enabled) monitors, collect individual monitor healths, and aggregate them accordingly

Specified by:

getServiceHealth in interface HealthService<HealthcheckStatus>

Returns:

the aggregated health of the service

check

public HealthcheckStatus check()

Description copied from interface: Healthcheck

return healthy/unhealthy status of the service

Specified by:

check in interface Healthcheck

Returns:

health status