Module io.helidon.health
Package io.helidon.health

Interface HealthCheck

All Known Implementing Classes:
DbClientHealthCheck, DeadlockHealthCheck, DiskSpaceHealthCheck, HeapMemoryHealthCheck, MicrostreamHealthCheck, Neo4jHealthCheck
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 HealthCheck
A health check. Health checks are called when a request to health status comes over the wire.

  • Method Summary

    Modifier and Type
    Method
    Description
    HealthCheckResponse
    call()
    Call a health check.
    default String
    name()
    Name of this health check, used in output when details are requested.
    default String
    path()
    Path of this health check, to support single health-check queries.
    default HealthCheckType
    type()
    Type of this health check.

  • Method Details

    • type

      default HealthCheckType type()
      Type of this health check.
      Returns:
      type, defaults to HealthCheckType.LIVENESS

    • name

      default String name()
      Name of this health check, used in output when details are requested.
      Returns:
      name of this health check, defaults to simple class name

    • path

      default String path()
      Path of this health check, to support single health-check queries.
      Returns:
      path to use, by default returns name()

    • call

      HealthCheckResponse call()
      Call a health check.
      Returns:
      health response