java.lang.Object
org.springframework.boot.actuate.health.HealthComponent
org.springframework.boot.actuate.health.Health

public final class Health extends HealthComponent
Carries information about the health of a component or subsystem. Extends HealthComponent so that additional contextual details about the system can be returned along with the Status.

Health instances can be created by using Health.Builder's fluent API. Typical usage in a HealthIndicator would be:

 try {
        // do some test to determine state of component
        return Health.up().withDetail("version", "1.1.2").build();
 }
 catch (Exception ex) {
        return Health.down(ex).build();
 }
 
Since:
1.1.0
Author:
Christian Dupuis, Phillip Webb, Michael Pratt