HealthCheckService

This SPI service allow runtime infrastructure such as Kubernetes or Docker Swarm to monitor the app and (potentially) restart it if required.

This SPI service integrates with Spring Boot’sHealthIndicatorSPI, surfaced through theSpring Boot Actuator. It is therefore accessible from the /actuator/health endpoint (Spring allows the endpoint URL to be altered or suppressed).

The service, when called, will be within the context of a special internal user health with the internal role health-role .

API

HealthCheckService.java
interface HealthCheckService {
  Health check()
}

Implementation

The Core Runtime Services module provides a default implementation, HealthCheckServiceForMetaModelValidationFailures, which requires that the metamodel was built correctly with no validation failures.

The internal domain service o.a.c.core.webapp.health.HealthIndicatorUsingHealthCheckService acts as the bridge between Spring and the `HealthCheckService' SPI.