sql-query-stats 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f34e686dad58a5034ac7bd019b30ff9e027f059
+  data.tar.gz: 66544a00fce3bc8135305f6ee1a5efa9a95b1c06
+SHA512:
+  metadata.gz: 97ed4062d6795a9a258e415d3cd803ba1bbb446a3ea0087ecaee8f5ff06c9a923840342fde5ef400b8edf45ad7c598888b0718bb56433ddae7cc7bed7e4a4a0d
+  data.tar.gz: cef95d9dccfa2d765c6ad4da0067de440689e42adc84927c981109c6918b513288e56816b8f6630b850dfff42cc9715b902001f9bee09c415074542badc400d4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ben Barber
+
+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,29 @@
+# SqlQueryStats
+
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sql-query-stats'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sql_query_stats
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SqlQueryStats'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/sql_query_stats.rb

@@ -0,0 +1,4 @@
+require 'sql_query_stats/version'
+require 'sql_query_stats/reporter'
+require 'sql_query_stats/controller_runtime'
+require 'sql_query_stats/initializer'

data/lib/sql_query_stats/controller_runtime.rb

@@ -0,0 +1,40 @@
+module SqlQueryStats
+  # SqlQueryStats Controler Runtime
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    protected
+
+    def process_action(action, *args)
+      Reporter.reset
+      super
+    end
+
+    def append_info_to_payload(payload)
+      super
+      payload[:sql_query_stats] = Reporter.reset if ActiveRecord::Base.connected?
+    end
+
+    # Add QueryStats to the Rails Process Action log
+    module ClassMethods
+      def log_process_action(payload)
+        messages = super
+        exclusions = %i[total_duration]
+        stats = payload[:sql_query_stats].with_indifferent_access
+
+        stats.except(*exclusions).each do |stat, value|
+          messages << formatted_message(stat, value)
+        end
+
+        messages
+      end
+
+      private
+
+      def formatted_message(stat, value)
+        value = "#{value}ms" if stat.end_with? 'duration'
+        "#{stat.to_s.camelize}: #{value}"
+      end
+    end
+  end
+end

data/lib/sql_query_stats/initializer.rb

@@ -0,0 +1,14 @@
+module SqlQueryStats
+  # QueryStats Initializer
+  class Initializer < Rails::Railtie
+    initializer 'sql_query_stats.initialize' do
+      # Attach to the reporter ActiveRecord Events
+      SqlQueryStats::Reporter.attach_to :active_record
+
+      # Load the controller runtime
+      ActiveSupport.on_load(:action_controller) do
+        include SqlQueryStats::ControllerRuntime
+      end
+    end
+  end
+end

data/lib/sql_query_stats/reporter.rb

@@ -0,0 +1,62 @@
+module SqlQueryStats
+  # SqlQueryStats Reporter
+  class Reporter < ActiveSupport::LogSubscriber
+    attr_accessor :stats
+
+    DEFAULTS = {
+      total_queries: 0,
+      total_duration: 0,
+      query_cache_used: 0,
+      slowest_query: '',
+      slowest_query_duration: 0
+    }.freeze
+
+    def self.reset
+      stats = Thread.current['sql_query_stats']
+      Thread.current['sql_query_stats'] = DEFAULTS.dup
+      stats
+    end
+
+    def initialize
+      super
+    end
+
+    def log(key, value)
+      Thread.current['sql_query_stats'][key] = value
+    end
+
+    def stats
+      Thread.current['sql_query_stats'] ||= DEFAULTS.dup
+    end
+
+    def sql(event)
+      log(:total_queries, stats[:total_queries] + 1)
+      log(:total_duration, (stats[:total_duration] + event.duration).round(1))
+
+      check_cache_used(event)
+      check_slowest_query(event)
+    end
+
+    private
+
+    def check_cache_used(event)
+      return unless event.payload[:cached]
+      log(:query_cache_used, stats[:query_cache_used] + 1)
+    end
+
+    def check_slowest_query(event)
+      reportable_queries = %w[INSERT SELECT UPDATE]
+      return unless event.duration > stats[:slowest_query_duration]
+      return unless event.payload[:sql].start_with?(*reportable_queries)
+
+      report_slowest_query(event)
+    end
+
+    def report_slowest_query(event)
+      duration = stats[:slowest_query_duration] + event.duration
+
+      log(:slowest_query, event.payload[:sql])
+      log(:slowest_query_duration, duration.round(1))
+    end
+  end
+end

data/lib/sql_query_stats/version.rb

@@ -0,0 +1,3 @@
+module SqlQueryStats
+  VERSION = '0.1.1'.freeze
+end

data/lib/tasks/sql_query_stats_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sql_query_stats do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sql-query-stats
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ben Barber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: SqlQueryStats
+email:
+- contact@benbarber.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/sql_query_stats.rb
+- lib/sql_query_stats/controller_runtime.rb
+- lib/sql_query_stats/initializer.rb
+- lib/sql_query_stats/reporter.rb
+- lib/sql_query_stats/version.rb
+- lib/tasks/sql_query_stats_tasks.rake
+homepage: https://github.com/benbarber/sql-query-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.6.11
+signing_key: 
+specification_version: 4
+summary: Get more information from ActiveRecord
+test_files: []