For use with SEER platform.
$ yarn add seer-checks
Koa & Express are supported. Usage across http frameworks looks pretty much the same.
Koa
...
const seer = require('seer-checks')
let myApp = seer(new Koa(), {
framework: 'koa',
statusUrl: '/api/v1/__status__', // optional
debounce: 30000, // debounce checks
checks: [{
name: 'some-ping',
retries: 5, // number of retries allowed
check: async () => {
await someCheck();
// return or throw an error
}
}]
})Express
...
const seer = require('seer-checks')
let myApp = seer(Express(), {
framework: 'express',
statusUrl: '/api/__status__', // optional
debounce: 30000, // debounce checks
checks: [{
name: 'some-ping',
retries: 5, // number of retries allowed
check: async () => {
await someCheck();
// return or throw an error
}
}]
})Barebones - You can get all the power of retries, debouncing, caching, etc. without using routing.
...
const seer = require('seer-checks')
let runChecks = seer(null, {
framework: 'barebones',
debounce: 30000, // debounce checks
checks: [{
name: 'some-ping',
retries: 5, // number of retries allowed
check: async () => {
await someCheck();
// return or throw an error
}
}]
})
someApplicationRouter.get('whatevermystatus/url/is', function*() {
let result = yield runChecks()
// do something with the request
})GET https://whatever-my-api-is.com/api/__status__/ will return a JSON object. If no checks are passed to the plugin, you get a heartbeat check by default.
{
"status": "ok",
"healthy": true,
"seer-version": "0.0.1"
}If checks have been passed to the plugin, the object will look like:
{
"status": "ok",
"healthy": true,
"seer-version": "0.0.1",
"checks": {
"my-check-name": {
"healthy": false,
"time": 1230,
"error": "Some error was thrown"
},
"another-check": {
"healthy": true,
"time": 400
}
}
}