org.springframework.boot.actuate.health

Class HealthEndpoint

java.lang.Object

org.springframework.boot.actuate.health.HealthEndpoint

@Endpoint(id="health")
public class HealthEndpoint
extends Object

Endpoint to expose application health information.

Since:

2.0.0

Author:

Dave Syer, Christian Dupuis, Andy Wilkinson, Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
HealthEndpoint(HealthIndicator healthIndicator) Create a new HealthEndpoint instance that will use the given healthIndicator to generate its response.

Method Summary

Modifier and Type	Method and Description
Health	health()
Health	healthForComponent(String component) Return the Health of a particular component or null if such component does not exist.
Health	healthForComponentInstance(String component, String instance) Return the Health of a particular instance managed by the specified component or null if that particular component is not a CompositeHealthIndicator or if such instance does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthEndpoint

public HealthEndpoint(HealthIndicator healthIndicator)

Create a new HealthEndpoint instance that will use the given healthIndicator to generate its response.

Parameters:

healthIndicator - the health indicator

Method Detail

health

@ReadOperation
public Health health()

healthForComponent

@ReadOperation
public Health healthForComponent(@Selector
                                                String component)

Return the Health of a particular component or null if such component does not exist.

Parameters:

component - the name of a particular HealthIndicator

Returns:

the Health for the component or null

healthForComponentInstance

@ReadOperation
public Health healthForComponentInstance(@Selector
                                                        String component,
                                                        @Selector
                                                        String instance)

Return the Health of a particular instance managed by the specified component or null if that particular component is not a CompositeHealthIndicator or if such instance does not exist.

Parameters:

component - the name of a particular CompositeHealthIndicator

instance - the name of an instance managed by that component

Returns:

the Health for the component instance of null