pac-health-check v1.1.1

Check

Install

$ npm install pac-health-check

Usage

Health Check by Cron Job

var healthCheck = require('pac-health-check');

/* Sample configuration */
 const configuration = {
	cron: '* */5 * * * *',
	max_retry: 2,
	services: {
		api: [{
			name: 'localhost 304',
			url: 'http://localhost:' + port + '/304',
			method: 'GET',
			expectedStatusCode: "200|202|304"
		}, {
			name: 'localhost 200',
			url: 'http://localhost:' + port + '/200',
			method: 'GET',
			expectedStatusCode: 200
		}],
		mssql: [{
			user: "username",
			password: "password",
			server: "server",
			port: 123,
			database: "database",
			connectionTimeout: 2000
		}],
		cas: [{
			seeds: "seed ip",
			keyspace: "key space",
			username: "username",
			password: "password"
		}],
		zkp: [{
			connectionString: "<host>:<port>/<root>"
		}],
		kaf: [{
			connectionString: "<host>:<port>/<root>/<kafka root>"
		}]
	}
};

//Init job
var job = healthCheck.initJob(configuration)

// Wait 5000ms to let the job run
setTimeout(function () {
    var result = healthCheck.reportJob();
    console.log(JSON.stringify(result));
    //Stop the job
    job.stop();
}, 5000)

Healch Check on Demand

healthCheck.reportOnDemand(configuration)

It is recommended to set a ttl configuration.ttl (in seconds).
If ttl is set, healthCheck will leverage local cache.

var healthCheck = require('pac-health-check');

//Sample configuration
var configuration = {
    ttl: 600,
    services: {
        api: [{
            name: 'httpstat.us 202',
            url: 'http://httpstat.us/202',
            method: 'GET',
            expectedStatusCode: "200|204",
            noncritical: true
        }, {
            name: 'httpstat.us 200',
            url: 'https://httpstat.us/200',
            method: 'GET',
            expectedStatusCode: 200
        }
        ]
    }
};

healthCheck.reportOnDemand(configuration)
    .then(function (result) {
        console.log(JSON.stringify(result));
    })
    .catch(function (error) {
        console.log(error);
    });

Health Check Offline

var healthCheck = require('pac-health-check');
healthCheck.offline();

Once offline method is called:

• Both cron job and on demand request will stop perform actual health check. And health check cannont be resumed.
• Health check status is DOWN, previous report is still accessible. (on demand request caching subjects to ttl)

Specification

Common Configuration Object

Supported Services:

• api: Api Service
• mssql: Microsoft SQL Server Service
• cas: Cassandra Service
• zkp: Zookeeper Service
• kaf: kafka Service

Common Application Report Object

Overall Status

• status is UP, When services.{service}[index].status is UP in all services.

• status is DOWN, When any non noncritical servise services.{service}[index].status is DOWN.

• status is DEGRADED, only if any noncritical servise services.{service}[index].status is DOWN.

Service api

Configuration

Report

Api Status

• report.api[index].status is UP by default.

• report.api[index].status is DOWN, when health check result actualStatusCode is not matching expectedStatusCode.

Service mssql

Configuration

Report

Service cas

Configuration

Report

Service zkp

Configuration

Report

Service kaf

Configuration

Report

Sample Report

Heath Check

{
	"status": "UP",
	"max_retry": 3,
	"api": [{
		"name": "localhost 304",
		"url": "http://localhost:9999/304",
		"method": "GET",
		"expectedStatusCode": "200|202|304",
		"currentStatusCode": 304,
		"noncritical": true,
		"status": "UP"
	}, {
		"name": "localhost 200",
		"url": "http://localhost:9999/200",
		"method": "GET",
		"expectedStatusCode": 200,
		"currentStatusCode": 200,
		"status": "UP"
	}],
	"mssql": [{
		"server": "10.1.1.1",
		"database": "Access",
		"status": "UP"
	}],
	"cas": [{
		"seeds": "10.1.1.2",
		"keyspace": "dev_def",
		"status": "UP"
	}],
	"zkp": [{
		"connectionString": "10.1.1.3:2181/dev",
		"status": "UP"
	}],
	"kaf": [{
		"connectionString": "10.1.1.4:2181/dev/kafka",
		"status": "UP"
	}]
}

Heath Check Offline

{
    "status": "DOWN",
    "max_retry": 2,
    "api": [{
        "name": "localhost 202",
        "url": "http://localhost:9999/202",
        "method": "GET",
        "expectedStatusCode": 202,
        "currentStatusCode": 202,
        "status": "UP"
    }, {
        "name": "localhost 202 2",
        "url": "http://localhost:9999/202",
        "method": "GET",
        "expectedStatusCode": 202,
        "currentStatusCode": 202,
        "status": "UP"
    }],
    "mssql": [{
        "server": "10.231.22.213",
        "database": "Access",
        "status": "UP"
    }, {
        "server": "10.231.22.212",
        "database": "Access",
        "status": "UP"
    }],
    "cas": [{
        "seeds": "10.231.23.40",
        "keyspace": "dev_def",
        "status": "UP"
    }, {
        "seeds": "10.231.23.41",
        "keyspace": "dev_def",
        "status": "UP"
    }],
    "zkp": [{
        "connectionString": "dev-usw-r1-def-h1:2181/dev",
        "status": "UP"
    }, {
        "connectionString": "dev-usw-r2-def-h2:2181/dev",
        "status": "UP"
    }],
    "kaf": [{
        "connectionString": "dev-usw-r1-def-h1:2181/dev/kafka",
        "status": "UP"
    }, {
        "connectionString": "dev-usw-r2-def-h2:2181/dev/kafka",
        "status": "UP"
    }],
    "offline": true
}

Test

Test Coverage