updated docs and version

docs/.vuepress/config.js

@@ -146,6 +146,7 @@ export default defineUserConfig({
       {
         text: 'Miscellaneous',
         children: [
+          '/docs/health-check/',
           '/docs/benchmarks/',
           '/docs/bulk-import/',
           '/docs/developer-notes/',

docs/docs/getting-started/what's-new.md

@@ -7,6 +7,11 @@ next: /docs/config-overview/
 
 _NotifyBC_ uses [semantic versioning](https://semver.org/).
 
+## v5.1.0
+
+- Issue [#85](https://github.com/bcgov/NotifyBC/issues/85): Added health check
+- Changed package manager from yarn to npm
+
 ## v5.0.0
 
 See [Upgrade Guide](../upgrade/#v4-to-v5) for more information.

docs/docs/miscellaneous/health-check.md

@@ -0,0 +1,48 @@
+---
+permalink: /docs/health-check/
+---
+
+# Health Check
+
+Health status of _NotifyBC_ can be obtained by querying `/health` API end point. For example
+
+```json
+$ curl -s http://localhost:3000/api/health | jq
+{
+  "status": "ok",
+  "info": {
+    "MongoDB": {
+      "status": "up"
+    },
+    "config": {
+      "status": "up",
+      "count": 2
+    },
+    "redis": {
+      "status": "up"
+    }
+  },
+  "error": {},
+  "details": {
+    "MongoDB": {
+      "status": "up"
+    },
+    "config": {
+      "status": "up",
+      "count": 2
+    },
+    "redis": {
+      "status": "up"
+    }
+  }
+}
+```
+
+If overall health status is OK, the HTTP response code is 200, otherwise 503.
+The response payload shows status of following indicators and health criteria
+
+1. MongoDB - MongoDB must be reachable
+2. config - There must be at least 2 items in MongoDB configuration collection
+3. Redis - Redis must be reachable if configured
+
+`/health` API end point is also reachable in _API Explorer_ of _NotifyBC_ web console.

helm/Chart.yaml

@@ -22,7 +22,7 @@ version: 1.1.1
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: '5.0'
+appVersion: '5.1'
 
 dependencies:
   - name: mongodb

package.json

@@ -1,6 +1,6 @@
 {
   "name": "notify-bc",
-  "version": "5.0.14",
+  "version": "5.1.0",
   "dbSchemaVersion": "0.9.0",
   "description": "A versatile notification API server",
   "author": "f-w",