io.micronaut.management.endpoint.health

Class HealthEndpoint

java.lang.Object

io.micronaut.management.endpoint.health.HealthEndpoint

@Endpoint(value="health",
          defaultSensitive=false)
public class HealthEndpoint
extends Object

Exposes an Endpoint to provide information about the health of the application.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealthEndpoint.StatusConfiguration Configuration related to handling of the HealthStatus.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SENSITIVE If the endpoint is sensitive if no configuration is provided.
static String	NAME Constant for health.
static String	PREFIX Prefix for health endpoint.

Constructor Summary

Constructors

Constructor and Description
HealthEndpoint(HealthAggregator<HealthResult> healthAggregator, HealthIndicator[] healthIndicators, HealthIndicator[] livenessHealthIndicators)

Method Summary

Modifier and Type	Method and Description
DetailsVisibility	getDetailsVisible()
Publisher<HealthResult>	getHealth(Principal principal) Return all health indicators.
Publisher<HealthResult>	getHealth(Principal principal, HealthCheckType selector) Return health indicators based on the selector.
protected HealthIndicator[]	getReadinessHealthIndicators(HealthIndicator[] allHealthIndicators, HealthIndicator[] livenessHealthIndicators)
HealthEndpoint.StatusConfiguration	getStatusConfiguration()
boolean	isServiceReadyIndicatorEnabled() Whether the ServiceReadyHealthIndicator is enabled.
protected HealthLevelOfDetail	levelOfDetail(Principal principal) Returns the level of detail that should be returned by the endpoint.
void	setDetailsVisible(DetailsVisibility detailsVisible) Sets the visibility policy for health information.
void	setServiceReadyIndicatorEnabled(boolean serviceReadyIndicatorEnabled) Set whether the ServiceReadyHealthIndicator is enabled.
void	setStatusConfiguration(HealthEndpoint.StatusConfiguration statusConfiguration) Sets the status configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SENSITIVE

public static final boolean DEFAULT_SENSITIVE

If the endpoint is sensitive if no configuration is provided.

See Also:

Constant Field Values

NAME

public static final String NAME

Constant for health.

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

Prefix for health endpoint.

See Also:

Constant Field Values

Constructor Detail

HealthEndpoint

public HealthEndpoint(HealthAggregator<HealthResult> healthAggregator,
                      HealthIndicator[] healthIndicators,
                      @Liveness
                      HealthIndicator[] livenessHealthIndicators)

Parameters:

healthAggregator - The HealthAggregator

healthIndicators - The HealthIndicator

livenessHealthIndicators - The HealthIndicator qualified by Liveness

Method Detail

getReadinessHealthIndicators

protected final HealthIndicator[] getReadinessHealthIndicators(HealthIndicator[] allHealthIndicators,
                                                               HealthIndicator[] livenessHealthIndicators)

getHealth

@Read
 @SingleResult
public Publisher<HealthResult> getHealth(@Nullable
                                                              Principal principal)

Return all health indicators.

Parameters:

principal - Authenticated user

Returns:

The health information as a Mono

getHealth

@Read
 @SingleResult
public Publisher<HealthResult> getHealth(@Nullable
                                                              Principal principal,
                                                              @Selector
                                                              HealthCheckType selector)

Return health indicators based on the selector.

Parameters:

principal - Authenticated user

selector - HealthEndpointSelector

Returns:

The health information as a Mono

isServiceReadyIndicatorEnabled

public boolean isServiceReadyIndicatorEnabled()

Whether the ServiceReadyHealthIndicator is enabled. Defaults to true.

Returns:

True if it is enabled.

setServiceReadyIndicatorEnabled

public void setServiceReadyIndicatorEnabled(boolean serviceReadyIndicatorEnabled)

Set whether the ServiceReadyHealthIndicator is enabled. Defaults to true.

Parameters:

serviceReadyIndicatorEnabled - True if the service ready indicator should be enabled.

getDetailsVisible

public DetailsVisibility getDetailsVisible()

Returns:

The visibility policy for health information.

setDetailsVisible

public void setDetailsVisible(DetailsVisibility detailsVisible)

Sets the visibility policy for health information.

Parameters:

detailsVisible - The DetailsVisibility

getStatusConfiguration

public HealthEndpoint.StatusConfiguration getStatusConfiguration()

Returns:

The status configuration

setStatusConfiguration

@Inject
public void setStatusConfiguration(HealthEndpoint.StatusConfiguration statusConfiguration)

Sets the status configuration.

Parameters:

statusConfiguration - The status configuration

levelOfDetail

protected HealthLevelOfDetail levelOfDetail(@Nullable
                                            Principal principal)

Returns the level of detail that should be returned by the endpoint.

Parameters:

principal - Authenticated user

Returns:

The HealthLevelOfDetail