Package io.dropwizard.metrics5.health

Interface HealthCheck

All Known Implementing Classes:

AsyncHealthCheckDecorator, ThreadDeadlockHealthCheck

public interface HealthCheck

A health check for a component of your application.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
HealthCheck.Result	check()	Perform a check of the application component.
default io.dropwizard.metrics5.Clock	clock()
default HealthCheck.Result	execute()	Executes the health check, catching and handling any exceptions raised by check().

Method Details

check

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

default 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

default io.dropwizard.metrics5.Clock clock()