Merge pull request #8 from scalableminds/health-endpoint

add health endpoint
scalableminds · Dec 4, 2017 · a459523 · a459523
2 parents ef85680 + 84c4317
commit a459523
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/src/main/protobuf/fossildbapi.proto b/src/main/protobuf/fossildbapi.proto
@@ -2,6 +2,12 @@ syntax = "proto2";
 
 package com.scalableminds.fossildb.proto;
 
+message HealthRequest {}
+message HealthReply {
+    required bool success = 1;
+    optional string errorMessage = 2;
+}
+
 message GetRequest {
     required string collection = 1;
     required string key = 2;
@@ -124,6 +130,7 @@ message RestoreFromBackupReply {
 
 
 service FossilDB {
+    rpc Health (HealthRequest) returns (HealthReply) {}
     rpc Get (GetRequest) returns (GetReply) {}
     rpc GetMultipleVersions (GetMultipleVersionsRequest) returns (GetMultipleVersionsReply) {}
     rpc GetMultipleKeys (GetMultipleKeysRequest) returns (GetMultipleKeysReply) {}

diff --git a/src/main/scala/com/scalableminds/fossildb/FossilDBGrpcImpl.scala b/src/main/scala/com/scalableminds/fossildb/FossilDBGrpcImpl.scala
@@ -15,6 +15,10 @@ import scala.concurrent.Future
 
 class FossilDBGrpcImpl(storeManager: StoreManager) extends FossilDBGrpc.FossilDB with LazyLogging {
 
+  override def health(req: HealthRequest) = withExceptionHandler(req) {
+    HealthReply(true)
+  } {errorMsg => HealthReply(false, errorMsg)}
+
   override def get(req: GetRequest) = withExceptionHandler(req) {
     val store = storeManager.getStore(req.collection)
     val versionedKeyValuePairOpt = store.get(req.key, req.version)

diff --git a/src/test/scala/com/scalableminds/fossildb/FossilDBSuite.scala b/src/test/scala/com/scalableminds/fossildb/FossilDBSuite.scala
@@ -60,6 +60,10 @@ class FossilDBSuite extends FlatSpec with BeforeAndAfterEach {
     deleteRecursively(new File(testTempDir))
   }
 
+  "Health" should "reply" in {
+    val reply = client.health(HealthRequest())
+    assert(reply.success)
+  }
 
   "Put" should "overwrite old value" in {
     client.put(PutRequest(collectionA, aKey, 0, testData1))