Merge pull request #59 from MarshallWace/health-checks

adding health-check endpoints
MarshallWace · Oct 8, 2024 · 1d72481 · 1d72481
2 parents de7b50a + fb183f1
commit 1d72481
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/kafkakewl-common/src/main/kotlin/com/mwam/kafkakewl/common/plugins/Configure.kt b/kafkakewl-common/src/main/kotlin/com/mwam/kafkakewl/common/plugins/Configure.kt
@@ -44,6 +44,22 @@ fun Application.configureMonitoring() {
     }
 }
 
+fun Application.configureHealthCheck(name: String, isHealth: () -> Boolean) {
+    routing {
+        get("/$name", {
+            hidden = true
+        }) {
+            if (isHealth()) {
+                call.respond(HttpStatusCode.OK)
+            } else {
+                call.respond(HttpStatusCode.ServiceUnavailable)
+            }
+        }
+    }
+}
+
+fun Application.configureHealthyHealthCheck(name: String) = configureHealthCheck(name) { true }
+
 fun Application.configureHTTP() {
     install(Compression)
     install(CORS) {

diff --git a/kafkakewl-deploy/src/main/kotlin/com/mwam/kafkakewl/deploy/Application.kt b/kafkakewl-deploy/src/main/kotlin/com/mwam/kafkakewl/deploy/Application.kt
@@ -37,8 +37,6 @@ fun Application.module(config: Config) {
     configureCallLogging()
     configureFrameworks(config)
 
-    log
-
     environment.monitor.subscribe(ApplicationStopped) { application ->
         application.environment.log.info("Ktor server has stopped")
         // TODO can this be done in a better way?
@@ -47,4 +45,7 @@ fun Application.module(config: Config) {
     }
 
     configureRouting()
+
+    configureHealthyHealthCheck("liveness")
+    configureHealthyHealthCheck("readiness")
 }
diff --git a/kafkakewl-metrics/src/main/kotlin/com/mwam/kafkakewl/metrics/Application.kt b/kafkakewl-metrics/src/main/kotlin/com/mwam/kafkakewl/metrics/Application.kt
@@ -48,4 +48,7 @@ fun Application.module(config: Config) {
     }
 
     configureRouting()
+
+    configureHealthyHealthCheck("liveness")
+    configureHealthyHealthCheck("readiness")
 }