com.flipkart.ranger.healthservice.monitor

Class IsolatedHealthMonitor<T>

java.lang.Object

com.flipkart.ranger.healthservice.monitor.IsolatedHealthMonitor<T>

All Implemented Interfaces:

Monitor<T>, Runnable

Direct Known Subclasses:

CountMonitor, PingCheckMonitor, RotationStatusMonitor

public abstract class IsolatedHealthMonitor<T>
extends Object
implements Runnable, Monitor<T>

A health monitor that implements a Monitor and Runnable Maintains the latest state of the Monitor, and its latest updated timestamp

See Also:

PingCheckMonitor, RotationStatusMonitor, CountMonitor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
IsolatedHealthMonitor(String name, TimeEntity runInterval)
IsolatedHealthMonitor(String name, TimeEntity runInterval, long stalenessAllowedInMillis)

Method Summary

Modifier and Type	Method and Description
void	disable() disable the monitor, and dont use this monitor to track the aggregated health of the system monitor is enabled by default
void	enable() enable the monitor, and consider it while aggregating the health of the system monitor is enabled by default
T	getHealthStatus()
Date	getLastStatusUpdateTime()
String	getName()
TimeEntity	getRunInterval()
long	getStalenessAllowedInMillis()
boolean	isDisabled()
void	run() updates the healthStatus with the latest value from the monitor check also updates the lastStatusUpdateTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.flipkart.ranger.healthservice.monitor.Monitor

monitor

Field Detail

name

protected String name

Constructor Detail

IsolatedHealthMonitor

public IsolatedHealthMonitor(String name,
                             TimeEntity runInterval)

Parameters:

name - name of the monitor

runInterval - initial delay, time interval of how regularly the monitor is to be run, and timeunit to specify how often the Monitor.monitor() check needs to be executed

IsolatedHealthMonitor

public IsolatedHealthMonitor(String name,
                             TimeEntity runInterval,
                             long stalenessAllowedInMillis)

Parameters:

name - name of the monitor

runInterval - initial delay, time interval of how regularly the monitor is to be run, and timeunit to specify how often the Monitor.monitor() check needs to be executed

stalenessAllowedInMillis - after how long (in milliseconds) should the monitor be regarded as stale (default: 60 seconds)

Method Detail

run

public void run()

updates the healthStatus with the latest value from the monitor check also updates the lastStatusUpdateTime

Specified by:

run in interface Runnable

disable

public void disable()

disable the monitor, and dont use this monitor to track the aggregated health of the system monitor is enabled by default

enable

public void enable()

enable the monitor, and consider it while aggregating the health of the system monitor is enabled by default

getRunInterval

public TimeEntity getRunInterval()

getHealthStatus

public T getHealthStatus()

getLastStatusUpdateTime

public Date getLastStatusUpdateTime()

getName

public String getName()

getStalenessAllowedInMillis

public long getStalenessAllowedInMillis()

Returns:

default of 60 seconds if not set

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Monitor<T>

Returns:

true if the monitor is disabled, else false