rails_request_stats 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67a34ab4f6878674fdf3cf11c2b9129bd25d61fb
-  data.tar.gz: 1bd610a86b78aa721061c875d517057e9c43bfc5
+  metadata.gz: c2d27ad0c7ca09478c330b639daab0a4813a2256
+  data.tar.gz: 5265e09e5fa4c1b39f30d8232ffb2b544b1dec27
 SHA512:
-  metadata.gz: 46500b124a71c42c4ab0aa609eb004b090528be062ab12999c8db9e4141586dd2cdd6abc502c6fe5a399c2ca65f6e8c0ced702daf5fc4b2a4080232271b0304f
-  data.tar.gz: bb43c7e65b32142a7823acdf71999aef0d2e2d5aec8efeafbd3465bc201c5cb5bf3e5b59f3f473106f4ef35d10eec19b5f5d38df6a7954aef8ab1c3fece36c74
+  metadata.gz: f66bf947b48629445e225ae7ce1b43131e8d7d4e9d697d67a017422c8d9e4fad6cb567da2074ffd697d7ca5b5423a1aeef417dc3d01ed641a36405910ed1f94f
+  data.tar.gz: 5662c228ddbaa04ab9f45a7e35d5c5e0264f2b8302be7c0512b9021e9700aea0fd8c91a72fe65316f463653b35d02fabda3cec46d5e8b423ac9eb3343a476848

data/README.md

@@ -19,7 +19,7 @@ During development have you ever:
 `RailsRequestStats::NotificationSubscribers` when required will subscribe to the `sql.active_record`, `start_processing.action_controller`, and `process_action.action_controller` `ActionSupport::Notifications`.
 
  * The `sql.active_record` event allow us to count each SQL query that passes though ActiveRecord, which we count internally.
- * The `start_processing.action_controller` event allows us to clear iternal counts, as well as perform a `GC.start` and capturing the total number of objects residing in the `ObjectSpace`.
+ * The `start_processing.action_controller` event allows us to clear iternal counts, as well as perform a `GC.start` and capturing the count of objects residing in the `ObjectSpace`.
  * The `process_action.action_controller` event provides us runtime information along with identifying controller action details, we even determine the number of generated objects since the start of processing the action. At this point we are able to synthesis the query information and runtime information and store them internally in running collection of `RailsRequestStats::RequestStats` objects.
 
 **Note** the data collection is tracked and stored in class-level instance variables. Thus this is not threadsafe, as no concurrency mechanisms are used (i.e., mutex). For non-threaded and forking application servers this should be fine.
@@ -50,6 +50,21 @@ Finally when you exit the application's server, you should see a report of all t
 
 ## Customizing Outputs
 
