Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FastIT/health-check
An health check module for express and loopback
https://github.com/FastIT/health-check
Last synced: 4 months ago
JSON representation
An health check module for express and loopback
- Host: GitHub
- URL: https://github.com/FastIT/health-check
- Owner: FastIT
- License: mit
- Archived: true
- Created: 2015-10-09T08:39:18.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-13T08:16:10.000Z (over 7 years ago)
- Last Synced: 2024-06-22T18:48:24.163Z (6 months ago)
- Language: JavaScript
- Size: 60.5 KB
- Stars: 6
- Watchers: 7
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# health-check
[](https://travis-ci.org/FastIT/health-check)
[](https://codecov.io/github/FastIT/health-check?branch=master)
[](https://david-dm.org/FastIT/health-check)
An health check module for express and loopback
# Install
npm install --save healthcheck-fastit
# Usage
In your app, add the following code:
```coffeescript
config = {}
healthcheck = require('healthcheck-fastit') config
app.use healthcheck
```
```
curl http://localhost/api/health-check
```
# API response
```javascript
{
"uptime": 42 // in seconds
"postgres": {
"status": "ok", // or ko
},
"mongo": {
"status": "ok", // or ko
},
"elasticsearch": {
"status": "ok", // or ko
}
}
```
# Database health check
## Postgres
Example with postgres-node:
```coffeescript
express = require 'express'
pg = require 'pg'
db =
name: 'dbname'
host: 'localhost'
port: '5432'
username: 'user'
password: 'pwd'
connectionString = "postgres://#{db.username}:#{db.password}@#{db.host}:#{db.port}/#{db.name}"
config =
postgres:
client: new pg.Client connectionString
app = express()
healthcheck = require('../main/src/module') config
app.use healthcheck
app.server = app.listen 3000
```
## Mongo
Example with mongo-db:
```coffeescript
express = require 'express'
mongodb = require 'mongodb'
db =
name: 'dbname'
host: 'localhost'
port: '5432'
username: 'user'
password: 'pwd'
connectionString = "mongodb://#{db.username}:#{db.password}@#{db.host}:#{db.port}/#{db.name}"
MongoClient = mongodb.MongoClient
mongoClient = new MongoClient()
app = express()
mongo.mongoClient.connect url, (err, db) ->
return if err?
config =
mongo:
client: db
healthcheck = require('../main/src/module') config
app.use healthcheck
app.server = app.listen 3000
```
## Elasticsearch
```coffeescript
elasticsearch = require 'elasticsearch'
express = require 'express'
config =
host: 'localhost'
port: 9200
app = express()
config =
elasticsearch =
client: new elasticsearch.Client
host: config.host + ':' + config.port
log: 'debug'
healthcheck = require('../main/src/module') config
app.use healthcheck
app.server = app.listen 3000
```
# Custom healthchecks
You can add your own healthchecks like this:
```coffeescript
express = require 'express'
config =
custom:
hello: (done) ->
done null, 'hello is OK!'
dataConsistency: (done) ->
done null, {
status: 'ok'
somethingElse: 123
}
error: (done) ->
done 'Unexpected error' # this error will be logged
logger: console # you can specify here a logger with an "error" method to log errors
app = express()
healthcheck = require('../main/src/module') config
app.use healthcheck
app.server = app.listen 3000
```
Then the response looks like this:
```javascript
{
uptime: "2.31 s",
hello: "hello is OK!",
dataConsistency: {
status: 'ok',
somethingElse: 123,
}
}
```