rails_request_stats 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52c12f7e624aff9589705f54ebcfad9d0c5fd15f
-  data.tar.gz: e6db8268f92ac4ac512ce65c1afc51313e258bdd
+  metadata.gz: 67a34ab4f6878674fdf3cf11c2b9129bd25d61fb
+  data.tar.gz: 1bd610a86b78aa721061c875d517057e9c43bfc5
 SHA512:
-  metadata.gz: 13cb4c0e7dc4c68daeb10a9a3d72c6567c165f2bc993625c14e419a855edff4a26e0190ce315090401e8488d633b8ba8925dd08e9d9e092c9d3fa03b0fd1bfb3
-  data.tar.gz: c6b74a309ac574e97882025082ce093577ac80af69607ee76ab4ffd2a012fd3a61933f8e5c31d0d89269aba34c1d592a9888a20eec45ff1bd075dddf10a5de88
+  metadata.gz: 46500b124a71c42c4ab0aa609eb004b090528be062ab12999c8db9e4141586dd2cdd6abc502c6fe5a399c2ca65f6e8c0ced702daf5fc4b2a4080232271b0304f
+  data.tar.gz: bb43c7e65b32142a7823acdf71999aef0d2e2d5aec8efeafbd3465bc201c5cb5bf3e5b59f3f473106f4ef35d10eec19b5f5d38df6a7954aef8ab1c3fece36c74

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rails_request_stats.gemspec
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,5 +1,10 @@
 # RailsRequestStats
 
