http4k-cloudnative/org.http4k.cloudnative.health

Package-level declarations

Types

Completed

data class Completed(val name: String) : ReadinessCheckResult

Composite

data class Composite(parts: Iterable<ReadinessCheckResult> = emptyList()) : ReadinessCheckResult

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

DefaultReadinessCheckResultRenderer

object DefaultReadinessCheckResultRenderer : ReadinessCheckResultRenderer

Basic reporting of ReadinessCheckResults

Failed

data class Failed(val name: String, val cause: Exception) : ReadinessCheckResult

Health

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.

JsonReadinessCheckResultRenderer

object JsonReadinessCheckResultRenderer

Reporting of ReadinessCheckResults in a JSON tree

Liveness