Constructor Detail

• HealthChecker

  HealthChecker(Duration interval, Duration timeout, Duration maxCheckDuration, Boolean stickyFailures, Duration stickyFailuresGracePeriod, Function0<Result> healthCheckFunc, Clock clock)

Method Detail

• getInterval

   final Duration getInterval()

  The interval at which health checks will be performed.

• setInterval

   final Unit setInterval(Duration interval)

  The interval at which health checks will be performed.

• getResult

   Result getResult()

  The result of a health check.

• getTimeout

   final Duration getTimeout()

  If no health checks have been performed in the last {@code timeout} period, the service is considered unhealthy.

• setTimeout

   final Unit setTimeout(Duration timeout)

  If no health checks have been performed in the last {@code timeout} period, the service is considered unhealthy.

• getMaxCheckDuration

   final Duration getMaxCheckDuration()

  The maximum duration that a call to {@link #performCheck()} is allowed to take. If a call takes longer, the service is considered unhealthy.

  <p> Note that if a check never completes, we rely on {@link #timeout} instead.

• setMaxCheckDuration

   final Unit setMaxCheckDuration(Duration maxCheckDuration)

  The maximum duration that a call to {@link #performCheck()} is allowed to take. If a call takes longer, the service is considered unhealthy.

  <p> Note that if a check never completes, we rely on {@link #timeout} instead.

• getStickyFailures

   final Boolean getStickyFailures()

  If set, a single health check failure after the initial {@link #STICKY_FAILURES_GRACE_PERIOD} will be result in the service being permanently unhealthy.

• setStickyFailures

   final Unit setStickyFailures(Boolean stickyFailures)

  If set, a single health check failure after the initial {@link #STICKY_FAILURES_GRACE_PERIOD} will be result in the service being permanently unhealthy.

• getStickyFailuresGracePeriod

   final Duration getStickyFailuresGracePeriod()

  Failures in this period (since the start of the service) are not sticky.

• setStickyFailuresGracePeriod

   final Unit setStickyFailuresGracePeriod(Duration stickyFailuresGracePeriod)

  Failures in this period (since the start of the service) are not sticky.

• start

   final Unit start()

• stop

   final Unit stop()

• run

   Unit run()

  Performs a health check and updates this instance's state. Runs periodically in {@link #executor}.