Package 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, Scott Frederick

Field Summary

Fields

Modifier and Type	Field	Description
static final EndpointId	ID	Health endpoint id.

Constructor Summary

Constructors

Constructor	Description
HealthEndpoint(HealthContributorRegistry registry, HealthEndpointGroups groups)	Deprecated. since 2.6.9 for removal in 3.0.0 in favor of HealthEndpoint(HealthContributorRegistry, HealthEndpointGroups, Duration)
HealthEndpoint(HealthContributorRegistry registry, HealthEndpointGroups groups, Duration slowIndicatorLoggingThreshold)	Create a new HealthEndpoint instance.

Method Summary

Modifier and Type	Method	Description
protected HealthComponent	aggregateContributions(ApiVersion apiVersion, Map<String,HealthComponent> contributions, StatusAggregator statusAggregator, boolean showComponents, Set<String> groupNames)
protected final CompositeHealth	getCompositeHealth(ApiVersion apiVersion, Map<String,HealthComponent> components, StatusAggregator statusAggregator, boolean showComponents, Set<String> groupNames)
protected HealthComponent	getHealth(HealthContributor contributor, boolean includeDetails)
HealthComponent	health()
HealthComponent	healthForPath(String... path)

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final EndpointId ID

Health endpoint id.

Constructor Details

HealthEndpoint

@Deprecated
public HealthEndpoint(HealthContributorRegistry registry,
 HealthEndpointGroups groups)

Deprecated.

since 2.6.9 for removal in 3.0.0 in favor of HealthEndpoint(HealthContributorRegistry, HealthEndpointGroups, Duration)

Create a new HealthEndpoint instance.

Parameters:

registry - the health contributor registry

groups - the health endpoint groups

HealthEndpoint

public HealthEndpoint(HealthContributorRegistry registry,
 HealthEndpointGroups groups,
 Duration slowIndicatorLoggingThreshold)

Create a new HealthEndpoint instance.

Parameters:

registry - the health contributor registry

groups - the health endpoint groups

slowIndicatorLoggingThreshold - duration after which slow health indicator logging should occur

Since:

2.6.9

Method Details

health

@ReadOperation
public HealthComponent health()

healthForPath

@ReadOperation
public HealthComponent healthForPath(@Selector(match=ALL_REMAINING)
 String... path)

getHealth

protected HealthComponent getHealth(HealthContributor contributor,
 boolean includeDetails)

aggregateContributions

protected HealthComponent aggregateContributions(ApiVersion apiVersion,
 Map<String,HealthComponent> contributions,
 StatusAggregator statusAggregator,
 boolean showComponents,
 Set<String> groupNames)

getCompositeHealth

protected final CompositeHealth getCompositeHealth(ApiVersion apiVersion,
 Map<String,HealthComponent> components,
 StatusAggregator statusAggregator,
 boolean showComponents,
 Set<String> groupNames)