Package-level declarations

Types

Link copied to clipboard
data class Completed(val name: String) : ReadinessCheckResult
Link copied to clipboard
data class Composite(parts: Iterable<ReadinessCheckResult> = emptyList()) : ReadinessCheckResult

Result of multiple checks, for which it reports an overall result (ie. any failure is fatal).

Link copied to clipboard

Basic reporting of ReadinessCheckResults

Link copied to clipboard
data class Failed(val name: String, val cause: Exception) : ReadinessCheckResult
Link copied to clipboard
object Health

Represents the set of operational endpoints to ensure that a particular app is working ok. By default provides Readiness and Liveness endpoints, but extra routes can be passed, as can a different renderer implementation for the ReadinessCheck results.

Link copied to clipboard

Reporting of ReadinessCheckResults in a JSON tree

Link copied to clipboard
object Liveness : Function1<request: Request, Response>

The Liveness check is used to determine if an app is alive.

Link copied to clipboard
object Readiness

The Readiness check is used to determine if an app is prepared to receive live traffic.

Link copied to clipboard

A Readiness check is used to determine if the pod is ready to receive traffic. An example is to test if the app can talk to it's database.

Link copied to clipboard

The result of a Readiness check. Checks can be combined together with +() to provide an overall result.

Link copied to clipboard

Renders the results of a readiness check

Functions

Link copied to clipboard