+### Memory Stats
+By setting the following class variable within in an initializer (`./config/initializers/rails_request_stats.rb`):
+
+```ruby
+RailsRequestStats::Report.print_memory_stats = true
+```
+
+You can see the *generated objects* within the `ObjectSpace` for individual requests:
+
+```
+[RailsRequestStats] (AVG view_runtime: 93.7252ms | AVG db_runtime: 8.66075ms | AVG generated_object_count: 125282 | query_count: 8 | cached_query_count: 0 | generated_objects: {:total_generated_objects=>111878, :object=>921, :class=>35, :module=>0, :float=>0, :string=>49501, :regexp=>1556, :array=>17855, :hash=>2087, :struct=>103, :bignum=>0, :file=>0, :data=>37682, :match=>373, :complex=>0, :node=>1688, :iclass=>0})
+```
+
+### Override Reports
+
 You can manually override the output by monkey-patching in an initializer (`./config/initializers/rails_request_stats.rb`):
 
 ```ruby
@@ -81,4 +96,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/kevinj
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/rails_request_stats.rb

@@ -1,7 +1,4 @@
-require 'rails_request_stats/version'
-require 'rails_request_stats/request_stats'
-require 'rails_request_stats/report'
-require 'rails_request_stats/notification_subscribers'
+Dir.glob(File.dirname(__FILE__) + '/**/*.rb') { |file| require file }
 
 module RailsRequestStats
 end

data/lib/rails_request_stats/notification_subscribers.rb

@@ -3,17 +3,19 @@ module RailsRequestStats
     SCHEMA_NAME = 'SCHEMA'.freeze
     CACHE_NAME = 'CACHE'.freeze
 
-    attr_reader :query_count,
-                :cached_query_count,
-                :before_action_object_count,
-                :generated_object_count,
-                :requests
+    class << self
+      attr_accessor :query_count,
+                    :cached_query_count,
+                    :before_object_space,
+                    :after_object_space
+                    :requests
+    end
 
     def self.reset_counts
       @query_count = 0
       @cached_query_count = 0
-      @before_action_object_count = 0
-      @generated_object_count = 0
+      @before_object_space = {}
+      @after_object_space = {}
     end
     reset_counts
 
@@ -55,28 +57,29 @@ module RailsRequestStats
       reset_counts
 
       GC.start
-      @before_action_object_count = total_object_count
+      GC.disable
+
+      @before_object_space = ObjectSpace.count_objects(@before_object_space)
     end
 
     def self.handle_process_action_event(event)
-      @generated_object_count = total_object_count - @before_action_object_count
+      @after_object_space = ObjectSpace.count_objects(@after_object_space)
 
-      request_key = { action: event[:action], format: event[:format], method: event[:method], path: event[:path] }
+      GC.enable
 
+      request_key = { action: event[:action], format: event[:format], method: event[:method], path: event[:path] }
       request_stats = @requests[request_key] || RequestStats.new(request_key)
-      request_stats.add_stats(event[:view_runtime], event[:db_runtime], @query_count, @cached_query_count, @generated_object_count)
-
-      @requests[request_key] = request_stats
+      @requests[request_key] = request_stats.tap do |stats|
+        stats.add_database_query_stats(@query_count, @cached_query_count)
+        stats.add_object_space_stats(@before_object_space, @after_object_space)
+        stats.add_runtime_stats(event[:view_runtime], event[:db_runtime])
+      end
 
-      Rails.logger.info { Report.new(request_stats).report_text }
+      print_report(request_stats)
     end
 
-    class << self
-      private
-
-      def total_object_count
-        ObjectSpace.count_objects.select { |k, v| k.to_s.start_with?('T_') }.values.reduce(:+)
-      end
+    def self.print_report(request_stats)
+      Rails.logger.info { Report.new(request_stats).report_text }
     end
   end
 end

data/lib/rails_request_stats/report.rb

@@ -2,6 +2,11 @@ module RailsRequestStats
   class Report
     FORMAT_FLAG = '%g'.freeze
 
+    class << self
+      attr_accessor :print_memory_stats
+    end
+    self.print_memory_stats = false
+
     attr_reader :request_stats
 
     def initialize(request_stats)
@@ -9,60 +14,52 @@ module RailsRequestStats
     end
 
     def report_text
-      avg_view_runtime = "AVG view_runtime: #{format_number(avg_stat(:view_runtime))}ms"
-      avg_db_runtime = "AVG db_runtime: #{format_number(avg_stat(:db_runtime))}ms"
-      avg_generated_object_count = "AVG generated_object_count: #{format_number(avg_stat(:generated_object_count))}"
-      query_count = "query_count: #{format_number(last_stat(:query_count))}"
-      cached_query_count = "cached_query_count: #{format_number(last_stat(:cached_query_count))}"
+      avg_view_runtime = "AVG view_runtime: #{format_number(avg(runtime_stats.view_runtime_collection))}ms"
+      avg_db_runtime = "AVG db_runtime: #{format_number(avg(runtime_stats.db_runtime_collection))}ms"
+      avg_generated_object_count = "AVG generated_object_count: #{format_number(avg(object_space_stats.generated_object_count_collection))}"
+      query_count = "query_count: #{format_number(database_query_stats.query_count_collection.last)}"
+      cached_query_count = "cached_query_count: #{format_number(database_query_stats.cached_query_count_collection.last)}"
+      generated_objects = self.class.print_memory_stats ? "generated_objects: #{object_space_stats.last_stats_generated_objects}" : nil
 
-      "[RailsRequestStats] (#{[avg_view_runtime, avg_db_runtime, avg_generated_object_count, query_count, cached_query_count].join(' | ')})"
+      "[RailsRequestStats] (#{[avg_view_runtime, avg_db_runtime, avg_generated_object_count, query_count, cached_query_count, generated_objects].compact.join(' | ')})"
     end
 
     def exit_report_text
       controller_information = "[RailsRequestStats] #{@request_stats.action.upcase}:#{@request_stats.format} \"#{@request_stats.path}\""
-      avg_view_runtime = "AVG view_runtime: #{format_number(avg_stat(:view_runtime))}ms"
-      avg_db_runtime = "AVG db_runtime: #{format_number(avg_stat(:db_runtime))}ms"
-      avg_generated_object_count = "AVG generated_object_count: #{format_number(avg_stat(:generated_object_count))}"
-      min_query_count = "MIN query_count: #{format_number(min_stat(:query_count))}"
-      max_query_count = "MAX query_count: #{format_number(max_stat(:query_count))}"
-      request_count = "from #{format_number(count_stat(:view_runtime))} requests"
+      avg_view_runtime = "AVG view_runtime: #{format_number(avg(runtime_stats.view_runtime_collection))}ms"
+      avg_db_runtime = "AVG db_runtime: #{format_number(avg(runtime_stats.db_runtime_collection))}ms"
+      avg_generated_object_count = "AVG generated_object_count: #{format_number(avg(object_space_stats.generated_object_count_collection))}"
+      min_query_count = "MIN query_count: #{format_number(database_query_stats.query_count_collection.min)}"
+      max_query_count = "MAX query_count: #{format_number(database_query_stats.query_count_collection.max)}"
+      request_count = "from #{format_number(runtime_stats.view_runtime_collection.size)} requests"
 
       "#{controller_information} (#{[avg_view_runtime, avg_db_runtime, avg_generated_object_count, min_query_count, max_query_count].join(' | ')}) #{request_count}"
     end
 
-    def min_stat(category)
-      category_collection(category).min
+    def total(collection)
+      collection.reduce(:+)
     end
 
-    def max_stat(category)
-      category_collection(category).max
+    def avg(collection)
+      total(collection).to_f / collection.size
     end
 
-    def total_stat(category)
-      category_collection(category).reduce(:+)
-    end
-
-    def count_stat(category)
-      category_collection(category).size
-    end
+    private
 
-    def last_stat(category)
-      category_collection(category).last
+    def format_number(number)
+      format(FORMAT_FLAG, number || 0)
     end
 
-    def avg_stat(category)
-      total_stat(category).to_f / count_stat(category)
+    def database_query_stats
+      @database_query_stats ||= @request_stats.database_query_stats
     end
 
-    private
-
-    def format_number(number)
-      format(FORMAT_FLAG, number)
+    def object_space_stats
+      @object_space_stats ||= @request_stats.object_space_stats
     end
 
-    def category_collection(category)
-      collection_variable_name = "#{category}_collection"
-      @request_stats.public_send(collection_variable_name) if @request_stats.respond_to?(collection_variable_name)
+    def runtime_stats
+      @runtime_stats ||= @request_stats.runtime_stats
     end
   end
 end

data/lib/rails_request_stats/request_stats.rb

@@ -5,11 +5,9 @@ module RailsRequestStats
                 :method,
                 :path,
 
-                :view_runtime_collection,
-                :db_runtime_collection,
-                :query_count_collection,
-                :cached_query_count_collection,
-                :generated_object_count_collection
+                :database_query_stats,
+                :object_space_stats,
+                :runtime_stats
 
     def initialize(key)
       @action = key[:action]
@@ -17,19 +15,21 @@ module RailsRequestStats
       @method = key[:method]
       @path = key[:path]
 
-      @view_runtime_collection = []
-      @db_runtime_collection = []
-      @query_count_collection = []
-      @cached_query_count_collection = []
-      @generated_object_count_collection = []
+      @database_query_stats = Stats::DatabaseQueryStats.new
+      @object_space_stats = Stats::ObjectSpaceStats.new
+      @runtime_stats = Stats::RuntimeStats.new
     end
 
-    def add_stats(view_runtime, db_runtime, query_count, cached_query_count, generated_object_count)
-      @view_runtime_collection << view_runtime.to_f
-      @db_runtime_collection << db_runtime.to_f
-      @query_count_collection << query_count
-      @cached_query_count_collection << cached_query_count
-      @generated_object_count_collection << generated_object_count
+    def add_database_query_stats(query_count, cached_query_count)
+      @database_query_stats.add_stats(query_count, cached_query_count)
+    end
+
+    def add_object_space_stats(before_object_space, after_object_space)
+      @object_space_stats.add_stats(before_object_space, after_object_space)
+    end
+
+    def add_runtime_stats(view_runtime, db_runtime)
+      @runtime_stats.add_stats(view_runtime, db_runtime)
     end
   end
 end

data/lib/rails_request_stats/stats/database_query_stats.rb

@@ -0,0 +1,18 @@
+module RailsRequestStats
+  module Stats
+    class DatabaseQueryStats
+      attr_reader :query_count_collection,
+                  :cached_query_count_collection
+
+      def initialize
+        @query_count_collection = []
+        @cached_query_count_collection = []
+      end
+
+      def add_stats(query_count, cached_query_count)
+        @query_count_collection << query_count
+        @cached_query_count_collection << cached_query_count
+      end
+    end
+  end
+end

data/lib/rails_request_stats/stats/object_space_stats.rb

@@ -0,0 +1,89 @@
+module RailsRequestStats
+  module Stats
+    class ObjectSpaceStats
+      attr_reader :object_count_collection,
+                  :class_count_collection,
+                  :module_count_collection,
+                  :float_count_collection,
+                  :string_count_collection,
+                  :regexp_count_collection,
+                  :array_count_collection,
+                  :hash_count_collection,
+                  :struct_count_collection,
+                  :bignum_count_collection,
+                  :file_count_collection,
+                  :data_count_collection,
+                  :match_count_collection,
+                  :complex_count_collection,
+                  :node_count_collection,
+                  :iclass_count_collection,
+                  :generated_object_count_collection
+
+      def initialize
+        @object_count_collection = []
+        @class_count_collection = []
+        @module_count_collection = []
+        @float_count_collection = []
+        @string_count_collection = []
+        @regexp_count_collection = []
+        @array_count_collection = []
+        @hash_count_collection = []
+        @struct_count_collection = []
+        @bignum_count_collection = []
+        @file_count_collection = []
+        @data_count_collection = []
+        @match_count_collection = []
+        @complex_count_collection = []
+        @node_count_collection = []
+        @iclass_count_collection = []
+        @generated_object_count_collection = []
+      end
+
+      def add_stats(before_object_space, after_object_space)
+        @object_count_collection << after_object_space[:T_OBJECT] - before_object_space[:T_OBJECT]
+        @class_count_collection << after_object_space[:T_CLASS] - before_object_space[:T_CLASS]
+        @module_count_collection << after_object_space[:T_MODULE] - before_object_space[:T_MODULE]
+        @float_count_collection << after_object_space[:T_FLOAT] - before_object_space[:T_FLOAT]
+        @string_count_collection << after_object_space[:T_STRING] - before_object_space[:T_STRING]
+        @regexp_count_collection << after_object_space[:T_REGEXP] - before_object_space[:T_REGEXP]
+        @array_count_collection << after_object_space[:T_ARRAY] - before_object_space[:T_ARRAY]
+        @hash_count_collection << after_object_space[:T_HASH] - before_object_space[:T_HASH]
+        @struct_count_collection << after_object_space[:T_STRUCT] - before_object_space[:T_STRUCT]
+        @bignum_count_collection << after_object_space[:T_BIGNUM] - before_object_space[:T_BIGNUM]
+        @file_count_collection << after_object_space[:T_FILE] - before_object_space[:T_FILE]
+        @data_count_collection << after_object_space[:T_DATA] - before_object_space[:T_DATA]
+        @match_count_collection << after_object_space[:T_MATCH] - before_object_space[:T_MATCH]
+        @complex_count_collection << after_object_space[:T_COMPLEX] - before_object_space[:T_COMPLEX]
+        @node_count_collection << after_object_space[:T_NODE] - before_object_space[:T_NODE]
+        @iclass_count_collection << after_object_space[:T_ICLASS] - before_object_space[:T_ICLASS]
+        @generated_object_count_collection << total_object_space_count(after_object_space) - total_object_space_count(before_object_space)
+      end
+
+      def total_object_space_count(object_space)
+        object_space.select { |k, v| k.to_s.start_with?('T_') }.values.reduce(:+)
+      end
+
+      def last_stats_generated_objects
+        {
+          total_generated_objects: generated_object_count_collection.last,
+          object: object_count_collection.last,
+          class: class_count_collection.last,
+          module: module_count_collection.last,
+          float: float_count_collection.last,
+          string: string_count_collection.last,
+          regexp: regexp_count_collection.last,
+          array: array_count_collection.last,
+          hash: hash_count_collection.last,
+          struct: struct_count_collection.last,
+          bignum: bignum_count_collection.last,
+          file: file_count_collection.last,
+          data: data_count_collection.last,
+          match: match_count_collection.last,
+          complex: complex_count_collection.last,
+          node: node_count_collection.last,
+          iclass: iclass_count_collection.last
+        }
+      end
+    end
+  end
+end

data/lib/rails_request_stats/stats/runtime_stats.rb

@@ -0,0 +1,18 @@
+module RailsRequestStats
+  module Stats
+    class RuntimeStats
+      attr_reader :view_runtime_collection,
+                  :db_runtime_collection
+
+      def initialize
+        @view_runtime_collection = []
+        @db_runtime_collection = []
+      end
+
+      def add_stats(view_runtime, db_runtime)
+        @view_runtime_collection << view_runtime
+        @db_runtime_collection << db_runtime
+      end
+    end
+  end
+end

data/lib/rails_request_stats/version.rb

@@ -1,3 +1,3 @@
 module RailsRequestStats
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_request_stats
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kevin Jalbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,9 @@ files:
 - lib/rails_request_stats/notification_subscribers.rb
 - lib/rails_request_stats/report.rb
 - lib/rails_request_stats/request_stats.rb
+- lib/rails_request_stats/stats/database_query_stats.rb
+- lib/rails_request_stats/stats/object_space_stats.rb
+- lib/rails_request_stats/stats/runtime_stats.rb
 - lib/rails_request_stats/version.rb
 - rails_request_stats.gemspec
 homepage: https://github.com/kevinjalbert/rails_request_stats/