com.codahale.metrics.health

Class HealthCheckRegistry

java.lang.Object

com.codahale.metrics.health.HealthCheckRegistry

public class HealthCheckRegistry
extends Object

A registry for health checks.

Constructor Summary

Constructors

Constructor and Description
HealthCheckRegistry() Creates a new HealthCheckRegistry.

Method Summary

Modifier and Type	Method and Description
SortedSet<String>	getNames() Returns a set of the names of all registered health checks.
void	register(String name, HealthCheck healthCheck) Registers an application HealthCheck.
HealthCheck.Result	runHealthCheck(String name) Runs the health check with the given name.
SortedMap<String,HealthCheck.Result>	runHealthChecks() Runs the registered health checks and returns a map of the results.
SortedMap<String,HealthCheck.Result>	runHealthChecks(ExecutorService executor) Runs the registered health checks in parallel and returns a map of the results.
void	unregister(String name) Unregisters the application HealthCheck with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckRegistry

public HealthCheckRegistry()

Creates a new HealthCheckRegistry.

Method Detail

register

public void register(String name,
                     HealthCheck healthCheck)

Registers an application HealthCheck.

Parameters:

name - the name of the health check

healthCheck - the HealthCheck instance

unregister

public void unregister(String name)

Unregisters the application HealthCheck with the given name.

Parameters:

name - the name of the HealthCheck instance

getNames

public SortedSet<String> getNames()

Returns a set of the names of all registered health checks.

Returns:

the names of all registered health checks

runHealthCheck

public HealthCheck.Result runHealthCheck(String name)
                                  throws NoSuchElementException

Runs the health check with the given name.

Parameters:

name - the health check's name

Returns:

the result of the health check

Throws:

NoSuchElementException - if there is no health check with the given name

runHealthChecks

public SortedMap<String,HealthCheck.Result> runHealthChecks()

Runs the registered health checks and returns a map of the results.

Returns:

a map of the health check results

runHealthChecks

public SortedMap<String,HealthCheck.Result> runHealthChecks(ExecutorService executor)

Runs the registered health checks in parallel and returns a map of the results.

Parameters:

executor - object to launch and track health checks progress

Returns:

a map of the health check results