Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RafalWilinski/express-status-monitor
🚀 Realtime Monitoring solution for Node.js/Express.js apps, inspired by status.github.com, sponsored by https://dynobase.dev
https://github.com/RafalWilinski/express-status-monitor
express expressjs health-check health-checks javascript middleware monitoring monitoring-page node nodejs observability socket
Last synced: about 2 months ago
JSON representation
🚀 Realtime Monitoring solution for Node.js/Express.js apps, inspired by status.github.com, sponsored by https://dynobase.dev
- Host: GitHub
- URL: https://github.com/RafalWilinski/express-status-monitor
- Owner: RafalWilinski
- License: mit
- Created: 2016-07-31T15:08:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T14:31:29.000Z (8 months ago)
- Last Synced: 2024-05-22T21:32:57.403Z (4 months ago)
- Topics: express, expressjs, health-check, health-checks, javascript, middleware, monitoring, monitoring-page, node, nodejs, observability, socket
- Language: JavaScript
- Homepage: https://dynobase.dev/
- Size: 1000 KB
- Stars: 3,575
- Watchers: 47
- Forks: 251
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-observability - Express State Metrics - Simple, self-hosted module based on Socket.io and Chart.js to report realtime server metrics for Express-based node servers. (3. Collect / Metrics)
- awesome-github-star - express-status-monitor
README
# express-status-monitor
[](https://www.npmjs.com/express-status-monitor)
[](https://img.shields.io/npm/dt/express-status-monitor.svg)
[](https://circleci.com/gh/RafalWilinski/express-status-monitor)
[](https://www.codetriage.com/rafalwilinski/express-status-monitor)
Simple, self-hosted module based on Socket.io and Chart.js to report realtime server metrics for Express-based node servers.
## Demo
[Demo available here](https://hackathon-starter.walcony.com/status)
## Support for other Node.js frameworks
* [koa-monitor](https://github.com/capaj/koa-monitor) for Koa
* [hapijs-status-monitor](https://github.com/ziyasal/hapijs-status-monitor) for hapi.js
## 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 `http://0.0.0.0:3000`
## Options
Monitor can be configured by passing options object into `expressMonitor` constructor.
Default config:
```javascript
title: 'Express Status', // Default title
theme: 'default.css', // Default styles
path: '/status',
socketPath: '/socket.io', // In case you use a custom path
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,
eventLoop: true,
heap: 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.
```javascript
// config
healthChecks: [{
protocol: 'http',
host: 'localhost',
path: '/admin/health/ex1',
port: '3000'
}, {
protocol: 'http',
host: 'localhost',
path: '/admin/health/ex2',
port: '3000'
}]
```
## 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 https://www.npmjs.com/package/connect-ensure-login
```javascript
const ensureLoggedIn = require('connect-ensure-login').ensureLoggedIn()
const statusMonitor = require('express-status-monitor')();
app.use(statusMonitor);
app.get('/status', ensureLoggedIn, statusMonitor.pageRoute)
```
Credits to [@mattiaerre](https://github.com/mattiaerre)
Example using [http-auth](https://www.npmjs.com/package/http-auth)
```javascript
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', basic.check(statusMonitor.pageRoute)); // use the pageRoute property to serve the dashboard html page
```
## Using module with socket.io in project
If you're using socket.io in your project, this module could break your project because this module by default will spawn its own socket.io instance. To mitigate that, fill websocket parameter with your main socket.io 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
```
## License
[MIT License](https://opensource.org/licenses/MIT) © [Dynobase](https://dynobase.com)