express-middleware-timer

express-middleware-timer

   

A simple timer implementation for debugging express middleware.

By default, express-middleware-timer does nothing. It's only activated when your application is started with TIMER=true.

Implementation

Note:

See examples for more detailed working examples.

// require module
var emt = require('express-middleware-timer');

// init timer
app.use(emt.init());

/***
 * // custom report example
 *
 *  app.use(emt.init(function report(req, res) {
 *      var report = emt.calculate(req,res);
 *      console.log('TIMER: %s %s %s',
 *                      new Date(),
 *                      report.request.url,
 *                      JSON.stringify(report.timers));
 *  });
 *
 ***/

// instrument middleware
app.use(emt.instrument(myMiddleware), 'myMiddleware');

// instrument array of middlewares
var middlewares = emt.instrument([
    middlewareOne,
    middlewareTwo,
    middlewareThree
]);

middleware.forEach(function(middleware) {
    app.use(middleware);
});

// routes
app.get('/', myRoute);

// start
app.listen(3000);

Start Application

To enable your timer, start your application with TIMER=true.

TIMER=true node ./app.js

# to start the example
TIMER=true node ./example/app1.js

Sample Log Output

Note:

See examples/simple.js for the code that generated this output.

{ request:
   { url: '/',
     headers:
      { host: 'localhost:3000',
        connection: 'keep-alive',
        accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
        'user-agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/30.0.1599.114 Chrome/30.0.1599.114 Safari/537.36',
        'accept-encoding': 'gzip,deflate,sdch',
        'accept-language': 'en-US,en;q=0.8',
        'if-none-match': '"222957957"' } },
  timers:
   { startup: { from_start: 0, took: 0 },
     slowMiddleware: { took: 201, from_start: 201 },
     fastMiddleware: { took: 0, from_start: 201 } } }

Run Unit Tests

npm install
npm test