Module io.helidon.nima.observe.health

Package io.helidon.nima.observe.health

Class HealthObserveProvider

java.lang.Object

io.helidon.nima.observe.health.HealthObserveProvider

All Implemented Interfaces:

ObserveProvider

public class HealthObserveProvider
extends Object
implements ObserveProvider

ServiceLoader provider implementation for health observe provider.

Constructor Summary

Constructors

Constructor	Description
HealthObserveProvider()	Deprecated. use create(HealthFeature) or create() instead.

Method Summary

Modifier and Type	Method	Description
String	configKey()	Configuration key of this provider.
static ObserveProvider	create()	Create a new instance with health checks discovered through ServiceLoader.
static ObserveProvider	create(HealthFeature service)	Create using a configured observer.
String	defaultEndpoint()	Default endpoint of this provider.
void	register(Config config, String componentPath, HttpRouting.Builder routing)	Register the provider's services and handlers to the routing builder.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthObserveProvider

@Deprecated
public HealthObserveProvider()

Deprecated.

use create(HealthFeature) or create() instead.

Default constructor required by ServiceLoader. Do not use.

Method Details

create

public static ObserveProvider create()

Create a new instance with health checks discovered through ServiceLoader.

Returns:

a new provider

create

public static ObserveProvider create(HealthFeature service)

Create using a configured observer. In this case configuration provided by the ObserveFeature is ignored except for the reserved option endpoint).

Parameters:

service - service to use

Returns:

a new provider based on the observer

configKey

public String configKey()

Description copied from interface: ObserveProvider

Configuration key of this provider. The following keys are reserved by Observe support:

• enabled - enable/disable the service
• endpoint - endpoint, if starts with / then absolute, otherwise relative to observe endpoint

Specified by:

configKey in interface ObserveProvider

Returns:

configuration key of this provider (such as health)

defaultEndpoint

public String defaultEndpoint()

Description copied from interface: ObserveProvider

Default endpoint of this provider. To define a relative path, do not include forward slash (such as health would resolve into /observe/health).

Specified by:

defaultEndpoint in interface ObserveProvider

Returns:

default endpoint under /observe

register

public void register(Config config,
 String componentPath,
 HttpRouting.Builder routing)

Description copied from interface: ObserveProvider

Register the provider's services and handlers to the routing builder. The component MUST honor the provided component path.

Specified by:

register in interface ObserveProvider

Parameters:

config - configuration of this provider

componentPath - component path to register under (such as /observe/health, based on configured endpoint and ObserveProvider.defaultEndpoint())

routing - routing builder