express-ping

express-ping

Let your express applications expose a simple API to inform about its internal status and health to both operators and to other applications.

This module was created as an express middleware to simplify its usage. Add a single line to your express application and you are done.

Usage

• Add "express-ping" to your package.json dependencies (npm install express-ping --save)
• Include the middleware in your express application:

var health = require('express-ping');
var express = require('express');

var app = express();
...
app.use(health.ping()); // this is the only addition
app.use(app.router);
...

app.listen(3000);

Once you launch your express application, it will add a new /ping endpoint to check the app status. If you GET http://localhost:3000/ping you will receive the following information:

{
  "timestamp": 1389004812756,
  "uptime": 2187,
  "pid": 5761,
  "memory": {
    "rss": 21147648,
    "heapTotal": 11344896,
    "heapUsed": 4341552
  },
  "versions": {
    "http_parser": "1.0",
    "node": "0.10.22",
    "v8": "3.14.5.9",
    "ares": "1.9.0-DEV",
    "uv": "0.10.19",
    "zlib": "1.2.3",
    "modules": "11",
    "openssl": "1.0.1e"
  },
  "title": "node",
  "arch": "x64",
  "platform": "darwin",
  "argv": [
    "node",
    "/Users/guido/express-ping/examples/server.js"
  ],
  "application": {
    "name": "express-ping",
    "version": "0.2.0"
  },
  "os": {
	"hostname": "tizona.local",
	"uptime": 307199
  }
}

Configuration

You don't need to configure anything. By default, a /ping endpoint will be added to your routes, but you can pass the ping endpoint to the middeware simply doing:

app.use(health.ping('/custompath'));

TODO

• Include CPU usage.
• Include more OS information.
• Debate around the JSON organization (contributions are welcome).

License

MIT