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(HealthContributorRegistry registry, HealthEndpointGroups groups) Create a new HealthEndpoint instance.
HealthEndpoint(HealthIndicator healthIndicator) Deprecated. since 2.2.0 in favor of HealthEndpoint(HealthContributorRegistry, HealthEndpointGroups)

Method Summary

Modifier and Type	Method and Description
protected HealthComponent	aggregateContributions(Map<String,HealthComponent> contributions, StatusAggregator statusAggregator, boolean includeDetails, Set<String> groupNames)
protected CompositeHealth	getCompositeHealth(Map<String,HealthComponent> components, StatusAggregator statusAggregator, boolean includeDetails, 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

Constructor Detail

HealthEndpoint

@Deprecated
public HealthEndpoint(HealthIndicator healthIndicator)

Deprecated. since 2.2.0 in favor of HealthEndpoint(HealthContributorRegistry, HealthEndpointGroups)

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

Parameters:

healthIndicator - the health indicator

HealthEndpoint

public HealthEndpoint(HealthContributorRegistry registry,
                      HealthEndpointGroups groups)

Create a new HealthEndpoint instance.

Parameters:

registry - the health contributor registry

groups - the health endpoint groups

Method Detail

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(Map<String,HealthComponent> contributions,
                                                 StatusAggregator statusAggregator,
                                                 boolean includeDetails,
                                                 Set<String> groupNames)

getCompositeHealth

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