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

Interface HealthIndicator

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface HealthIndicator
Functional SPI for reporting health of one component.
Since:
10.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Health
    check()
    Performs the health check.
    default EnumSet<HealthProbe>
    probes()
    Probe categories where this indicator should run.

  • Method Details

    • check

      Health check()
      Performs the health check.
      Returns:
      Health result. Never null.

    • probes

      default EnumSet<HealthProbe> probes()
      Probe categories where this indicator should run.

      Default is liveness + readiness.

      Returns:
      Probe categories. Never null.