runtime_profiler 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc4edf1ad5783057cfd0760d11e49a8d91665b71c33b6e809a0796a7d51cb83
-  data.tar.gz: cb19a035d46cae60fd4d16c626fac305a47fab4aaf28134feb47883a9f8a5d94
+  metadata.gz: 10844b957c031772b37b68bfe5f2c83fc98c25c40c709eea8e6920badd400b04
+  data.tar.gz: 52b61fe38de36b0f97fa16bbe742e3baa5e4444f22db6fa64e577deddeba491a
 SHA512:
-  metadata.gz: 1d85ca30cfa19fab9739ca87d6fb0fd1e4cddcf43ed0c5af8c1eab7d867ab24e5dfb11c4e0ad37cbac48a5bf5c149214e40899bd5e4e0a5555bef22d68efd60f
-  data.tar.gz: 6f3ab5d14e1cb231bd4c55156270190346d1de5f1aac3a4c3b09ca992ec577e105b35197a24022f63687034bb07df2f168249a6f72b5adb3ee8a97d4e79282d2
+  metadata.gz: 289e5c785b16a2fb16ff17af9c1d7dbb02d765cf6990bac5ad1c7f4f6005042ff8589a80b79f54b7473705b5323adfb93b49cd31f4fa3e3934d9df15dbb31a6c
+  data.tar.gz: 5b783916251fafdf991f7a3cca98336bc329ce96ff4b1efcb4f215dc2924439c3dabe797f66502956b4169bb72bc60512f3a7b7b04740463a65cb5c60a803353

data/README.md

@@ -141,7 +141,7 @@ $ bundle exec runtime_profiler view --help
 ### Screenshot
 
 <p align="center">
-  <img src="rp_view_only_methods_full_details.png">
+  <img src="rp_view_command.png">
 </p>
 
 ### Configurations
@@ -149,9 +149,11 @@ $ bundle exec runtime_profiler view --help
 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]
