Package org.apache.juneau.rest.server.health

Class HealthMixin

java.lang.Object

org.apache.juneau.rest.server.servlet.RestMixin

org.apache.juneau.rest.server.health.HealthMixin

public class HealthMixin
extends RestMixin

Mixin flavor of the built-in health/readiness/liveness probe capability.

Composes the /healthz, /readyz, and /livez probe endpoints into a host resource via @Rest(mixins=HealthMixin.class). The ops self-pin their absolute paths so they merge into the host's namespace. Delegates to a shared HealthAggregator worker bean — the same logic the HealthServlet servlet flavor uses.

Indicators are resolved from the host's bean store, so a host registers its own HealthIndicator beans (e.g. via Spring @Bean or a Juneau BeanStore).

See Also:

• HealthServlet
• HealthAggregator
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestMixin

RestMixin.Builder<R extends RestMixin,SELF extends RestMixin.Builder<R,SELF>>, RestMixin.DefaultBuilder<R extends RestMixin>

Constructor Summary

Constructors

Constructor	Description
HealthMixin()

Method Summary

Modifier and Type	Method	Description
HealthAggregator.HealthResponse	healthz(RestRequest req, RestResponse res)	Health probe endpoint.
HealthAggregator.HealthResponse	livez(RestRequest req, RestResponse res)	Liveness probe endpoint.
HealthAggregator.HealthResponse	readyz(RestRequest req, RestResponse res)	Readiness probe endpoint.

Methods inherited from class org.apache.juneau.rest.server.servlet.RestMixin

builder, getHostContext, getRestBuilder, setContext

Methods inherited from class java.lang.Object

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

Constructor Details

HealthMixin

public HealthMixin()

Method Details

healthz

public HealthAggregator.HealthResponse healthz(RestRequest req,
 RestResponse res)

Health probe endpoint.

Parameters:

req - The request.

res - The response.

Returns:

Aggregated health payload.

readyz

public HealthAggregator.HealthResponse readyz(RestRequest req,
 RestResponse res)

Readiness probe endpoint.

Parameters:

req - The request.

res - The response.

Returns:

Aggregated health payload.

livez

public HealthAggregator.HealthResponse livez(RestRequest req,
 RestResponse res)

Liveness probe endpoint.

Parameters:

req - The request.

res - The response.

Returns:

Aggregated health payload.