0.6.10

health-ktor/dev.kaccelero.plugins/HealthConfiguration

HealthConfiguration

class HealthConfiguration

Properties

cachingCheckTimeout

var cachingCheckTimeout: <Error class: unknown class>

cachingRefreshInterval

var cachingRefreshInterval: <Error class: unknown class>

var cachingResults: Boolean

cachingStalenessThreshold

var cachingStalenessThreshold: <Error class: unknown class>?

var checks: Map<String, Map<String, HealthCheck>>

var noHealth: Boolean

var noReady: Boolean

Functions

fun customCheck(url: String, name: String, check: HealthCheck)

Adds a check function to a custom check living at the specified URL

disableHealthCheck

fun disableHealthCheck()

Calling this disables the default health check on /healthz

disableReadyCheck

fun disableReadyCheck()

Calling this disabled the default ready check on /readyz

enableCachingResults

fun enableCachingResults(refreshInterval: <Error class: unknown class> = 60.seconds, checkTimeout: <Error class: unknown class> = 30.seconds, stalenessThreshold: <Error class: unknown class>? = null)

Enable caching of health check results with background refresh

fun healthCheck(name: String, check: HealthCheck)

Add a health check giving it a name

fun readyCheck(name: String, check: HealthCheck)

Add a ready check giving it a name