io.appform.ranger.core.healthservice.monitor.sample

Class CountMonitor

java.lang.Object

io.appform.ranger.core.healthservice.monitor.IsolatedHealthMonitor<HealthcheckStatus>

io.appform.ranger.core.healthservice.monitor.sample.CountMonitor

All Implemented Interfaces:

Monitor<HealthcheckStatus>, Runnable

Direct Known Subclasses:

DiskSpaceMonitor

public abstract class CountMonitor
extends IsolatedHealthMonitor<HealthcheckStatus>

A monitor that can be used as a counting monitor to check if any countable entity breaches a threashhold Eg: 1. this could be used to check the heap of your java service, if heap goes beyond a threshold, after which, you would want your service to be marked as unhealthy Just extend this class and implement getCount(), where you could connect to the MBeanServerand return the current heap space being consumed 2. this could be used to keep track of the active thread count of the service

See Also:

DiskSpaceMonitor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CountMonitor.CheckSign

Field Summary

Fields inherited from class io.appform.ranger.core.healthservice.monitor.IsolatedHealthMonitor

name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CountMonitor(String name, CountMonitor.CheckSign checkSign, Integer threshold, TimeEntity timeEntity)

Method Summary

Modifier and Type	Method and Description
abstract Number	getCount()
HealthcheckStatus	monitor() trigger a single check of the monitor service

Methods inherited from class io.appform.ranger.core.healthservice.monitor.IsolatedHealthMonitor

disable, enable, getHealthStatus, getName, getRunInterval, hasValidUpdatedTime, isDisabled, run

Methods inherited from class java.lang.Object

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

Constructor Detail

CountMonitor

protected CountMonitor(String name,
                       CountMonitor.CheckSign checkSign,
                       Integer threshold,
                       TimeEntity timeEntity)

Parameters:

name - name of monitor

checkSign - CountMonitor.CheckSign

threshold - threshold with which the current count will be checked

timeEntity - how often the monitor() check needs to be executed

Method Detail

monitor

public HealthcheckStatus monitor()

Description copied from interface: Monitor

trigger a single check of the monitor service

Returns:

status of check

getCount

public abstract Number getCount()

Returns:

the current value of the entity being monitored