Health Check Package

Installation

Use the package manager npm to install healthcheck_modules.

npm install healthcheck_modules

Usage

const healthChecks = require('healthcheck_modules');
healthChecks({
	mysql:{
		host:"localhost",
		port:3306,
		database:'dummy',
		username:'root',
		password:'root',
		timeout:3000
	},
	redis:{
		host:"localhost",
		port:6379,
		db:"0",
		password:null,
		timeout : 3000 
	},
	kafka:{
		host:"localhost",
		port:9200,
		timeout : 3000
	},
	cassandradb:{
		host:"localhost",
		port:9042,
		localDataCenter:"dummy",
		database:'dummy',
		timeout : 3000
	},
	couchdb:{
		host:"localhost",
		port:5984,
		timeout : 3000
	},
	neo4jdb:{
		host : "localhost",
        port:7687,
        username:"neo4j",
        password:"neo4j",
		timeout : 3000
	},
	mongodb:{
        host:"localhost",
        port:27017,
        database:"dummy",
        timeout : 3000
    },
	exmplesite:{
		url : "http://example.com",
		authorization: '',
		timeout : 3000 
	}

}).then((response) => {
	...
})

Response

{ 
	overall_hc: 'failure',
	status: 500,
	list_of_components:{ 
		mysql: { 
			overall_hc: 'success', 
			message: 'Successfully connected' 
		},
		kafka:	{ 
			overall_hc: 'failure',
			err_code: 'ETIMEDOUT',
			message: 'Operation time out' 
		},
		mongodb:{ 
			overall_hc: 'failure',
			err_code: 'MongoNetworkError',
			message:'failed to connect to server [localhost:27017] on first connect [MongoNetworkError: connect ENETUNREACH localhost:27017 - Local (0.0.0.0:64506)]' 
		},
		neo4jdb:{ 
			overall_hc: 'failure',
			err_code: 'ServiceUnavailable',
			message:'connect ENETUNREACH localhost:8488 - Local (0.0.0.0:64505)' 
		} 
	} 
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

ISC