Module io.helidon.nima.observe.info

Package io.helidon.nima.observe.info

Class InfoObserveProvider

java.lang.Object

io.helidon.nima.observe.info.InfoObserveProvider

All Implemented Interfaces:

ObserveProvider

public class InfoObserveProvider
extends Object
implements ObserveProvider

ServiceLoader provider implementation for application information observe provider.

Constructor Summary

Constructors

Constructor	Description
InfoObserveProvider()	Required by ServiceLoader.

Method Summary

Modifier and Type	Method	Description
String	configKey()	Configuration key of this provider.
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

InfoObserveProvider

public InfoObserveProvider()

Required by ServiceLoader.

Method Details

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