HealthCheck (Metrics Parent 4.1.0 API)

java.lang.Object
- com.codahale.metrics.health.HealthCheck

Direct Known Subclasses:

AsyncHealthCheckDecorator, ThreadDeadlockHealthCheck
```
public abstract class HealthCheck
extends Object
```
A health check for a component of your application.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HealthCheck.Result`	The result of a `HealthCheck` being run.
`static class`	`HealthCheck.ResultBuilder`	This a convenient builder for an `HealthCheck.Result`.

Constructor Summary

Constructors
Constructor Description

HealthCheck()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract HealthCheck.Result`	`check()`	Perform a check of the application component.
`protected Clock`	`clock()`
`HealthCheck.Result`	`execute()`	Executes the health check, catching and handling any exceptions raised by `check()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HealthCheck
```
public HealthCheck()
```
- Method Detail
  - check
```
protected abstract HealthCheck.Result check()
                                     throws Exception
```
    Perform a check of the application component.
    
    Returns:
    
    if the component is healthy, a healthy HealthCheck.Result; otherwise, an unhealthy HealthCheck.Result with a descriptive error message or exception
    
    Throws:
    
    Exception - if there is an unhandled error during the health check; this will result in a failed health check
  - execute
```
public HealthCheck.Result execute()
```
    Executes the health check, catching and handling any exceptions raised by check().
    
    Returns:
    
    if the component is healthy, a healthy HealthCheck.Result; otherwise, an unhealthy HealthCheck.Result with a descriptive error message or exception
  - clock
```
protected Clock clock()
```