Module io.helidon.nima.observe.health

Package io.helidon.nima.observe.health

Class HealthFeature.Builder

java.lang.Object

io.helidon.nima.servicecommon.HelidonFeatureSupport.Builder<HealthFeature.Builder,HealthFeature>

io.helidon.nima.observe.health.HealthFeature.Builder

All Implemented Interfaces:

Builder<HealthFeature.Builder,HealthFeature>, Supplier<HealthFeature>

Enclosing class:

HealthFeature

public static class HealthFeature.Builder
extends HelidonFeatureSupport.Builder<HealthFeature.Builder,HealthFeature>

Fluent API builder for HealthFeature.

Method Summary

Modifier and Type	Method	Description
HealthFeature.Builder	addCheck(HealthCheck healthCheck)	Add an explicit Health check instance (not discovered through HealthCheckProvider or when useSystemServices(boolean) is set to false.
HealthFeature.Builder	addCheck(HealthCheck healthCheck, HealthCheckType type)	Add the provided health check using an explicit type (may differ from the HealthCheck.type().
HealthFeature	build()	Build the instance from this builder.
HealthFeature.Builder	config(Config config)	Update this instance from configuration.
HealthFeature.Builder	details(boolean details)	Whether details should be printed.
HealthFeature.Builder	enabled(boolean enabled)	Whether "observe health" should be enabled.
HealthFeature.Builder	useSystemServices(boolean useServices)	Whether to use services discovered by ServiceLoader.

Methods inherited from class io.helidon.nima.servicecommon.HelidonFeatureSupport.Builder

config, crossOriginConfig, restServiceSettings, webContext, webContextConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

build

public HealthFeature build()

Description copied from interface: Builder

Build the instance from this builder.

Returns:

instance of the built type

enabled

public HealthFeature.Builder enabled(boolean enabled)

Whether "observe health" should be enabled.

Parameters:

enabled - set to false to disable health observer

Returns:

updated builder

details

public HealthFeature.Builder details(boolean details)

Whether details should be printed. By default, health only returns a Http.Status.NO_CONTENT_204 for success, Http.Status.SERVICE_UNAVAILABLE_503 for health down, and Http.Status.INTERNAL_SERVER_ERROR_500 in case of error with no entity. When details are enabled, health returns Http.Status.OK_200 for success, same codes otherwise and a JSON entity with detailed information about each health check executed.

Parameters:

details - set to true to enable details

Returns:

updated builder

config

public HealthFeature.Builder config(Config config)

Update this instance from configuration.

Overrides:

config in class HelidonFeatureSupport.Builder<HealthFeature.Builder,HealthFeature>

Parameters:

config - config located at the node of health support (see HealthObserveProvider.configKey()).

Returns:

updated builder

addCheck

public HealthFeature.Builder addCheck(HealthCheck healthCheck)

Add an explicit Health check instance (not discovered through HealthCheckProvider or when useSystemServices(boolean) is set to false.

Parameters:

healthCheck - health check to add

Returns:

updated builder

addCheck

public HealthFeature.Builder addCheck(HealthCheck healthCheck,
 HealthCheckType type)

Add the provided health check using an explicit type (may differ from the HealthCheck.type().

Parameters:

healthCheck - health check to add

type - type to use

Returns:

updated builder

useSystemServices

public HealthFeature.Builder useSystemServices(boolean useServices)

Whether to use services discovered by ServiceLoader.

Parameters:

useServices - set to false to disable discovery

Returns:

updated builder