rails_request_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52c12f7e624aff9589705f54ebcfad9d0c5fd15f
+  data.tar.gz: e6db8268f92ac4ac512ce65c1afc51313e258bdd
+SHA512:
+  metadata.gz: 13cb4c0e7dc4c68daeb10a9a3d72c6567c165f2bc993625c14e419a855edff4a26e0190ce315090401e8488d633b8ba8925dd08e9d9e092c9d3fa03b0fd1bfb3
+  data.tar.gz: c6b74a309ac574e97882025082ce093577ac80af69607ee76ab4ffd2a012fd3a61933f8e5c31d0d89269aba34c1d592a9888a20eec45ff1bd075dddf10a5de88

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_request_stats.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin Jalbert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# RailsRequestStats
+
+During development have you ever:
+
+* Wondered how many SQL queries occurred during a request?
+* Been curious on average view and database runtime for a request?
+* Wanted a report containing overall statistics of all unique requests?
+* Wanted a better way to iteratively optimize requests?
+
+`RailsRequestStats` provides a simple drop-in solution to expose more statistics on requests. New information is presented in your development logs, supplying you with the required information to iteratively optimize requests by noticing subtle changes in the number of queries and average runtimes.
+
+## How this Works
+
+`RailsRequestStats::NotificationSubscribers` when required will subscribe to the `sql.active_record`, 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.
+
+**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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_request_stats', group: :development
+```
+
+## Example Outputs
+
+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)
+```
+
+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
+```
+
+## Customizing Outputs
+
+You can manually override the output by monkey-patching in an initializer (`./config/initializers/rails_request_stats.rb`):
+
+```ruby
+module RailsRequestStats
+  class Report
+    # Called after every request
+    def report_text
+      # Access to @request_stats (instance of RequestStats)
+    end
+    # Called after the application server is closed (via #at_exit_handler)
+    def exit_report_text
+      # Access to @request_stats (instance of RequestStats)
+    end
+  end
+
+  class NotificationSubscribers
+    # Called when the application server is closed
+    def self.at_exit_handler
+      # Access to @requests (hash of { <paths> => RequestStats })
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kevinjalbert/rails_request_stats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rails_request_stats/notification_subscribers.rb

@@ -0,0 +1,58 @@
+module RailsRequestStats
+  class NotificationSubscribers
+    SCHEMA_NAME = 'SCHEMA'.freeze
+    CACHE_NAME = 'CACHE'.freeze
+
+    attr_reader :query_count,
+                :cached_query_count,
+                :requests
+
+    def self.reset_query_counts
+      @query_count = 0
+      @cached_query_count = 0
+    end
+    reset_query_counts
+
+    def self.reset_requests
+      @requests = {}
+    end
+    reset_requests
+
+    at_exit do
+      at_exit_handler
+    end
+
+    ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+      handle_sql_event(args.extract_options!)
+    end
+
+    ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
+      handle_process_action_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_sql_event(event)
+      return if event[:name] == SCHEMA_NAME
+
+      @cached_query_count += 1 if event[:name] == CACHE_NAME
+      @query_count += 1
+    end
+
+    def self.handle_process_action_event(event)
+      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)
+
+      @requests[request_key] = request_stats
+      reset_query_counts
+
+      Rails.logger.info { Report.new(request_stats).report_text }
+    end
+  end
+end

data/lib/rails_request_stats/report.rb

@@ -0,0 +1,66 @@
+module RailsRequestStats
+  class Report
+    FORMAT_FLAG = '%g'.freeze
+
+    attr_reader :request_stats
+
+    def initialize(request_stats)
+      @request_stats = request_stats
+    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"
+      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(' | ')})"
+    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"
+      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}"
+    end
+
+    def min_stat(category)
+      category_collection(category).min
+    end
+
+    def max_stat(category)
+      category_collection(category).max
+    end
+
+    def total_stat(category)
+      category_collection(category).reduce(:+)
+    end
+
+    def count_stat(category)
+      category_collection(category).size
+    end
+
+    def last_stat(category)
+      category_collection(category).last
+    end
+
+    def avg_stat(category)
+      total_stat(category).to_f / count_stat(category)
+    end
+
+    private
+
+    def format_number(number)
+      format(FORMAT_FLAG, number)
+    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)
+    end
+  end
+end

data/lib/rails_request_stats/request_stats.rb

@@ -0,0 +1,32 @@
+module RailsRequestStats
+  class RequestStats
+    attr_reader :action,
+                :format,
+                :method,
+                :path,
+
+                :view_runtime_collection,
+                :db_runtime_collection,
+                :query_count_collection,
+                :cached_query_count_collection
+
+    def initialize(key)
+      @action = key[:action]
+      @format = key[:format]
+      @method = key[:method]
+      @path = key[:path]
+
+      @view_runtime_collection = []
+      @db_runtime_collection = []
+      @query_count_collection = []
+      @cached_query_count_collection = []
+    end
+
+    def add_stats(view_runtime, db_runtime, query_count, cached_query_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
+    end
+  end
+end

data/lib/rails_request_stats/version.rb

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

data/lib/rails_request_stats.rb

@@ -0,0 +1,7 @@
+require 'rails_request_stats/version'
+require 'rails_request_stats/request_stats'
+require 'rails_request_stats/report'
+require 'rails_request_stats/notification_subscribers'
+
+module RailsRequestStats
+end

data/rails_request_stats.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_request_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_request_stats'
+  spec.version       = RailsRequestStats::VERSION
+  spec.authors       = ['Kevin Jalbert']
+  spec.email         = ['kevin.j.jalbert@gmail.com']
+
+  spec.summary       = 'Provides additional development statistics on Rails requests in logfile'
+  spec.description   = 'Provides additional development statistics on Rails requests in logfile'
+  spec.homepage      = 'https://github.com/kevinjalbert/rails_request_stats/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+
+  spec.add_runtime_dependency 'rails', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rails_request_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Jalbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Provides additional development statistics on Rails requests in logfile
+email:
+- kevin.j.jalbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_request_stats.rb
+- lib/rails_request_stats/notification_subscribers.rb
+- lib/rails_request_stats/report.rb
+- lib/rails_request_stats/request_stats.rb
+- lib/rails_request_stats/version.rb
+- rails_request_stats.gemspec
+homepage: https://github.com/kevinjalbert/rails_request_stats/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides additional development statistics on Rails requests in logfile
+test_files: []