Add health checks

RafalWilinski · Sep 16, 2018 · fa55b2c · fa55b2c
1 parent 448d1e0
commit fa55b2c
Show file tree

Hide file tree

Showing 10 changed files with 5,866 additions and 37 deletions.
diff --git a/README.md b/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