runtime_profiler 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7839cd9d608c73c35a269e4bf7f2f52ae482e714dd99a108e9078e6628f9a86b
-  data.tar.gz: 9eecf865436dcd07b575d96c1bfb21d1ba1c9344c9100aa955ed00a84d2e8011
+  metadata.gz: 4c567a2661f9eec0b394b9751be7e66994e12eea070333f1123ca7c8178e3897
+  data.tar.gz: 6eaf3618331b9f5a2c9ea5c657cb61aeb67b391456c4a82f74937a800b78afe7
 SHA512:
-  metadata.gz: eaeedf57a5c02b27e1f75778290f821a4b0ed3901220c7dce8529df44d4bf49fe8d0846a4bb3e7e73b485c96196f85d7d57a6cc3e8df93bfda8b05676526ddc1
-  data.tar.gz: 196e71a0244d7d47c8af6585213c45373dcc8d694bac70daa86e9688877d4b02fc029bc50df87baf3ce288e64c8c7850ea717603975eb38a9da367e34998d9a5
+  metadata.gz: 1f5466a9848de8f4e8dbf80e57d48c1dd146f4867ad7b31f8bae7a88a441b562d75c8efbd54c33ced2efc125b1057bdafa571ff94d3c7c5015ce7ae2e73c5847
+  data.tar.gz: f53a00037808f40793cc28d523577f405581ed5588b29146c49daabe02151a7ad34b5c205aede70c7c93bc98e8858de08c740a9b675bac3ef22e9c67475dc438

data/README.md

@@ -1,16 +1,35 @@
-# runtime_profiler - Runtime Profiler for Rails Applications [![Build Status](https://wnuqui.semaphoreci.com/badges/runtime_profiler/branches/master.svg?style=shields)](https://wnuqui.semaphoreci.com/projects/runtime_profiler)
+# runtime_profiler
 
-`runtime_profiler` instruments API endpoints or methods in your Rails application using Rails' `ActiveSupport::Notifications`. Currently, it is intended to be used during development or test.
+*A runtime profiler for Rails applications.*
 
-It then aggregates and generates report to give you insights about specific calls in your Rails application.
+Check which part of your Rails application is causing slow response time. **runtime_profiler** gives you an easy way to find performance problems by profiling an endpoint or a method in your Rails application.
 
