Skip to content
πŸš€ Realtime Monitoring solution for Node.js/Express.js apps, inspired by
Branch: master
Clone or download
RafalWilinski Merge pull request #117 from RafalWilinski/snyk-fix-lwdu49
[Snyk] Fix for 1 vulnerable dependencies
Latest commit bd6060d Feb 28, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Fix vulnerabilities Sep 18, 2018
src Added support for different styles Nov 9, 2018
test Add health checks Sep 16, 2018
.eslintrc.json Change eslint rule Oct 17, 2017
.snyk Add snyk regulations Oct 5, 2016
LICENSE codebase reorganization Sep 7, 2016 Added support for different styles Nov 9, 2018
package.json fix: package.json & package-lock.json to reduce vulnerabilities Feb 27, 2019


Gitter express-status-monitor on npm npm CircleCI Open Source Helpers

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

Monitoring Page


Demo available here

Support for other Node.js frameworks

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

Note: This plugin works on Node versions > 4.x

Run examples

  1. Go to cd examples/
  2. Run npm i
  3. Run server npm start
  4. Go to


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

Default config:

title: 'Express Status',  // Default title
theme: 'default.css',     // Default styles
path: '/status',
websocket: existingSocketIoInstance,
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
chartVisibility: {
  cpu: true,
  mem: true,
  load: true,
  responseTime: true,
  rps: true,
  statusCodes: true
healthChecks: [],
ignoreStartsWith: '/admin'

Health Checks

You can add a series of health checks to the configuration that will appear below the other stats. The health check will be considered successful if the endpoint returns a 200 status code.

// config
healthChecks: [{
  protocol: 'http',
  host: 'localhost'
  path: '/admin/health/ex1',
  port: '3000'
}, {
  protocol: 'http',
  host: 'localhost'
  path: '/admin/health/ex2',
  port: '3000'

Health Checks

Securing endpoint

The HTML page handler is exposed as a pageRoute property on the main middleware function. So the middleware is mounted to intercept all requests while the HTML page handler will be authenticated.

Example using

const ensureLoggedIn = require('connect-ensure-login').ensureLoggedIn()

const statusMonitor = require('express-status-monitor')();
app.get('/status', ensureLoggedIn, statusMonitor.pageRoute)

Credits to @mattiaerre

Example using http-auth

const auth = require('http-auth');
const basic = auth.basic({realm: 'Monitor Area'}, function(user, pass, callback) {
  callback(user === 'username' && pass === 'password');

// Set '' to config path to avoid middleware serving the html page (path must be a string not equal to the wanted route)
const statusMonitor = require('express-status-monitor')({ path: '' });
app.use(statusMonitor.middleware); // use the "middleware only" property to manage websockets
app.get('/status', auth.connect(basic), statusMonitor.pageRoute); // use the pageRoute property to serve the dashboard html page

Using module with in project

If you're using in your project, this module could break your project because this module by default will spawn its own instance. To mitigate that, fill websocket parameter with your main instance as well as port parameter.

Tests and coverage

In order to run test and coverage use the following npm commands:

npm test
npm run coverage


MIT License Β© Rafal Wilinski

You can’t perform that action at this time.