Class HealthEndpoint

java.lang.Object

org.springframework.boot.health.actuate.endpoint.HealthEndpoint

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

@Endpoint to expose application health information.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.boot.actuate.endpoint.EndpointId	ID	Health endpoint id.

Constructor Summary

Constructors

Constructor	Description
HealthEndpoint(HealthContributorRegistry registry, @Nullable ReactiveHealthContributorRegistry fallbackRegistry, HealthEndpointGroups groups, @Nullable Duration slowContributorLoggingThreshold)	Create a new HealthEndpoint instance.

Method Summary

Modifier and Type	Method	Description
protected HealthDescriptor	aggregateDescriptors(org.springframework.boot.actuate.endpoint.ApiVersion apiVersion, Map<String, HealthDescriptor> contributions, StatusAggregator statusAggregator, boolean showComponents, @Nullable Set<String> groupNames)
HealthDescriptor	health()
@Nullable HealthDescriptor	healthForPath(String... path)

Methods inherited from class Object

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

Field Details

ID

public static final org.springframework.boot.actuate.endpoint.EndpointId ID

Health endpoint id.

Constructor Details

HealthEndpoint

public HealthEndpoint(HealthContributorRegistry registry,
 @Nullable ReactiveHealthContributorRegistry fallbackRegistry,
 HealthEndpointGroups groups,
 @Nullable Duration slowContributorLoggingThreshold)

Create a new HealthEndpoint instance.

Parameters:

registry - the health contributor registry

fallbackRegistry - the fallback registry or null

groups - the health endpoint groups

slowContributorLoggingThreshold - duration after which slow health indicator logging should occur

Method Details

health

@ReadOperation
public HealthDescriptor health()

healthForPath

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

aggregateDescriptors

protected HealthDescriptor aggregateDescriptors(org.springframework.boot.actuate.endpoint.ApiVersion apiVersion,
 Map<String, HealthDescriptor> contributions,
 StatusAggregator statusAggregator,
 boolean showComponents,
 @Nullable Set<String> groupNames)