Package org.springframework.boot.actuate.health

Class HealthEndpointWebExtension

java.lang.Object

org.springframework.boot.actuate.health.HealthEndpointWebExtension

@EndpointWebExtension(endpoint=HealthEndpoint.class)
@ImportRuntimeHints(org.springframework.boot.actuate.health.HealthEndpointWebExtensionRuntimeHints.class)
public class HealthEndpointWebExtension
extends Object

@EndpointWebExtension for the HealthEndpoint.

Since:

2.0.0

Author:

Christian Dupuis, Dave Syer, Andy Wilkinson, Phillip Webb, Eddú Meléndez, Madhura Bhave, Stephane Nicoll, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
HealthEndpointWebExtension(HealthContributorRegistry registry, HealthEndpointGroups groups)	Deprecated. since 2.6.9 for removal in 3.0.0 in favor of HealthEndpointWebExtension(HealthContributorRegistry, HealthEndpointGroups, Duration)
HealthEndpointWebExtension(HealthContributorRegistry registry, HealthEndpointGroups groups, Duration slowIndicatorLoggingThreshold)	Create a new HealthEndpointWebExtension 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)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, WebServerNamespace serverNamespace, SecurityContext securityContext)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, WebServerNamespace serverNamespace, SecurityContext securityContext, boolean showAll, String... path)
WebEndpointResponse<HealthComponent>	health(ApiVersion apiVersion, WebServerNamespace serverNamespace, SecurityContext securityContext, String... path)

Methods inherited from class java.lang.Object

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

Constructor Details

HealthEndpointWebExtension

@Deprecated
public HealthEndpointWebExtension(HealthContributorRegistry registry,
 HealthEndpointGroups groups)

Deprecated.

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

Create a new HealthEndpointWebExtension instance.

Parameters:

registry - the health contributor registry

groups - the health endpoint groups

HealthEndpointWebExtension

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

Create a new HealthEndpointWebExtension 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 WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
 WebServerNamespace serverNamespace,
 SecurityContext securityContext)

health

@ReadOperation
public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
 WebServerNamespace serverNamespace,
 SecurityContext securityContext,
 @Selector(match=ALL_REMAINING)
 String... path)

health

public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion,
 WebServerNamespace serverNamespace,
 SecurityContext securityContext,
 boolean showAll,
 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)