express-sysinfo
Basic, batteries included system information display for Node.js Express apps.
In one line it can add a page to display the OS and process info available in Node. It can also count page views to indicate system load.
No dependancies outside Node's built in modules for now.
Installation
$ npm install express-sysinfo
Getting started
Drop a reference to express-sysinfo into your application and it will log page views. If the correct URL is requested it will display the data.
Something like this:
const app = require('express')();
const http = require('http');
const sysInfo = require('express-sysinfo');
app.use(sysInfo());
http.createServer(app).listen(3000, function() {
var addr = this.address();
console.log('My server is listening on %s:%d', addr.address, addr.port);
});
Open a browser and go to http://localhost:3000/sysinfo
Options
express-sysinfo takes an options parameter object
|Option |Purpose |Default
|---|---|---
|returnFormat|The format to present the data. Available values are JSON, HTML or a valid template name. |HTML
|viewerUrl|URL path which will display the system information. Requires the leading slash. |/sysinfo
|countOnly | This instance only counts page views if set to true.| undefined
|viewOnly | This instance only displays system information, it doesn't count page views.| undefined
|cleardownInterval|Milliseconds. Page views are stored as integers and saved to an array and presented from there. Higher numbers load the server less but make the display less current. Max is 15 minutes.|3000
|maxMemoryToDisplay | The maximum memory you expect the app to use to give the Y axis chart scale. Only used if returnFormat is HTML | 150
Further usage
In its default form express-sysinfo presents the viewer to anyone who has the URL. While it's not showing anything particularly confidential I prefer not to display this to unauthenticated users.
Tracking page views is very lightweight and should happen on every call to the server.
For these reasons my preference is to call into express-sysinfo twice like so:
Anywhere in the Express app
app.use(sysInfo({countOnly: true}));
After the auth checks, assuming you are using something like Passport, you can route the viewer:
app.use('/sysinfo', ensureAuthenticated, sysInfo({viewOnly: true, returnFormat: 'HTML', viewerUrl: '/'}));
Note than the viewerUrl is relative to the route hence it's only a single slash to route to https://myserver/sysinfo
Using templates
This is only tested with Handlebars.
If you would prefer presentation to match the rest of your site then express-sysinfo can take a template name and use Express's request.render method.
app.use('/sysinfo', ensureAuthenticated, sysInfo({viewOnly: true, returnFormat: 'systemInfo', viewerUrl: '/'}));
The response.render function will take the returnFormat value as the template name and add an object with all of the info values. In the example above the following could be the template file, systemInfo.hbs
Name |
Value |
OS hostname |
{{osHostname}} |
OS free mem |
{{osFreemem}} |
OS total mem |
{{osTotalmem}} |
OS load average 1 minute (not Windows) |
{{osLoadav1}} |
OS load average 15 minute (not Windows) |
{{osLoadav15}} |
OS uptime |
{{osUptime}} |
Process memory usage resident set size |
{{procMemoryusageRss}} |
Process memory usage heap total |
{{procMemoryusageHeaptotal}} |
Process memory usage heap used |
{{procMemoryusageHeapused}} |
Node version |
{{procVersionsNode}} |
V8 version |
{{procVersionsV8}} |
OpenSSL version |
{{procVersionsOpenssl}} |
Node process uptime |
{{procUptime}} |
Page views per second currently |
{{procPageviewsSec}} |
Page views per second, past 15 mins |
{{procPageviewsSec15}} |
Page views per second, past hour |
{{procPageviewsSec60}} |
License
The MIT License (MIT)
Copyright (c) 2016 See The Spark
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.