Module io.helidon.webserver.observe.health

Package io.helidon.webserver.observe.health

Class HealthObserver

java.lang.Object

io.helidon.webserver.observe.health.HealthObserver

All Implemented Interfaces:

RuntimeType.Api<HealthObserverConfig>, NamedService, Observer

public class HealthObserver
extends Object
implements Observer, RuntimeType.Api<HealthObserverConfig>

Observer that registers health endpoint, and collects all health checks.

Method Summary

Modifier and Type	Method	Description
static HealthObserverConfig.Builder	builder()	Create a new builder to configure Health observer.
static HealthObserver	create(HealthCheck... healthChecks)	Create a health observer, adding the provided checks to the checks discovered via ServiceLoader and HealthCheckProvider.
static HealthObserver	create(HealthObserverConfig config)	Create a new Health observer using the provided configuration.
static HealthObserver	create(Consumer<HealthObserverConfig.Builder> consumer)	Create a new Health observer customizing its configuration.
HealthObserverConfig	prototype()	Configuration of this observer.
void	register(ServerFeature.ServerFeatureContext featureContext, List<HttpRouting.Builder> observeEndpointRouting, UnaryOperator<String> endpointFunction)	Register the observer features, services, and/or filters.
String	type()	Type of this observer, to make sure we do not configure an observer both from ServiceLoader and using programmatic approach.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.webserver.observe.spi.Observer

name

Method Details

create

public static HealthObserver create(HealthCheck... healthChecks)

Create a health observer, adding the provided checks to the checks discovered via ServiceLoader and HealthCheckProvider.

Parameters:

healthChecks - health checks to add

Returns:

a new observer to register with ObserveFeature

builder

public static HealthObserverConfig.Builder builder()

Create a new builder to configure Health observer.

Returns:

a new builder

create

public static HealthObserver create(HealthObserverConfig config)

Create a new Health observer using the provided configuration.

Parameters:

config - configuration

Returns:

a new observer

create

public static HealthObserver create(Consumer<HealthObserverConfig.Builder> consumer)

Create a new Health observer customizing its configuration.

Parameters:

consumer - configuration consumer

Returns:

a new observer

register

public void register(ServerFeature.ServerFeatureContext featureContext,
 List<HttpRouting.Builder> observeEndpointRouting,
 UnaryOperator<String> endpointFunction)

Description copied from interface: Observer

Register the observer features, services, and/or filters. This is used by the observe feature. Do NOT use this method directly, kindly start with ObserveFeature and register it with the server builder.

Implementations of observers should register all they need through an HttpFeature, to make sure the weight of the ObserveFeature is honored when routing is set up. If you do not use an HttpFeature, the registration will always happen later than the default (business) routing feature.

Specified by:

register in interface Observer

Parameters:

featureContext - access to all routing builders, for cases where this observer needs to register additional components to other sockets

observeEndpointRouting - routing builders that expose observability endpoints, and this feature must use these to register any endpoints exposed for observability

endpointFunction - function to obtain the final endpoint for observers that expose observe endpoints (such as /observe/health would be provider for health by default)

type

public String type()

Description copied from interface: Observer

Type of this observer, to make sure we do not configure an observer both from ServiceLoader and using programmatic approach. If it is desired to have more than one observer of the same type, always use programmatic approach

Specified by:

type in interface NamedService

Specified by:

type in interface Observer

Returns:

type of this observer, should match ObserveProvider.type()

prototype

public HealthObserverConfig prototype()

Description copied from interface: Observer

Configuration of this observer.

Specified by:

prototype in interface Observer

Specified by:

prototype in interface RuntimeType.Api<HealthObserverConfig>

Returns:

configuration of the observer