Apache Pekko Management
1.0.0
API
Generated with
Apache Pekko Management/org.apache.pekko.management/org.apache.pekko.management.scaladsl/HealthChecks

HealthChecks

org.apache.pekko.management.scaladsl.HealthChecks
See theHealthChecks companion object
@DoNotInherit
abstract class HealthChecks

Not for user extension

Attributes

Companion
object
Source
HealthChecks.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def alive(): Future[Boolean]

Returns Future(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 Future(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

Attributes

Source
HealthChecks.scala
def aliveResult(): Future[Either[String, Unit]]

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

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

Attributes

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

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

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

Attributes

Source
HealthChecks.scala
def readyResult(): Future[Either[String, Unit]]

Returns Future(result) containing the system's readiness result

Returns Future(result) containing the system's readiness result

Attributes

Source
HealthChecks.scala
Generated with