Git Product home page Git Product logo

easy-profiler's Introduction

easy-profiler

Build Status

Simple profiler for your node.js application. Debug and find out which part of your code is taking more time, more cpu in an organized way.

How to install?

npm install easy-profiler

API List

<returns Null> EP.begin(<key>);

Call this function whenever you want to begin a task

<returns Object> EP.end(<key>, <doPrintInConsole>);

You just need to call EP.end(key) once your task ends. You can call this function only after calling EP.begin(key). You can pass second params as true/false if you want to print the report immediately.

<returns Array of Object> EP.report(true);

If you plan to get consolidated profiling report at one once then call EP.report(true) once everything ends

EP.isEnabled = false;

Disable it in production

How to use?

Basic example

In the example below we will find out how much time it takes to read the file. We need to call EP.begin(String) at the beginning and call EP.end(String) once reading completes is done

require('easy-profiler');

EP.begin("READ-FILE");
    
fs.readFile('/etc/hosts', 'utf8', function (err,data) {
    if (err) {
     return console.log(err);
    }
    
    console.log(data);
    EP.end("READ-FILE", true); // second param is true that means it will print the info immediatly
});

Nice way

In the example below we will find out how much time it takes to read the file.

require('easy-profiler');
var fs = require('fs');

// Keep all the keys at one place, plan what are the functions you are going to profile
EP.keys.add({
   READ_FROM_HOST_FILE: "Read from host file",
   HTTP_CALL_TO_WIKI_PAGE: "Http call to wiki page"
})

// SAVE_IN_ORACLE_DB job starts here logically right?
EP.begin(EP.keys.READ_FROM_HOST_FILE);
fs.readFile('/etc/hosts', 'utf8', function (err,data) {
    if (err) {
     return console.log(err);
    }
    
    console.log(data);
    
    // SAVE_IN_ORACLE_DB job ends here
    EP.end(EP.keys.READ_FROM_HOST_FILE, true);
});

Want profiling report at the end only

In the example below we will find out how much time it takes to read the file. Also find out how much time is taken by two consecutive for loop

require('easy-profiler');
var fs = require('fs');

// Keep all the keys at one place, plan what are the functions you are going to profile
EP.keys.add({
  READ_FROM_HOST_FILE: "Read from host file",
  JUST_FOR_LOOP_1: "Just a forloop for testing 1",
  JUST_FOR_LOOP_2: "Just a forloop for testing 2"
});

// SAVE_IN_ORACLE_DB job starts here logically right?
EP.begin(EP.keys.READ_FROM_HOST_FILE);

fs.readFile('/etc/hosts', 'utf8', function (err, data) {
  if (err) {
    return console.log(err);
  }

  console.log(data);

  // SAVE_IN_ORACLE_DB job ends here
  EP.end(EP.keys.READ_FROM_HOST_FILE);


  EP.begin(EP.keys.JUST_FOR_LOOP_1);
  for (var i = 0; i < 1000000; i++) {
    var j = 0 + 9; // Just time pass
  }
  EP.end(EP.keys.JUST_FOR_LOOP_1);

  EP.begin(EP.keys.JUST_FOR_LOOP_2);
  for (var i = 0; i < 1000000; i++) {
    var j = 0 + 9; // Just time pass
  }
  EP.end(EP.keys.JUST_FOR_LOOP_2);

  // Yes final report is here
  EP.report(true);
});
Output

alt tag

easy-profiler's People

Contributors

somnathpanja avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.