Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fmiras/micro-health
An extension of micro with a Health Check API
https://github.com/fmiras/micro-health
health health-check micro microservices
Last synced: about 1 month ago
JSON representation
An extension of micro with a Health Check API
- Host: GitHub
- URL: https://github.com/fmiras/micro-health
- Owner: fmiras
- License: mit
- Created: 2018-03-19T15:43:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-24T18:50:35.000Z (almost 5 years ago)
- Last Synced: 2024-11-14T04:34:55.351Z (2 months ago)
- Topics: health, health-check, micro, microservices
- Language: JavaScript
- Size: 212 KB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-micro - micro-health - An extension of micro with a Health Check API (Modules / Utilities)
README
# micro-health
[](https://www.npmjs.com/package/micro-health)
[](https://travis-ci.org/fmiras/micro-health)
[](https://github.com/prettier/prettier)
[](https://github.com/xojs/xo)
[](https://spectrum.chat/micro)
[](https://greenkeeper.io/)
micro-health is used as an extension for micro to add the route `/health` to your service. It was meant to implement the Health Check API microservice design pattern for microservices monitoring. For long read I suggest reading [this page](http://microservices.io/patterns/observability/health-check-api.html).
## Usage
```bash
cd my-micro-project/
npm install --save micro-health
```
and add use the package like this:
```javascript
// index.js
const health = require('micro-health')
const microFn = () => 'Hello World'
module.exports = health(microFn)
```
then just run your microservice normally and it will expose a `/health` endpoint.
By default the health request it will return you an HTTP 200 response with a 'success' message and it will fail if the microservice isn't available, this guarantees that your microservice is working or not regardless of the other functions of microservice itself. Also it supports a custom errorChecker:
```javascript
// index.js
const health = require('micro-health')
const microFn = (req, res) => {
// Wonderful code
}
const errorChecker = async () => {
// Check if database pool connection is full
// Check if there is still space on filesystem
// Check if external APIs are working
try {
await customChecking()
catch (e) {
return { error: e }
}
// You can also return false to pass the health checking
}
module.exports = health(microFn, errorChecker)
```
If error aren't falsy the health request will return an HTTP 500 response with the returned object by the error checker.
There are several tools for health checking such us:
- [Microservice Graph Explorer](https://github.com/hootsuite/microservice-graph-explorer)
- [nginx](https://github.com/nginxinc/NGINX-Demos/tree/master/fun-with-health-checks)
- [CoScale](https://www.coscale.com)
Or... you can just build your own!
## Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Link the package to the global module directory: `npm link`
3. Within the module you want to test your local development instance of micro-cacheable, just link it to the dependencies: `npm link micro-health`. Instead of the default one from npm, node will now use your clone of micro-health!
## Credits
Thanks to [ZEIT](https://zeit.co) Team for giving us [micro](https://github.com/zeit/micro) to make our life easier!