Class HealthEndpointWebExtension

java.lang.Object

org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension

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

@EndpointWebExtension for the HealthEndpoint.

Since:

4.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, @Nullable ReactiveHealthContributorRegistry fallbackRegistry, HealthEndpointGroups groups, @Nullable Duration slowContributorLoggingThreshold)	Create a new HealthEndpointWebExtension instance.

Method Summary

Modifier and Type	Method	Description
protected HealthDescriptor	aggregateDescriptors(ApiVersion apiVersion, Map<String, HealthDescriptor> contributions, StatusAggregator statusAggregator, boolean showComponents, @Nullable Set<String> groupNames)
WebEndpointResponse<HealthDescriptor>	health(ApiVersion apiVersion, @Nullable WebServerNamespace serverNamespace, SecurityContext securityContext, boolean showAll, String... path)
WebEndpointResponse<HealthDescriptor>	health(ApiVersion apiVersion, WebServerNamespace serverNamespace, SecurityContext securityContext)
WebEndpointResponse<HealthDescriptor>	health(ApiVersion apiVersion, WebServerNamespace serverNamespace, SecurityContext securityContext, String... path)

Methods inherited from class Object

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

Constructor Details

HealthEndpointWebExtension

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

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

health

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

health

public WebEndpointResponse<HealthDescriptor> health(ApiVersion apiVersion,
 @Nullable WebServerNamespace serverNamespace,
 SecurityContext securityContext,
 boolean showAll,
 String... path)

aggregateDescriptors

protected HealthDescriptor aggregateDescriptors(ApiVersion apiVersion,
 Map<String, HealthDescriptor> contributions,
 StatusAggregator statusAggregator,
 boolean showComponents,
 @Nullable Set<String> groupNames)