Akka Management/akka.management.javadsl/HealthChecks

HealthChecks

final class HealthChecks(system: ExtendedActorSystem, settings: HealthCheckSettings)

Can be used to instantiate health checks directly rather than rely on the automatic management route. Useful if want to host the health check via a protocol other than HTTP or not in the Akka Management HTTP server

Source:
HealthChecks.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def alive(): CompletionStage[Boolean]

Returns CompletionStage(result) containing the system's liveness result

Returns CompletionStage(result) containing the system's liveness result

Source:
HealthChecks.scala
def aliveResult(): CompletionStage[CheckResult]

Returns CompletionStage(true) to indicate that the process is alive but does not mean that it is ready to receive traffic e.g. is has not joined the cluster or is loading initial state from a database

Returns CompletionStage(true) to indicate that the process is alive but does not mean that it is ready to receive traffic e.g. is has not joined the cluster or is loading initial state from a database

Source:
HealthChecks.scala
def ready(): CompletionStage[Boolean]

Returns CompletionStage(true) if the system is ready to receive user traffic

Returns CompletionStage(true) if the system is ready to receive user traffic

Source:
HealthChecks.scala
def readyResult(): CompletionStage[CheckResult]

Returns CompletionStage(result), containing the system's readiness result

Returns CompletionStage(result), containing the system's readiness result

Source:
HealthChecks.scala