Healthcheck and monitoring middleware for koa inspired by java spring's actuators. 

Healthcheck and monitoring middleware for koa inspired by java spring's actuators

tcdl

koa-actuator

  "description": "Healthcheck and monitoring middleware for koa inspired by java spring's actuators",

    "url": "https://github.com/tcdl/koa-actuator.git"

const actuator = require('koa-actuator');

Ones you start your koa application, it will add several service endpoints such as /health, /env, etc.

Ones you start your koa application, it will add endpoints /health, /info

The list of service endpoints and examples of responses is below:

Performs health checks and returns the results:

The statuses of the health checks are aggregated in a root-level `status` field. If at least one check yields `DOWN` status, the aggregated status will become `DOWN`. Health checks can be defined on actuator construction:

      status: (await isDbAlive()) ? 'UP' : 'DOWN',

      freeConnections: await freeDbConnectionsLeft()

A check can return an object of an arbitrary structure. If the returned structure contains `status` field, it will be counted in the aggregated status.

Exposes environment properties and command line arguments. Variables that likely to be secure (contain 'user', 'password', 'pass' etc in their names) will be replaced by *******

    "NVM_BIN": "/Users/yyyy/.nvm/versions/node/v7.9.0/bin",

    "/Users/yyyy/.nvm/versions/node/v7.9.0/bin/node",

    "/Users/yyyy/nodeProjects/koa-act-test/index",

		{
		"name": "koa-actuator",
		"version": "0.4.0",
		"version": "0.4.1",
		"description": "Healthcheck and monitoring middleware for koa inspired by java spring's actuators",
		@@ -5,0 +5,0 @@ "main": "lib/index.js",

		@@ -22,3 +22,3 @@ # koa-actuator

		Ones you start your koa application, it will add several service endpoints such as /health, /env, etc.
		Ones you start your koa application, it will add endpoints /health, /info

		@@ -33,10 +33,16 @@ ## Endpoints
		"status": "UP",
		"db": {
		"status": "UP",
		"freeConnections": 10
		},
		"redis": {
		"status": "UP",
		"usedMemory": "52m",
		"uptimeDays": 16
		"details: {
		"db": {
		"status": "UP",
		"details": {
		"freeConnections": 10
		}
		}
		"redis": {
		"status": "UP",
		"details": {
		"usedMemory": "52m",
		"uptimeDays": 16
		}
		}
		}
		@@ -60,21 +66,2 @@ }

		### /env
		Exposes environment properties and command line arguments. Variables that likely to be secure (contain 'user', 'password', 'pass' etc in their names) will be replaced by *******
		```json
		{
		"systemEnvironment": {
		"OLDPWD": "*******",
		"NVM_DIR": "/Users/yyyy/.nvm",
		"USER": "*******",
		"NVM_BIN": "/Users/yyyy/.nvm/versions/node/v7.9.0/bin",
		"HTTP_PORT": "3000"
		},
		"arguments": [
		"/Users/yyyy/.nvm/versions/node/v7.9.0/bin/node",
		"/Users/yyyy/nodeProjects/koa-act-test/index",
		"myarg=test"
		]
		}
		```

		### /info
		@@ -91,28 +78,2 @@ Main application info from package.json
		}
		```

		### /metrics
		```json
		{
		"timestamp": 1494242326200,
		"uptime": 8.017,
		"processors": 8,
		"heap": 10403840,
		"heap.used": 7057224,
		"resources": {
		"memory": {
		"rss": 27021312,
		"heapTotal": 10403840,
		"heapUsed": 7057224,
		"external": 43578
		},
		"loadavg": [
		1.89794921875,
		1.7880859375,
		1.75634765625
		],
		"cpu": "...",
		"nics": "..."
		}
		}
		```

Worsened metrics