Merge pull request #104 from bcdxn/master

Add health checks

README.md

@@ -62,10 +62,32 @@ chartVisibility: {
   rps: true,
   statusCodes: true
 },
+healthChecks: [],
 ignoreStartsWith: '/admin'
 
 ```
 
+## Health Checks
+
+You can add a series of health checks to the configuration that will appear below the other stats. The health check will be considered successful if the endpoint returns a 200 status code.
+
+```javascript
+// config
+healthChecks: [{
+  protocol: 'http',
+  host: 'localhost'
+  path: '/admin/health/ex1',
+  port: '3000'
+}, {
+  protocol: 'http',
+  host: 'localhost'
+  path: '/admin/health/ex2',
+  port: '3000'
+}]
+```
+
+![Health Checks](https://i.imgur.com/6tY4OhA.png "Health Checks")
+
 ## Securing endpoint
 
 The HTML page handler is exposed as a `pageRoute` property on the main

examples/index.js

@@ -21,6 +21,22 @@ app.use(
     // Pass socket.io instance port down to config.
     // Use only if you're passing your own instance.
     // port: socketIoPort,
+    healthChecks: [
+      {
+        protocol: 'http',
+        host: 'localhost',
+        port: 3000,
+        path: '/admin/health/ex1',
+        headers: {},
+      },
+      {
+        protocol: 'http',
+        host: 'localhost',
+        port: 3000,
+        path: '/return-status/200',
+        headers: {},
+      },
+    ],
   }),
 );
 app.use(require('express-favicon-short-circuit'));