80% of the effects come from 20% of the causes - Pareto principle

Get insights into method call stats in production. Deforest tracks all your controllers/models/helpers/ (and any other directory you want to track) method calls in production and presents method usage data segmented as most used (red), medium used (yellow) and least used (green).

You can anaylze this data the next time you are refactoring some code and want to know the impact of your change. Or if it's bearly used you may even decide to get rid of that code or whatever else. Use your imagination!

Mention gem deforest in your Gemfile or install using gem install deforest. Then run bundle install.

Once the gem is installed, run rails g deforest. This will create an initializer file deforest.rb in config/initializer and a migration file for storing logs.

run rake db:migrate

Finally, add mount Deforest::Engine => '/deforest' in your routes.rb

That's it, you are all set. Now deforest will start collecting data into a log file. For every method call the gem will write some stats to the deforest.log file and periodically will persist the log file data to the deforest_logs table. By default it writes to the table every 1 minute but you can override this by setting config.write_logs_to_db_every (takes a datetime object) in config/initializer/deforest.rb

Deforest.most_used_methods(dir, size=1): returns the top size most used methods in a directory, if nil returns most used methods throughout the application. return type: [file name, line number, method name, call count (how many times this method has been called)]

Deforest.least_used_methods(dir, size=1): returns size least used methods in a directory, if nil returns least used methods throughout the application. return type: [file name, line number, method name, call count (how many times this method has been called)]

To see method usage data goto /deforest/files/dashboard. By default data will be shown for models, however you can check data for your other directories using the "Show data for directory" dropdown in the header.

If you use VS Code, you can view usage stats by downloading the extension data by clicking on "Extension Data" link. Once the file is downloaded, place it in the root of your application folder. Open VScode, download the Deforest extension, then go to any file you want to view usage stats for and then press (cmd + shft + p) -> select "deforest" in the command pallete. Scroll through the file to see methods highlighted in (red|yellow|green). You can hover over the method names to see the actual call count.

There are a few settings you can tweak in config/initializers/deforest.rb.

write_logs_to_db_every: Deforest will persist data from the log file to the DB every write_logs_to_db_every. Change this to 5.minutes or 1.hour or anything else, depending on your application workload.

You will want to restrict access to /deforest only to admins so I suggest you use something like the following (assuming you are using devise):

authenticated :admin, -> user { user.kind_of? Admin } do
  mount Deforest::Engine => '/deforest'
end

track_dirs: add or remove directories you want deforest to track. default: ["/app/models", "/app/controllers", "/app/helpers"]

most_used_percentile_threshold (only used while rendering data in /deforest): Percentile threshold to tell Deforest what methods should be considered most used.

least_used_percentile_threshold (only used while rendering data in /deforest): Percentile threshold to tell Deforest what methods should be considered least used.

VS Code extension so you can see the highlighted methods in your editor itself instead of reading code on the browser. (DONE) Sublime text extension so you can see the highlighted methods in your editor itself instead of reading code on the browser.

Feel free to dive in! Open an issue or submit PRs.