+[![Gem Version](https://badge.fury.io/rb/rails_request_stats.svg)](https://badge.fury.io/rb/rails_request_stats)
+[![Build Status](https://travis-ci.org/kevinjalbert/rails_request_stats.svg?branch=master)](https://travis-ci.org/kevinjalbert/rails_request_stats)
+[![Code Climate](https://codeclimate.com/github/kevinjalbert/rails_request_stats/badges/gpa.svg)](https://codeclimate.com/github/kevinjalbert/rails_request_stats)
+[![Test Coverage](https://codeclimate.com/github/kevinjalbert/rails_request_stats/badges/coverage.svg)](https://codeclimate.com/github/kevinjalbert/rails_request_stats/coverage)
+
 During development have you ever:
 
 * Wondered how many SQL queries occurred during a request?
@@ -11,9 +16,11 @@ During development have you ever:
 
 ## How this Works
 
-`RailsRequestStats::NotificationSubscribers` when required will subscribe to the `sql.active_record`, and `process_action.action_controller` `ActionSupport::Notifications`.
+`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 `process_action.action_controller` event provides us runtime information along with identifying controller action details. 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.
+ * 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 `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.
 
@@ -30,15 +37,15 @@ gem 'rails_request_stats', group: :development
 Within the console ./log/development.log you should start seeing the following statement appearing at the end of processing a request:
 
 ```
-[RailsRequestStats] (AVG view_runtime: 163.655ms | AVG db_runtime: 15.465ms | query_count: 9 | cached_query_count: 0)
+[RailsRequestStats] (AVG view_runtime: 163.655ms | AVG db_runtime: 15.465ms | AVG generated_object_count: 14523 | query_count: 9 | cached_query_count: 0)
 ```
 
 Finally when you exit the application's server, you should see a report of all the data captured:
 
 ```
-[RailsRequestStats] INDEX:html "/users" (AVG view_runtime: 128.492ms | AVG db_runtime: 9.186ms | MIN query_count: 8 | MAX query_count: 9) with 4 data points
-[RailsRequestStats] SHOW:html "/users/2" (AVG view_runtime: 13.0429ms | AVG db_runtime: 1.69033ms | MIN query_count: 2 | MAX query_count: 2) with 3 data points
-[RailsRequestStats] SHOW:html "/users/2?test=1&blah=2" (AVG view_runtime: 17.8252ms | AVG db_runtime: 1.621ms | MIN query_count: 2 | MAX query_count: 2) with 1 data points
+[RailsRequestStats] INDEX:html "/users" (AVG view_runtime: 128.492ms | AVG db_runtime: 9.186ms | AVG generated_object_count: 25529 | MIN query_count: 8 | MAX query_count: 9) from 4 requests
+[RailsRequestStats] SHOW:html "/users/2" (AVG view_runtime: 13.0429ms | AVG db_runtime: 1.69033ms | AVG generated_object_count: 14523 | MIN query_count: 2 | MAX query_count: 2) from 3 requests
+[RailsRequestStats] SHOW:html "/users/2?test=1&blah=2" (AVG view_runtime: 17.8252ms | AVG db_runtime: 1.621ms | AVG generated_object_count: 18511 | MIN query_count: 2 | MAX query_count: 2) from 1 requests
 ```
 
 ## Customizing Outputs

data/lib/rails_request_stats/notification_subscribers.rb

@@ -5,13 +5,17 @@ module RailsRequestStats
 
     attr_reader :query_count,
                 :cached_query_count,
+                :before_action_object_count,
+                :generated_object_count,
                 :requests
 
-    def self.reset_query_counts
+    def self.reset_counts
       @query_count = 0
       @cached_query_count = 0
+      @before_action_object_count = 0
+      @generated_object_count = 0
     end
-    reset_query_counts
+    reset_counts
 
     def self.reset_requests
       @requests = {}
@@ -26,6 +30,10 @@ module RailsRequestStats
       handle_sql_event(args.extract_options!)
     end
 
+    ActiveSupport::Notifications.subscribe('start_processing.action_controller') do |*args|
+      handle_start_processing_event(args.extract_options!)
+    end
+
     ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
       handle_process_action_event(args.extract_options!)
     end
@@ -43,16 +51,32 @@ module RailsRequestStats
       @query_count += 1
     end
 
+    def self.handle_start_processing_event(event)
+      reset_counts
+
+      GC.start
+      @before_action_object_count = total_object_count
+    end
+
     def self.handle_process_action_event(event)
+      @generated_object_count = total_object_count - @before_action_object_count
+
       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)
+      request_stats.add_stats(event[:view_runtime], event[:db_runtime], @query_count, @cached_query_count, @generated_object_count)
 
       @requests[request_key] = request_stats
-      reset_query_counts
 
       Rails.logger.info { Report.new(request_stats).report_text }
     end
+
+    class << self
+      private
+
+      def total_object_count
+        ObjectSpace.count_objects.select { |k, v| k.to_s.start_with?('T_') }.values.reduce(:+)
+      end
+    end
   end
 end

data/lib/rails_request_stats/report.rb

@@ -11,21 +11,23 @@ module RailsRequestStats
     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))}"
 
-      "[RailsRequestStats] (#{[avg_view_runtime, avg_db_runtime, query_count, cached_query_count].join(' | ')})"
+      "[RailsRequestStats] (#{[avg_view_runtime, avg_db_runtime, avg_generated_object_count, query_count, cached_query_count].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"
 
-      "#{controller_information} (#{[avg_view_runtime, avg_db_runtime, min_query_count, max_query_count].join(' | ')}) #{request_count}"
+      "#{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)

data/lib/rails_request_stats/request_stats.rb

@@ -8,7 +8,8 @@ module RailsRequestStats
                 :view_runtime_collection,
                 :db_runtime_collection,
                 :query_count_collection,
-                :cached_query_count_collection
+                :cached_query_count_collection,
+                :generated_object_count_collection
 
     def initialize(key)
       @action = key[:action]
@@ -20,13 +21,15 @@ module RailsRequestStats
       @db_runtime_collection = []
       @query_count_collection = []
       @cached_query_count_collection = []
+      @generated_object_count_collection = []
     end
 
-    def add_stats(view_runtime, db_runtime, query_count, cached_query_count)
+    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
     end
   end
 end

data/lib/rails_request_stats/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_request_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Jalbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Provides additional development statistics on Rails requests in logfile