-RuntimeProfiler.instrumented_paths = %w(app lib)
-RuntimeProfiler.instrumented_sql_commands = %w(SELECT INSERT UPDATE DELETE)
+RuntimeProfiler.profiled_constants = [User]
+RuntimeProfiler.profiled_paths = %w(app lib)
+RuntimeProfiler.profiled_sql_commands = %w(SELECT INSERT UPDATE DELETE)
+# Useful when you want to exclude in profiling specific method(s) from framework/library being used
+RuntimeProfiler.excepted_methods = [:attribute_type_decorations, :_validators, :defined_enums]
 ```
 
 ## Development

data/lib/runtime_profiler.rb

@@ -6,15 +6,15 @@ require 'method_meter'
 module RuntimeProfiler
   include ActiveSupport::Configurable
 
-  config_accessor :instrumented_constants do
+  config_accessor :profiled_constants do
     []
   end
 
-  config_accessor :instrumented_paths do
+  config_accessor :profiled_paths do
     %w[app lib]
   end
 
-  config_accessor :instrumented_sql_commands do
+  config_accessor :profiled_sql_commands do
     %w[SELECT INSERT UPDATE DELETE]
   end
 
@@ -43,11 +43,11 @@ module RuntimeProfiler
     def profile!(key, konstants)
       konstants = konstants.is_a?(Array) ? konstants : [konstants]
       profiler = Profiler.new(konstants)
-      profiler.prepare_for_instrumentation
+      profiler.prepare_for_profiling
 
       MethodMeter.measure!(key) { yield }
 
-      profiler.save_instrumentation_data
+      profiler.save_profiling_data
     end
   end
 end

data/lib/runtime_profiler/{instrumentation_data.rb → data.rb}

@@ -1,5 +1,5 @@
 module RuntimeProfiler
-  class InstrumentationData
+  class Data
     attr_reader :controller_data, :sql_data
 
     def initialize(controller_data: nil, sql_data: nil)
@@ -9,7 +9,7 @@ module RuntimeProfiler
 
     def persist!
       File.open(output_file, 'w') do |f|
-        f.write JSON.dump(instrumentation_data)
+        f.write JSON.dump(profiling_data)
       end
 
       puts "\n"
@@ -26,18 +26,18 @@ module RuntimeProfiler
       File.join(RuntimeProfiler.output_path, filename)
     end
 
-    def instrumented_api
+    def profiled_api
       return unless controller_data[:payload]
-      @instrumented_api ||= [
+      @profiled_api ||= [
         controller_data[:payload][:controller],
         controller_data[:payload][:action]
       ].join('#')
     end
 
-    def instrumentation_data
-      @instrumentation_data ||= {
-        instrumentation: {
-          instrumented_api: instrumented_api,
+    def profiling_data
+      @profiling_data ||= {
+        profiling: {
+          profiled_api: profiled_api,
           summary: {
                         db_runtime: controller_data[:db_runtime],
                       view_runtime: controller_data[:view_runtime],
@@ -49,16 +49,16 @@ module RuntimeProfiler
                     slowest_method: method_calls_data[:slowest_method],
               mostly_called_method: method_calls_data[:mostly_called_method]
           },
-          instrumented_sql_calls: sql_calls_data[:instrumented_sql_calls],
-          instrumented_methods: method_calls_data[:instrumented_methods],
-          instrumented_at: Time.now
+          profiled_sql_calls: sql_calls_data[:profiled_sql_calls],
+          profiled_methods: method_calls_data[:profiled_methods],
+          profiled_at: Time.now
         }
       }
     end
 
     def method_calls_data
       @method_calls_data ||= begin
-        instrumented_methods = {}
+        profiled_methods = {}
 
         # TODO: Group methods under a key and under an object
         MethodMeter.measurement.each do |measurement|
@@ -69,16 +69,16 @@ module RuntimeProfiler
 
               d[:method] = separator + object.second
 
-              if instrumented_methods[object.first]
-                instrumented_methods[object.first] << d
+              if profiled_methods[object.first]
+                profiled_methods[object.first] << d
               else
-                instrumented_methods[object.first] = [d]
+                profiled_methods[object.first] = [d]
               end
             end
           end
         end
 
-        instrumented_methods = instrumented_methods.inject({}) do |hash, (key, value)|
+        profiled_methods = profiled_methods.inject({}) do |hash, (key, value)|
           val = value.sort { |a, b| b[:total_runtime] <=> a[:total_runtime] }
           hash[key] = val
           hash
@@ -87,7 +87,7 @@ module RuntimeProfiler
         slowest_method = {total_runtime: 0}
         mostly_called_method = {total_calls: 0}
 
-        instrumented_methods.each do |profiled_object_name, methods|
+        profiled_methods.each do |profiled_object_name, methods|
           # sort using `total_runtime` in DESC order
           _methods = methods.sort { |a, b| b[:total_runtime] <=> a[:total_runtime] }
           slowest = _methods[0]
@@ -110,7 +110,7 @@ module RuntimeProfiler
         end
 
         {
-          instrumented_methods: instrumented_methods,
+          profiled_methods: profiled_methods,
                 slowest_method: slowest_method,
           mostly_called_method: mostly_called_method
         }
@@ -119,7 +119,7 @@ module RuntimeProfiler
 
     def sql_calls_data
       @sql_calls_data ||= begin
-        instrumented_sql_calls = []
+        profiled_sql_calls = []
 
         slowest_sql = {total_runtime: 0}
         mostly_called_sql = {total_calls: 0}
@@ -140,7 +140,7 @@ module RuntimeProfiler
             slowest_sql[:source]        = slowest[1]
           end
 
-          instrumented_sql_calls << {
+          profiled_sql_calls << {
                       sql: value[:sql],
                  runtimes: runtimes,
               total_calls: total_calls,
@@ -162,9 +162,9 @@ module RuntimeProfiler
         end
 
         {
-          instrumented_sql_calls: instrumented_sql_calls.sort { |a, b| b[:max] <=> a[:max] },
-                 total_sql_calls: instrumented_sql_calls.map { |sql_call| sql_call[:total_calls] }.reduce(:+),
-          total_unique_sql_calls: instrumented_sql_calls.size,
+          profiled_sql_calls: profiled_sql_calls.sort { |a, b| b[:max] <=> a[:max] },
+                 total_sql_calls: profiled_sql_calls.map { |sql_call| sql_call[:total_calls] }.reduce(:+),
+          total_unique_sql_calls: profiled_sql_calls.size,
                      slowest_sql: slowest_sql,
                mostly_called_sql: mostly_called_sql
         }

data/lib/runtime_profiler/events/sql_event.rb

@@ -10,8 +10,8 @@ module RuntimeProfiler
     end
 
     def recordable?
-      return true unless RuntimeProfiler.instrumented_sql_commands.respond_to?(:join)
-      instrumented_sql_matcher =~ sql
+      return true unless RuntimeProfiler.profiled_sql_commands.respond_to?(:join)
+      profiled_sql_matcher =~ sql
     end
 
     def total_runtime
@@ -41,12 +41,12 @@ module RuntimeProfiler
       @sql ||= @payload[:sql].dup
     end
 
-    def instrumented_sql_matcher
-      @instrumented_sql_matcher ||= /\A#{RuntimeProfiler.instrumented_sql_commands.join('|')}/i
+    def profiled_sql_matcher
+      @profiled_sql_matcher ||= /\A#{RuntimeProfiler.profiled_sql_commands.join('|')}/i
     end
 
     def trace_path_matcher
-      @trace_path_matcher ||= %r{^(#{RuntimeProfiler.instrumented_paths.join('|')})\/}
+      @trace_path_matcher ||= %r{^(#{RuntimeProfiler.profiled_paths.join('|')})\/}
     end
 
     def sanitize_trace!(trace)
@@ -59,7 +59,7 @@ module RuntimeProfiler
 
       Rails.backtrace_cleaner.remove_silencers!
 
-      if RuntimeProfiler.instrumented_paths.respond_to?(:join)
+      if RuntimeProfiler.profiled_paths.respond_to?(:join)
         Rails.backtrace_cleaner.add_silencer do |line|
           line !~ trace_path_matcher
         end

data/lib/runtime_profiler/profiler.rb

@@ -2,19 +2,19 @@
 
 require 'runtime_profiler/callbacks/active_record'
 require 'runtime_profiler/callbacks/action_controller'
-require 'runtime_profiler/instrumentation_data'
+require 'runtime_profiler/data'
 
 module RuntimeProfiler
   class Profiler
-    attr_accessor :instrumented_constants
+    attr_accessor :profiled_constants
 
-    def initialize(konstants)
-      self.instrumented_constants = konstants
+    def initialize(constants)
+      self.profiled_constants = constants
     end
 
-    def prepare_for_instrumentation
+    def prepare_for_profiling
       subscribe_to_event_notifications
-      prepare_methods_to_instrument
+      prepare_methods_to_profile
     end
 
     def subscribe_to_event_notifications
@@ -37,19 +37,19 @@ module RuntimeProfiler
       end
     end
 
-    def prepare_methods_to_instrument
-      instrumented_constants.flatten
+    def prepare_methods_to_profile
+      profiled_constants.flatten
                             .each { |constant| MethodMeter.observe(constant, RuntimeProfiler.excepted_methods) }
     end
 
-    def save_instrumentation_data
+    def save_profiling_data
       unsubscribe_to_event_notifications
 
-      instrumentation_data = RuntimeProfiler::InstrumentationData.new \
+      profiling_data = RuntimeProfiler::Data.new \
         controller_data: @action_controller_callback.controller_data,
         sql_data: @active_record_callback.data
 
-      instrumentation_data.persist!
+      profiling_data.persist!
     end
   end
 end

data/lib/runtime_profiler/text_report.rb

@@ -95,12 +95,12 @@ module RuntimeProfiler
 
       if options.details == 'full'
         if only_methods?
-          print_instrumented_methods
+          print_profiled_methods
         elsif only_sqls?
-          print_instrumented_sql_calls
+          print_profiled_sql_calls
         else
-          print_instrumented_methods
-          print_instrumented_sql_calls
+          print_profiled_methods
+          print_profiled_sql_calls
         end
       end
     end
@@ -130,25 +130,25 @@ module RuntimeProfiler
       puts summary
     end
 
-    def print_instrumented_methods
-      instrumented_methods = []
+    def print_profiled_methods
+      profiled_methods = []
 
-      data['instrumentation']['instrumented_methods'].each do |profiled_object_name, methods|
-        _instrumented_methods = methods.map do |method|
+      data['profiling']['profiled_methods'].each do |profiled_object_name, methods|
+        _profiled_methods = methods.map do |method|
           method['method'] = [profiled_object_name, method['method']].join
           method
         end
-        instrumented_methods.concat(_instrumented_methods)
+        profiled_methods.concat(_profiled_methods)
       end
 
-      instrumented_methods = runtime_above(instrumented_methods) if options.runtime_above.presence > 0
-      instrumented_methods = calls_above(instrumented_methods) if options.calls_above.presence > 0
-      instrumented_methods = sort(instrumented_methods)
+      profiled_methods = runtime_above(profiled_methods) if options.runtime_above.presence > 0
+      profiled_methods = calls_above(profiled_methods) if options.calls_above.presence > 0
+      profiled_methods = sort(profiled_methods)
 
       table = Terminal::Table.new do |t|
         t.headings = ['Method', 'Total Runtime (ms)', 'Total Calls', 'Min (ms)', 'Max (ms)']
 
-        instrumented_methods.each_with_index do |row, index|
+        profiled_methods.each_with_index do |row, index|
           t.add_row [
             row['method'],
             row['total_runtime'].round(rounding),
@@ -156,28 +156,28 @@ module RuntimeProfiler
             row['min'].round(rounding),
             row['max'].round(rounding)
           ]
-          t.add_separator if index < instrumented_methods.size - 1
+          t.add_separator if index < profiled_methods.size - 1
         end
       end
 
       puts
       puts
-      puts "\e[1mINSTRUMENTED METHOD(s)\e[22m"
+      puts "\e[1mPROFILED METHOD(s)\e[22m"
       puts
       puts table
     end
 
-    def print_instrumented_sql_calls
-      instrumented_sql_calls = data['instrumentation']['instrumented_sql_calls']
+    def print_profiled_sql_calls
+      profiled_sql_calls = data['profiling']['profiled_sql_calls']
 
-      instrumented_sql_calls = runtime_above(instrumented_sql_calls) if options.runtime_above.presence > 0
-      instrumented_sql_calls = calls_above(instrumented_sql_calls) if options.calls_above.presence > 0
-      instrumented_sql_calls = sort(instrumented_sql_calls, false)
+      profiled_sql_calls = runtime_above(profiled_sql_calls) if options.runtime_above.presence > 0
+      profiled_sql_calls = calls_above(profiled_sql_calls) if options.calls_above.presence > 0
+      profiled_sql_calls = sort(profiled_sql_calls, false)
 
       table = Terminal::Table.new do |t|
         t.headings = ['SQL Query', 'Count', 'Total Runtime (ms)', 'Average Runtime (ms)', 'Source']
 
-        instrumented_sql_calls.each_with_index do |row, index|
+        profiled_sql_calls.each_with_index do |row, index|
           chopped_sql       = wrap_text(row['sql'], sql_width)
           source_list       = wrap_list(row['runtimes'].map { |runtime| runtime[1] }.uniq, sql_width - 15)
           average_runtime   = row['average'].round(rounding)
@@ -200,13 +200,13 @@ module RuntimeProfiler
           end
 
           t.add_row []
-          t.add_separator if index < instrumented_sql_calls.size - 1
+          t.add_separator if index < profiled_sql_calls.size - 1
         end
       end
 
       puts
       puts
-      puts "\e[1mINSTRUMENTED SQL(s)\e[22m"
+      puts "\e[1mPROFILED SQL(s)\e[22m"
       puts
       puts table
     end
@@ -256,7 +256,7 @@ module RuntimeProfiler
     end
 
     def details_template_data
-      summary = data['instrumentation']['summary']
+      summary = data['profiling']['summary']
 
       template_data = [
         summary['total_runtime'] ? summary['total_runtime'].round(rounding) : 'n/a',

data/lib/runtime_profiler/version.rb

@@ -1,3 +1,3 @@
 module RuntimeProfiler
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runtime_profiler
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Wilfrido T. Nuqui Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2021-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,13 +199,13 @@ files:
 - lib/runtime_profiler/callbacks/action_controller.rb
 - lib/runtime_profiler/callbacks/active_record.rb
 - lib/runtime_profiler/cli.rb
+- lib/runtime_profiler/data.rb
 - lib/runtime_profiler/events/process_action_event.rb
 - lib/runtime_profiler/events/sql_event.rb
-- lib/runtime_profiler/instrumentation_data.rb
 - lib/runtime_profiler/profiler.rb
 - lib/runtime_profiler/text_report.rb
 - lib/runtime_profiler/version.rb
-- rp_view_only_methods_full_details.png
+- rp_view_command.png
 - runtime_profiler.gemspec
 homepage: http://www.github.com/wnuqui/runtime_profiler
 licenses: