ObserveFeature (webserver.observe) Configuration

Type: io.helidon.webserver.observe.ObserveFeature

Config key
observe
Copied

This type provides the following service implementations:

  • io.helidon.webserver.spi.ServerFeatureProvider

Configuration options

Optional configuration options
keytypedefault valuedescription
cors@io.helidon.cors.CrossOriginConfig@.create()

Cors support inherited by each observe provider, unless explicitly configured.

@return cors support to use
enabled

boolean

true

Whether the observe support is enabled.

@return `false` to disable observe feature
endpoint

string

/observe

Root endpoint to use for observe providers. By default, all observe endpoint are under this root endpoint.

Example:
<br>
If root endpoint is `/observe` (the default), and default health endpoint is `health` (relative),
health endpoint would be `/observe/health`.
@return endpoint to use
observers

io.helidon.webserver.observe.spi.Observer[] (service provider interface)

Such as:

 

Observers to use with this observe features. Each observer type is registered only once, unless it uses a custom name (default name is the same as the type).

@return list of observers to use in this feature
sockets

string[]

 

Sockets the observability endpoint should be exposed on. If not defined, defaults to the default socket (io.helidon.webserver.WebServer#DEFAULT_SOCKET_NAME. Each observer may have its own configuration of sockets that are relevant to it, this only controls the endpoints!

@return list of sockets to register observe endpoint on
weight

double

80.0

Change the weight of this feature. This may change the order of registration of this feature. By default, observability weight is ObserveFeature#WEIGHT so it is registered after routing.

@return weight to use