Description

Very simple but powerful nodejs module build to track execution time with a resolution of nanoseconds.

Install

Simply run:

npm install exectimer

Usage

Tick

A tick is used to measure the difference between two execution points. All ticks are than used to calculate the average, median, min, max etc. Takes the name of the timer as an argument.

Tick.wrap()

Static function that takes a name and a function as arguments. If the name is omitted than it tries to read the name of the function or it just uses "anon".

Tick.prototype.start()

Starts the timer of this tick.

Tick.prototype.stop()

Stops the timer of this tick.

#Timers Array of timers. Each timer has methods to calculate the various metrics. When a tick is created, it is pushed into the timer with name that was passed to the ticker in the constructor.

var tick = new t.Tick("TIMER");

tick.start();
// Do some processing
tick.stop();

var myTimer = t.timers.TIMER;

console.log("It took: " + myTimer.duration());

You can name your timer however you want.

Timers.TIMER.min()

Get the shortest tick.

Timers.TIMER.max()

Get the longest tick.

Timers.TIMER.mean()

Get the average tick.

Timers.TIMER.median()

Get the median tick.

Timers.TIMER.duration()

Get the total duration of all ticks.

Timers.TIMER.count()

Get the number of ticks.

Timers.TIMER.parse()

Parse the output of the previous methods from nanoseconds to us, ms, ns or seconds.

Example

Wrapping

var t = require('exectimer'),
    Tick = t.Tick;

for(var i = 0; i < 10; i++) {
    Tick.wrap(function myFunction(done) {
      setTimeout(function() {
        done();
      }, 100);
    });
}

var results = t.timers.myFunction;

// Display the results
console.log(results.duration()); // total duration of all ticks
console.log(results.min());      // minimal tick duration
console.log(results.max());      // maximal tick duration
console.log(results.mean());     // mean tick duration
console.log(results.median());   // median tick duration

Instantiating the ticks yourself

var t = require("exectimer"),
  Tick = t.Tick;

for(var i = 0; i < 10; i++) {
  var tick = new Tick("myFunction");
  tick.start();
  
  setTimeout(function() {
    tick.stop();
  }, 100);
}

var myFunc_timer = t.timers.myFunction;
// Display the results
console.log(myFunc_timer.duration()); // total duration of all ticks
console.log(myFunc_timer.min());      // minimal tick duration
console.log(myFunc_timer.max());      // maximal tick duration
console.log(myFunc_timer.mean());     // mean tick duration
console.log(myFunc_timer.median());   // median tick duration