rails_request_stats 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2d27ad0c7ca09478c330b639daab0a4813a2256
-  data.tar.gz: 5265e09e5fa4c1b39f30d8232ffb2b544b1dec27
+  metadata.gz: ab69ce19ea59ef2b15b17bc12415087f6a16ece0
+  data.tar.gz: 4c556b965584ba9b96000acbe57b1c22868e01fa
 SHA512:
-  metadata.gz: f66bf947b48629445e225ae7ce1b43131e8d7d4e9d697d67a017422c8d9e4fad6cb567da2074ffd697d7ca5b5423a1aeef417dc3d01ed641a36405910ed1f94f
-  data.tar.gz: 5662c228ddbaa04ab9f45a7e35d5c5e0264f2b8302be7c0512b9021e9700aea0fd8c91a72fe65316f463653b35d02fabda3cec46d5e8b423ac9eb3343a476848
+  metadata.gz: f2266f9d67a4425d725f2d427743091cffd71648c132502c2d64cbcf190f8b52e6dc952cf45772632bf5b67e3cf000133bdd4abfc097a8be71d7ea25fce230ab
+  data.tar.gz: ddb528f614494ed89034524c498694415d42c432c89633e139ae9e12fa761cfb13e6ad1484553b2cd791dd9b37c27616ed49097892d9eefcc81992fc215ca9e9

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 2.2.3
 before_install: gem install bundler -v 1.10.6
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rails_request_stats.gemspec
-gemspec
+group :test do
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+end
 
-gem 'codeclimate-test-reporter', group: :test, require: nil
+gemspec

data/README.md

@@ -19,6 +19,8 @@ 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 `cache_read.active_support` event allows us to count each read and hit to the Rails cache.
+ * The `cache_fetch_hit.active_support` event allows us to count the cache hits to the Rails cache when using *fetch*.
  * 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.
 
@@ -37,10 +39,10 @@ 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 | AVG generated_object_count: 14523 | 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 | cache_read_count: 3 | cache_hit_count: 3)
 ```
 
-Finally when you exit the application's server, you should see a report of all the data captured:
+Finally when you exit the application's server, you should see a summary report of all the data captured:
 
 ```
 [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
@@ -60,7 +62,7 @@ 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})
+[RailsRequestStats] (AVG view_runtime: 93.7252ms | AVG db_runtime: 8.66075ms | AVG generated_object_count: 125282 | query_count: 8 | cached_query_count: 0 | cache_read_count: 3 | cache_hit_count: 3 | 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

data/lib/rails_request_stats/notification_subscribers.rb

@@ -6,14 +6,18 @@ module RailsRequestStats
     class << self
       attr_accessor :query_count,
                     :cached_query_count,
+                    :cache_read_count,
+                    :cache_hit_count,
                     :before_object_space,
-                    :after_object_space
+                    :after_object_space,
                     :requests
     end
 
     def self.reset_counts
       @query_count = 0
       @cached_query_count = 0
+      @cache_read_count = 0
+      @cache_hit_count = 0
       @before_object_space = {}
       @after_object_space = {}
     end
@@ -40,12 +44,29 @@ module RailsRequestStats
       handle_process_action_event(args.extract_options!)
     end
 
+    ActiveSupport::Notifications.subscribe('cache_read.active_support') do |*args|
+      handle_cache_read_event(args.extract_options!)
+    end
+
+    ActiveSupport::Notifications.subscribe('cache_fetch_hit.active_support') do |*args|
+      handle_cache_fetch_hit_event(args.extract_options!)
+    end
+
     def self.at_exit_handler
       @requests.each_value do |request_stats|
         Rails.logger.info { Report.new(request_stats).exit_report_text }
       end
     end
 
+    def self.handle_cache_read_event(event)
+      @cache_read_count += 1
+      @cache_hit_count += 1 if event.fetch(:hit, false)
+    end
+
+    def self.handle_cache_fetch_hit_event(event)
+      @cache_hit_count += 1
+    end
+
     def self.handle_sql_event(event)
       return if event[:name] == SCHEMA_NAME
 
@@ -70,6 +91,7 @@ module RailsRequestStats
       request_key = { action: event[:action], format: event[:format], method: event[:method], path: event[:path] }
       request_stats = @requests[request_key] || RequestStats.new(request_key)
       @requests[request_key] = request_stats.tap do |stats|
+        stats.add_cache_stats(@cache_read_count, @cache_hit_count)
         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])

data/lib/rails_request_stats/report.rb

@@ -19,9 +19,11 @@ module RailsRequestStats
       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)}"
+      cache_read_count = "cache_read_count: #{format_number(cache_stats.cache_read_count_collection.last)}"
+      cache_hit_count = "cache_hit_count: #{format_number(cache_stats.cache_hit_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, generated_objects].compact.join(' | ')})"
+      "[RailsRequestStats] (#{[avg_view_runtime, avg_db_runtime, avg_generated_object_count, query_count, cached_query_count, cache_read_count, cache_hit_count, generated_objects].compact.join(' | ')})"
     end
 
     def exit_report_text
@@ -61,5 +63,9 @@ module RailsRequestStats
     def runtime_stats
       @runtime_stats ||= @request_stats.runtime_stats
     end
+
+    def cache_stats
+      @cache_stats ||= @request_stats.cache_stats
+    end
   end
 end

data/lib/rails_request_stats/request_stats.rb

@@ -7,7 +7,8 @@ module RailsRequestStats
 
                 :database_query_stats,
                 :object_space_stats,
-                :runtime_stats
+                :runtime_stats,
+                :cache_stats
 
     def initialize(key)
       @action = key[:action]
@@ -18,6 +19,7 @@ module RailsRequestStats
       @database_query_stats = Stats::DatabaseQueryStats.new
       @object_space_stats = Stats::ObjectSpaceStats.new
       @runtime_stats = Stats::RuntimeStats.new
+      @cache_stats = Stats::CacheStats.new
     end
 
     def add_database_query_stats(query_count, cached_query_count)
@@ -31,5 +33,9 @@ module RailsRequestStats
     def add_runtime_stats(view_runtime, db_runtime)
       @runtime_stats.add_stats(view_runtime, db_runtime)
     end
+
+    def add_cache_stats(cache_read_count, cache_hit_count)
+      @cache_stats.add_stats(cache_read_count, cache_hit_count)
+    end
   end
 end

data/lib/rails_request_stats/stats/cache_stats.rb

@@ -0,0 +1,18 @@
+module RailsRequestStats
+  module Stats
+    class CacheStats
+      attr_reader :cache_read_count_collection
+      attr_reader :cache_hit_count_collection
+
+      def initialize
+        @cache_read_count_collection = []
+        @cache_hit_count_collection = []
+      end
+
+      def add_stats(cache_read_count, cache_hit_count)
+        @cache_read_count_collection << cache_read_count
+        @cache_hit_count_collection << cache_hit_count
+      end
+    end
+  end
+end

data/lib/rails_request_stats/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_request_stats
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Jalbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ 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/cache_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
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides additional development statistics on Rails requests in logfile