nodejs-health-checker
Version:
Simple Nodejs package to simplify applications based in Node, to trace the healthy of the pods
250 lines (222 loc) • 7.58 kB
Markdown
# nodejs-health-checker
<div align="center">
<br>
[](https://badge.fury.io/js/nodejs-health-checker)
[](https://coveralls.io/github/gritzkoo/nodejs-health-checker?branch=master)
[](https://img.shields.io/github/license/gritzkoo/nodejs-health-checker)
[](https://img.shields.io/github/issues/gritzkoo/nodejs-health-checker)
[](https://img.shields.io/github/v/tag/gritzkoo/nodejs-health-checker)
[](https://img.shields.io/github/languages/count/gritzkoo/nodejs-health-checker)
[](https://img.shields.io/github/repo-size/gritzkoo/nodejs-health-checker)
</div>
___
## Contributors
>Made with [contributors-img](https://contrib.rocks).
___
This is a Node package that allows you to track the health of your application, providing two ways of checking:
*__Simple__*: will respond to a JSON as below and that allows you to check if your application is online and responding without checking any kind of integration.
```json
{
"status": "fully functional"
}
```
*__Detailed__*: will respond a JSON as below and that allows you to check if your application is up and running and check if all of your integrations informed in the configuration list is up and running.
```json
{
"name": "My node application",
"version": "my version",
"status": true,
"date": "2020-09-18T15:29:41.616Z",
"duration": 0.523,
"integrations": [
{
"name": "redis integration",
"kind": "Redis DB integration",
"status": true,
"response_time": 0.044,
"url": "redis:6379"
},
{
"name": "My memcache integration",
"kind": "Memcached integraton",
"status": true,
"response_time": 0.038,
"url": "memcache:11211"
},
{
"name": "my web api integration",
"kind": "Web integrated API",
"status": true,
"response_time": 0.511,
"url": "https://github.com/status"
},
{
"name": "my dynamo",
"kind": "AWS Dynamo DB",
"status": true,
"response_time": 0.004,
"url": "http://localhost:8000",
}
]
}
```
## How to install
```sh
npm i nodejs-health-checker
```
## Available integrations
- [x] Redis
- [x] Memcached
- [x] Web integration (https)
- [x] AWS DynamoDB
- [x] Sequelize (authored by @MikeG96)
- [x] Custom integration support (authored by @youngpayters)
## How to use
Example using Nodejs + Express
```javascript
import express from "express";
import {
HealthcheckerDetailedCheck,
HealthcheckerSimpleCheck
} from "./healthchecker/healthchecker";
import { Dialects, HealthTypes } from "./interfaces/types";
const server = express();
server.get("/health-check/liveness", (_, res) => {
res.send(HealthcheckerSimpleCheck());
});
server.get("/health-check/readiness", async (_, res) => {
res.send(
await HealthcheckerDetailedCheck({
name: "My node application",
version: "my version",
// here you will inform all of your external dependencies
// that your application must be checked to keep healthy
// available integration types: [
// HealthTypes.Redis,
// HealthTypes.Memcached,
// HealthTypes.Web
// HealthTypes.Custom
// ]
integrations: [
{
type: HealthTypes.Redis,
name: "redis integration",
host: "redis",
},
{
type: HealthTypes.Memcached,
name: "My memcache integration",
host: "memcache:11211",
},
{
type: HealthTypes.Web,
name: "my web api integration",
host: "https://github.com/status",
headers: [{ key: "Accept", value: "application/json" }],
},
{
type: HealthTypes.Dynamo,
name: "my dynamo",
host: "http://localhost",
port: 8000,
Aws: {
region: "us-east-1",
access_key_id: "",
secret_access_key: "",
},
},
{
type: HealthTypes.Database,
name: "my database",
host: "localhost",
dbPort: 5432,
dbName: "postgres",
dbUser: "postgres",
dbPwd: "root",
dbDialect: Dialects.postgres,
},
{
type: HealthTypes.Custom,
name: "my custom integration",
host: "localhost",
customCheckerFunction: () => { return { status: true, error: {} }},
},
],
})
);
});
export default server;
```
And then, you could call these endpoints manually to see your application health, but, if you are using modern Kubernetes deployment, you can config your chart to check your application with the setup below. There is an [Example](https://runkit.com/gritzkoo/618d325cb041300008eb7bfe) on runkit too.
```yaml
apiVersion: v1
kind: Pod
metadata:
labels:
test: liveness
name: liveness-http
spec:
containers:
- name: liveness
image: 'node' #your application image
args:
- /server
livenessProbe:
httpGet:
path: /health-check/liveness
port: 80
httpHeaders:
- name: Custom-Header
value: Awesome
initialDelaySeconds: 3
periodSeconds: 3
- name: readiness
image: 'node' #your application image
args:
- /server
readinessProbe:
httpGet:
path: /health-check/readiness
port: 80
httpHeaders:
- name: Custom-Header
value: Awesome
initialDelaySeconds: 3
periodSeconds: 3
```
### Import using require
If your application needs to use the `require` instead of ECMAScript, you should import on this way:
```typescript
const express = require('express');
const {
HealthcheckerSimpleCheck,
HealthcheckerDetailedCheck
} = require("nodejs-health-checker/dist/healthchecker/healthchecker");
const { HealthTypes } = require("nodejs-health-checker/dist/interfaces/types");
const server = express();
server.get('/', (req, res) => {
res.json({ status: "I'm alive!" });
})
server.get('/health-check/liveness', (req, res) => {
res.json(HealthcheckerSimpleCheck())
})
server.get('/health-check/readiness', async (req, res) => {
let result = await HealthcheckerDetailedCheck({
name: 'example',
version: 'v1.0.0',
integrations: [
{
type: HealthTypes.Web,
name: 'A simple api integration check',
host: 'https://github.com/status'
}
]
});
res.json(result);
})
server.listen(3000, () => {
console.log('server started at port 3000')
})
```