37094a4b by Rafal Wilinski

:bomb: Improve README.md and add new gif

1 parent 3b2bab21
#### express-monitor
A module based on Socket.io and Chart.js to report realtime server metrics for Express-based node servers.
# express-monitor
A module based on Socket.io and Chart.js to report realtime server metrics for Express-based node servers. More Node frameworks coming soon.
![Monitoring Page](/out.gif?raw=true "Monitoring Page")
### How to use it (in progress)
## How to use it (in progress)
1. Add this as a dependency (will be on NPM soon)
2. Before any other middleware or router add following line:
`app.use(expressMonitor());`
3. Run server and to go `/status`
## Options
Monitor can be configured by passing options object into `expressMonitor` constructor.
Default config:
```
path: '/status',
socketPort: 41338, // Port for Socket.io communication
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](https://opensource.org/licenses/MIT) 漏 Rafal Wilinski
\ No newline at end of file
......

217 KB | W: | H:

250 KB | W: | H:

out.gif
out.gif
out.gif
out.gif
  • 2-up
  • Swipe
  • Onion skin
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!