com.philiprehberger:healthcheck
v0.2.0680 downloadsMIT
Composable health check framework with readiness and liveness probes
$
implementation com.philiprehberger:healthcheckREADME
healthcheck
Composable health check framework with readiness and liveness probes.
Installation
Gradle (Kotlin DSL)
implementation("com.philiprehberger:healthcheck:0.2.0")
Maven
<dependency>
<groupId>com.philiprehberger</groupId>
<artifactId>healthcheck</artifactId>
<version>0.2.0</version>
</dependency>
Usage
import com.philiprehberger.healthcheck.*
val health = healthCheck {
check("database") { dataSource.connection.use { it.isValid(2) } }
check("cache", critical = false) { redis.ping() == "PONG" }
}
val report = health.check()
report.status // UP
report.isHealthy() // true
report.toJson() // {"status":"UP",...}
Degraded Status
Non-critical check failures result in DEGRADED status instead of DOWN:
val hc = healthCheck {
check("database", critical = true) { checkDb() }
check("cache", critical = false) { checkCache() } // Failure = DEGRADED, not DOWN
}
val report = hc.check()
// report.status = DEGRADED if only cache fails
Map Export
val map = report.toMap()
// {"status": "UP", "checks": [...], "duration": "..."}
API
| Function / Class | Description |
|---|---|
healthCheck { } | Build a health checker |
check(name, critical, timeout) { Boolean } | Define a health check |
HealthChecker.check() | Run all checks, return HealthReport |
HealthReport.isHealthy() | Check overall status |
HealthReport.toJson() | JSON output |
HealthStatus | UP or DOWN |
HealthStatus.DEGRADED | Intermediate status for non-critical failures |
HealthReport.toMap() | Export report as a Map for flexible serialization |
Development
./gradlew test
./gradlew build
Support
If you find this project useful: