hhy5277 / express-status-monitor

🚀 Realtime Monitoring solution for Express.js apps, inspired by status.github.com

Issues with HTTPS (including Heroku) has been resolved, module is working again

express-status-monitor

Simple, self-hosted module based on Socket.io and Chart.js to report realtime server metrics for Express-based node servers.

Koa.js version of this library.

More Node frameworks coming soon.

Installation & setup

1. Run npm install express-status-monitor --save
2. Before any other middleware or router add following line: app.use(require('express-status-monitor')());
3. Run server and go to /status

Run examples

1. Go to examples/
2. Run npm install
3. Run server node index.js
4. Go to http://0.0.0.0:3000

Options

Monitor can be configured by passing options object into expressMonitor constructor.

Default config:

title: 'Express Status',  // Default title
path: '/status',
auth: {
  // No authentication at all
  username: '',
  password: '' 
},
spans: [{
  interval: 1,            // Every second
  retention: 60           // Keep 60 datapoints in memory
}, {
  interval: 5,            // Every 5 seconds
  retention: 60
}, {
  interval: 15,           // Every 15 seconds
  retention: 60
}]

License

MIT License © Rafal Wilinski