Module io.helidon.nima.observe.health

Package io.helidon.nima.observe.health

Class HealthFeature

java.lang.Object

io.helidon.nima.servicecommon.HelidonFeatureSupport

io.helidon.nima.observe.health.HealthFeature

All Implemented Interfaces:

FeatureSupport, HttpFeature, ServerLifecycle, Supplier<HttpFeature>

public class HealthFeature
extends HelidonFeatureSupport

Observe health endpoints. This service provides endpoints for Http.Method.GET and Http.Method.HEAD methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthFeature.Builder	Fluent API builder for HealthFeature.

Method Summary

Modifier and Type	Method	Description
static HealthFeature.Builder	builder()	Create a new builder.
protected void	context(String componentPath)
static HealthFeature	create(HealthCheck... healthChecks)	Create a new instance with explicit list of health checks.
Optional<HttpService>	service()	If this feature is represented by a service, return it here, to simplify implementation.

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

configuredContext, context, enabled, logger, postSetup, setup

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.nima.servicecommon.FeatureSupport

setup

Methods inherited from interface io.helidon.nima.webserver.http.HttpFeature

get

Methods inherited from interface io.helidon.nima.webserver.ServerLifecycle

afterStop, beforeStart

Method Details

builder

public static HealthFeature.Builder builder()

Create a new builder.

Returns:

new builder to customize configuration

create

public static HealthFeature create(HealthCheck... healthChecks)

Create a new instance with explicit list of health checks. Discover through ServiceLoader will be disabled.

Parameters:

healthChecks - health checks to use

Returns:

a new health observer

service

public Optional<HttpService> service()

Description copied from interface: FeatureSupport

If this feature is represented by a service, return it here, to simplify implementation. Otherwise you will need to implement FeatureSupport.setup(HttpRouting.Builder, HttpRouting.Builder).

Returns:

service if implemented

context

protected void context(String componentPath)

Overrides:

context in class HelidonFeatureSupport