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.

1// require module
2var emt = require('express-middleware-timer');
3
4// init timer
5app.use(emt.init());
6
7/***
8 * // custom report example
9 *
10 *  app.use(emt.init(function report(req, res) {
11 *      var report = emt.calculate(req,res);
12 *      console.log('TIMER: %s %s %s',
13 *                      new Date(),
14 *                      report.request.url,
15 *                      JSON.stringify(report.timers));
16 *  });
17 *
18 ***/
19
20// instrument middleware
21app.use(emt.instrument(myMiddleware), 'myMiddleware');
22
23// instrument array of middlewares
24var middlewares = emt.instrument([
25    middlewareOne,
26    middlewareTwo,
27    middlewareThree
28]);
29
30middleware.forEach(function(middleware) {
31    app.use(middleware);
32});
33
34// routes
35app.get('/', myRoute);
36
37// start
38app.listen(3000);

Start Application

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

1TIMER=true node ./app.js
2
3# to start the example
4TIMER=true node ./example/app1.js

Sample Log Output

Note:

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

1{ request:
2   { url: '/',
3     headers:
4      { host: 'localhost:3000',
5        connection: 'keep-alive',
6        accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
7        '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',
8        'accept-encoding': 'gzip,deflate,sdch',
9        'accept-language': 'en-US,en;q=0.8',
10        'if-none-match': '"222957957"' } },
11  timers:
12   { startup: { from_start: 0, took: 0 },
13     slowMiddleware: { took: 201, from_start: 201 },
14     fastMiddleware: { took: 0, from_start: 201 } } }

Run Unit Tests

1npm install
2npm test