-## Installation
+[![Build Status](https://wnuqui.semaphoreci.com/badges/runtime_profiler/branches/master.svg?style=shields)](https://wnuqui.semaphoreci.com/projects/runtime_profiler)
+
+## Table of contents
+
+- [Getting Started](#getting-started)
+  - [Installing](#installing)
+  - [Profiling](#profiling)
+    - [Structure](#structure)
+    - [Examples](#examples)
+  - [Viewing Profiling Result](#viewing-profiling-result)
+    - [view Options](#view-options)
+  - [Configurations](#configurations)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Acknowledgement](#acknowledgement)
+- [License](#license)
+
+## Getting Started
+
+### Installing
 
 Add this line to your application's Gemfile:
 
 ```ruby
+# In your Gemfile
 group :development, :test do
-  ... ...
   gem 'runtime_profiler'
 end
 ```
@@ -19,13 +38,33 @@ And then execute:
 
     $ bundle
 
-## Profiling/Instrumenting
+Or install it yourself as:
+
+    $ gem install runtime_profiler
+
+### Profiling
+
+#### Structure
+
+To profile a specific class (model, controller, etc), all you need to do is to wrap a line where the target class (or instance) is calling a method (entry point of profiling).
+
+```ruby
+# Profiles runtime of `ClassToProfile` class.
+RuntimeProfiler.profile!('description', [ClassToProfile]) {
+  # one line where `ClassToProfile` (or its instance) is calling a method
+}
+```
+
+Since the second argument of `.profile!` accepts array of classes, then you can provide all target classes that you want to profile.
+
+#### Examples
 
-To start profiling, you can make a test that targets a particular endpoint and use `RuntimeProfiler.profile!` method in the test. The output of instrumentation will be generated under the `tmp` folder of your application.
+You can make a test that targets a particular endpoint (or even just a method) and use `RuntimeProfiler.profile!` method in the test.
 
-Example of a test code wrap by `RuntimeProfiler.profile!` method:
 ```ruby
 it 'updates user' do
+  # Profiles runtime of PUT /users/:id endpoint and
+  # specifically interested with the methods of `User` model.
   RuntimeProfiler.profile!('updates user', [User]) {
     patch :update, { id: user.id, name: 'Joe' }
   }
@@ -36,25 +75,26 @@ end
 
 Run the test as usual and follow printed instructions after running.
 
-If you prefer writing just code snippet, then just wrap the snippet with `RuntimeProfiler.profile!` method:
+Or if you prefer writing just code snippet, then just wrap the snippet with `RuntimeProfiler.profile!` method:
 ```ruby
+# Profiles runtime of `UserMailer` mailer.
 RuntimeProfiler.profile!('UserMailer', [UserMailer]) {
   user = User.last
   UserMailer.with(user: user).weekly_summary.deliver_now
 }
 ```
 
-**Note:** The code (tests or not) where `RuntimeProfiler.profile!` is used must be **free from any mocking** since your goal is to check bottlenecks.
+**Note:** The code (test or not) where `RuntimeProfiler.profile!` is used must be **free from any mocking/stubbing** since the goal is to check performance bottlenecks.
 
-## Viewing Profiling Result
+### Viewing Profiling Result
 
-To see profiling/instrumenting report, you can open the report in browser with JSON viewer report. Or you can run the following command:
+To see profiling report, you can open the report in browser with JSON viewer report. Or you can run the following command:
 
 ```bash
-bundle exec runtime_profiler view ~/the-rails-app/tmp/runtime-profiling-51079-1521371428.json
+bundle exec runtime_profiler view tmp/rp-124094-1608308786.json
 ```
 
-### view options
+#### view options
 
 Here are the command line options for `runtime_profiler view` command.
 
@@ -97,9 +137,9 @@ $ bundle exec runtime_profiler view --help
         ROUNDING is integer value. Used in rounding runtimes. Default is 4.
 ```
 
-## Configurations
+### Configurations
 
-All the configurable variables and their defaults are listed below. These configurations can be put in the `config/initializers` folder of your Rails application.
+All the configurable variables and their defaults are listed below. There is no one correct place where to put these configurations. It can be inside `config/initializers` folder of your Rails application. Or if you are using test to profile, it can be in the last part of `spec/spec_helper.rb`.
 ```ruby
 RuntimeProfiler.output_path = File.join(Rails.root.to_s, 'tmp')
 RuntimeProfiler.instrumented_constants = [User]

data/lib/runtime_profiler.rb

@@ -11,15 +11,15 @@ module RuntimeProfiler
   end
 
   config_accessor :instrumented_paths do
-    %w(app lib)
+    %w[app lib]
   end
 
   config_accessor :instrumented_sql_commands do
-    %w(SELECT INSERT UPDATE DELETE)
+    %w[SELECT INSERT UPDATE DELETE]
   end
 
   config_accessor :output_path do
-    if defined?(Rails) && Rails.respond_to?(:root)
+    if defined?(Rails) && Rails.respond_to?(:root) && Rails.root
       File.join(Rails.root.to_s, 'tmp')
     else
       'tmp'
@@ -28,7 +28,11 @@ module RuntimeProfiler
 
   class << self
     def configure
-      Rails.application.eager_load! rescue nil
+      begin
+        Rails.application.eager_load!
+      rescue StandardError
+        nil
+      end
       yield self if block_given?
     end
 
@@ -42,4 +46,4 @@ module RuntimeProfiler
       profiler.save_instrumentation_data
     end
   end
-end
+end

data/lib/runtime_profiler/callbacks/action_controller.rb

@@ -12,6 +12,7 @@ module RuntimeProfiler
       def call(*args)
         event = RuntimeProfiler::ProcessActionEvent.new(args: args)
         return unless event.recordable?
+
         add event
       end
 

data/lib/runtime_profiler/callbacks/active_record.rb

@@ -26,12 +26,12 @@ module RuntimeProfiler
 
         @data[key][:sql]      = event.sanitized_sql
         @data[key][:runtimes] = [
-          [ event.total_runtime, event.trace.first ]
+          [event.total_runtime, event.trace.first]
         ]
       end
 
       def update(event)
-        @data[event.key][:runtimes] << [ event.total_runtime, event.trace.first ]
+        @data[event.key][:runtimes] << [event.total_runtime, event.trace.first]
       end
     end
   end

data/lib/runtime_profiler/cli.rb

@@ -49,4 +49,4 @@ module RuntimeProfiler
       run!
     end
   end
-end
+end

data/lib/runtime_profiler/events/process_action_event.rb

@@ -30,4 +30,4 @@ module RuntimeProfiler
       @key ||= Digest::MD5.hexdigest(path.downcase)
     end
   end
-end
+end

data/lib/runtime_profiler/instrumentation_data.rb

@@ -8,12 +8,34 @@ module RuntimeProfiler
     end
 
     def persist!
-      instrumented_api = [
+      File.open(output_file, 'w') do |f|
+        f.write JSON.dump(instrumentation_data)
+      end
+
+      puts "\n"
+      puts 'Profiling data written at ' + output_file.to_s
+      puts 'You can view profiling data via: bundle exec runtime_profiler view ' + output_file.to_s
+      puts "\n"
+    end
+
+    private
+
+    def output_file
+      FileUtils.mkdir_p(RuntimeProfiler.output_path)
+      filename = ['rp', Process.pid, Time.now.to_i].join('-') + '.json'
+      File.join(RuntimeProfiler.output_path, filename)
+    end
+
+    def instrumented_api
+      return unless controller_data[:payload]
+      @instrumented_api ||= [
         controller_data[:payload][:controller],
         controller_data[:payload][:action]
-      ].join('#') if controller_data[:payload]
+      ].join('#')
+    end
 
-      instrumentation_data = {
+    def instrumentation_data
+      @instrumentation_data ||= {
         instrumentation: {
           instrumented_api: instrumented_api,
           summary: {
@@ -32,31 +54,8 @@ module RuntimeProfiler
           instrumented_at: Time.now
         }
       }
-
-      FileUtils.mkdir_p(RuntimeProfiler.output_path)
-      filename = ['runtime-profiling', Process.pid, Time.now.to_i].join('-') << '.json'
-      output_file = File.join(RuntimeProfiler.output_path, filename)
-
-      File.open(output_file, 'w') do |f|
-        f.write JSON.dump(instrumentation_data)
-      end
-
-      puts "\n"
-      puts '~~~~> [ Profiling RUNTIME ] Profiling now COMPLETE and JSON report is written at ' + output_file.to_s
-      puts '~~~~> [ Profiling RUNTIME ]'
-      puts '~~~~> [ Profiling RUNTIME ] You can do the following to view the JSON report in console:'
-      puts '~~~~> [ Profiling RUNTIME ]'
-      puts '~~~~> [ Profiling RUNTIME ]     bundle exec runtime_profiler view ' + output_file.to_s
-      puts '~~~~> [ Profiling RUNTIME ]'
-      puts '~~~~> [ Profiling RUNTIME ] Or'
-      puts '~~~~> [ Profiling RUNTIME ]'
-      puts '~~~~> [ Profiling RUNTIME ]     bundle exec runtime_profiler view --help'
-      puts '~~~~> [ Profiling RUNTIME ]'
-      puts '~~~~> [ Profiling RUNTIME ] for more details.'
     end
 
-    private
-
     def method_calls_data
       @method_calls_data ||= begin
         instrumented_methods = {}

data/lib/runtime_profiler/profiler.rb

@@ -23,12 +23,12 @@ module RuntimeProfiler
       @active_record_callback = Callback::ActiveRecord.new
 
       @subscribers << ActiveSupport::Notifications
-        .subscribe('sql.active_record', @active_record_callback)
+                      .subscribe('sql.active_record', @active_record_callback)
 
       @action_controller_callback = Callback::ActionController.new
 
       @subscribers << ActiveSupport::Notifications
-        .subscribe('process_action.action_controller', @action_controller_callback)
+                      .subscribe('process_action.action_controller', @action_controller_callback)
     end
 
     def unsubscribe_to_event_notifications
@@ -38,18 +38,18 @@ module RuntimeProfiler
     end
 
     def prepare_methods_to_instrument
-      self.instrumented_constants.flatten
-        .each { |constant| MethodMeter.observe(constant) }
+      instrumented_constants.flatten
+                            .each { |constant| MethodMeter.observe(constant) }
     end
 
     def save_instrumentation_data
       unsubscribe_to_event_notifications
 
       instrumentation_data = RuntimeProfiler::InstrumentationData.new \
-         controller_data: @action_controller_callback.controller_data,
-                sql_data: @active_record_callback.data
+        controller_data: @action_controller_callback.controller_data,
+        sql_data: @active_record_callback.data
 
       instrumentation_data.persist!
     end
   end
-end
+end

data/lib/runtime_profiler/text_report.rb

@@ -26,12 +26,12 @@ module RuntimeProfiler
         \e[1mSQL CALLS\e[22m
           Total             : %s
           Total Unique      : %s
-          
+
           \e[1mSLOWEST\e[22m
             Total Runtime   : %s ms
             SQL             : %s
             Source          : %s
-          
+
           \e[1mMOSTLY CALLED\e[22m
             Total Calls     : %s
             Total Runtime   : %s ms
@@ -86,7 +86,7 @@ module RuntimeProfiler
     attr_accessor :data, :options
 
     def initialize(json_file, options)
-      self.data = JSON.parse( File.read(json_file) )
+      self.data = JSON.parse(File.read(json_file))
       self.options = options
     end
 
@@ -121,12 +121,12 @@ module RuntimeProfiler
 
     def print_summary
       summary = if only_methods?
-        METHODS_DETAILS_TEMPLATE % details_template_data
-      elsif only_sqls?
-        SQLS_DETAILS_TEMPLATE % details_template_data
-      else
-        FULL_DETAILS_TEMPLATE % details_template_data
-      end
+                  METHODS_DETAILS_TEMPLATE % details_template_data
+                elsif only_sqls?
+                  SQLS_DETAILS_TEMPLATE % details_template_data
+                else
+                  FULL_DETAILS_TEMPLATE % details_template_data
+                end
       puts summary
     end
 
@@ -158,7 +158,6 @@ module RuntimeProfiler
           ]
           t.add_separator if index < instrumented_methods.size - 1
         end
-
       end
 
       puts
@@ -176,7 +175,7 @@ module RuntimeProfiler
       instrumented_sql_calls = sort(instrumented_sql_calls, false)
 
       table = Terminal::Table.new do |t|
-        t.headings = ['Count', 'Total Runtime (ms)', 'Average Runtime (ms)', 'SQL Query', 'Source']
+        t.headings = ['SQL Query', 'Count', 'Total Runtime (ms)', 'Average Runtime (ms)', 'Source']
 
         instrumented_sql_calls.each_with_index do |row, index|
           chopped_sql       = wrap_text(row['sql'], sql_width)
@@ -192,18 +191,17 @@ module RuntimeProfiler
           (0...total_lines).each do |line|
             count         = line == 0                 ? row['total_calls']    : ''
             average       = line == 0                 ? average_runtime       : ''
-            total_runtime = line == 0                 ? total_runtime  : ''
+            total_runtime = line == 0                 ? total_runtime : ''
             source        = source_list.length > line ? source_list[line]     : ''
             query         = row['sql'].length > line  ? chopped_sql[line]     : ''
 
             t.add_row []
-            t.add_row [count, total_runtime, average, query, source]
+            t.add_row [query, count, total_runtime, average, source]
           end
 
           t.add_row []
           t.add_separator if index < instrumented_sql_calls.size - 1
         end
-
       end
 
       puts
@@ -215,6 +213,7 @@ module RuntimeProfiler
 
     def wrap_text(text, width)
       return [text] if text.length <= width
+
       text.scan(/.{1,#{width}}/)
     end
 
@@ -231,7 +230,7 @@ module RuntimeProfiler
       end
     end
 
-    def sort(data, methods=true)
+    def sort(data, methods = true)
       if methods
         data.sort_by do |d|
           if options.sort_by == 'max_runtime'
@@ -243,8 +242,8 @@ module RuntimeProfiler
           end
         end
       else
-         options.sort_by = 'total_runtime' if options.sort_by == 'max_runtime'
-        data.sort_by { |d| options.sort_by == 'total_runtime' ?  -d['total_runtime'] : -d['total_calls'] }
+        options.sort_by = 'total_runtime' if options.sort_by == 'max_runtime'
+        data.sort_by { |d| options.sort_by == 'total_runtime' ? -d['total_runtime'] : -d['total_calls'] }
       end
     end
 

data/lib/runtime_profiler/version.rb

@@ -1,3 +1,3 @@
 module RuntimeProfiler
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.4'.freeze
 end

data/runtime_profiler.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'runtime_profiler/version'
 
@@ -19,15 +18,16 @@ Gem::Specification.new do |spec|
   spec.executables   = ['runtime_profiler']
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'activesupport', '>= 3.0.0'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'activesupport', '>= 3.0.0'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'minitest-line'
-  spec.add_runtime_dependency 'terminal-table'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rubocop'
   spec.add_runtime_dependency 'commander'
+  spec.add_runtime_dependency 'defined_methods'
   spec.add_runtime_dependency 'hirb'
   spec.add_runtime_dependency 'method_meter'
-  spec.add_runtime_dependency 'defined_methods'
+  spec.add_runtime_dependency 'terminal-table'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: runtime_profiler
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Wilfrido T. Nuqui Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: minitest-line
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-line
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: defined_methods
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: defined_methods
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="