Spec8r Profiler

A simple profiler for Node Express.js.

DISCLAIMER

This library is does not have unit test. This library is a compilation of some of this projects:

• express-profiler by Adpa18
• os-utils by oscmejia

express-profiler

Install

npm install --save-dev spectator-profiler-middleware

Example

const {
  SpecModelBuilder,
  SpecMiddleware,
} = require("spectator-profiler-middleware");

app.use(
  SpecMiddleware((req, res, profile) => {
    profile.user = req.user;
    SpecModelBuilder(profile);
  }, true)
);

Main Functions

| Function | Usage | Remarks | | ------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | SpecMiddleware | (callback(req, res, profile), asyncEnable) | some data requires async callback set true to enable async data. | | SpecMiddleware.callback | (req, res, profile) | profile returns JSON object of profile | | SpecModelBuilder (json) | optional: this will create a json file in root directory that contains all profile. |

Helpers

** for os-utils check os-utils by oscmejia for my modification:

| Function | Usage | | ----------------------------------- | ----- | | OSUtils.cpuCount(), | | | OSUtils.sysUptime(), | | | OSUtils.processUptime(), | | | OSUtils.freemem(), | | | OSUtils.totalmem(), | | | OSUtils.freememPercentage(), | | | OSUtils.harddrive() : "N/A", | | | OSUtils.allLoadavg(), | | | OSUtils.loadavg(), | | | OSUtils.cpuFree((i) => i) : "N/A", | | | OSUtils.cpuUsage((i) => i) : "N/A", | | | SpecHelpers.getStackTrace(), | |