mprobber / node-timer

A simple timer + median estimator written in node

node-timer

A simple timer + median estimator for node.

Quick Usage Example

var nt = require('node-timer');
var nodeTimer = new nt();
var t = nodeTimer.getTimer("important-things");

// DO IMPORTANT THINGS HERE

t.stop();

API

var t = nodeTimer.getTimer(name)
// DO IMPORTANT THINGS HERE
t.stop();

Starts a timer, and returns the timer object. Use t.stop() to stop the timer.

var r = nodeTimer.timeFunction("superSpecialFunction", function(callback){
    //DO STUFF
});

Time a function call. Note that the function needs to call callback() when done, otherwise the timer will never stop.

var medianTime = nodeTimer.getMedianTime(name);

Pretty self-explanatory. Will return the median time given by a timer.

var allMedians = getMedians();

Returns an object mapping timer names to their median times respectively.

Restify timer

There's also a function to time the full path of arbitrary restify requests. Example usage:

let server = restify.createServer();
server.use(nodeTimer.restifyFullPathTimer());

Be sure to make this call to server.use before your other middleware, otherwise it won't time it.

What's broken

Check the GitHub issues.

LICENSE

MIT - see LICENSE.