sql-query-stats 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7692004539df5eed7b13007df62d3e752f6778
-  data.tar.gz: cab8f10e73ac705769e88dd6b56eb8e4757bf812
+  metadata.gz: 758d6da7e1b474b3ebf8a4f2c503cc04c8bad54e
+  data.tar.gz: 3f44ed27eb85b672c5dc2d091ccbc47c07a82087
 SHA512:
-  metadata.gz: fe01cd7895e29430a6ad57e3cd7cf3243535879302ee09f69cc6bd09b2a4440cc900a51eb7f2d3ec3955dc897050a4b86423254d45c1327027ee25ba3097e26a
-  data.tar.gz: f6c56df6cfa41aa4a58f4ef97331f73c42a43f67a2329bfcdc1f01ba526335d7a619a4976d5c54807974a4ced82e3c2d5bce124340b9a0d19578bf18aaec81cd
+  metadata.gz: 7380a3115576183c475e2a4e4ca805b74719f94e32e66ce4decd88fe0366fa0673d51a192eb7a0c37eba7e5a98b3647b813e26c56467ca4e3e3491338770caaa
+  data.tar.gz: d448e35d1edc60dcfd13754093b2ad26732b19b72216640e113daf87ef3505e4aead84e92de67ae329e2fe216aa7cf5026a25011ccb18935a6ff0a0e8b523c78

data/README.md

@@ -1,11 +1,16 @@
-# SqlQueryStats
+# Sql Query Stats
 
-Short description and motivation.
+This Gem adds some useful SQL query stats to your Rails logs.
 
-## Usage
-How to use my plugin.
+#### Reported stats include
 
-## Installation
+* Query count
+* Query cache used
+* Slowest query
+* Slowest query duration
+* Total query duration
+
+## Installation & usage
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -19,11 +24,8 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install sql_query_stats
+$ 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/lib/sql-query-stats.rb

@@ -2,3 +2,4 @@ require 'sql_query_stats/version'
 require 'sql_query_stats/reporter'
 require 'sql_query_stats/controller_runtime'
 require 'sql_query_stats/initializer'
+require 'sql_query_stats/sanitizer'

data/lib/sql_query_stats/reporter.rb

@@ -45,7 +45,7 @@ module SqlQueryStats
     end
 
     def check_slowest_query(event)
-      reportable_queries = %w[INSERT SELECT UPDATE]
+      reportable_queries = %w[SELECT INSERT UPDATE]
       return unless event.duration > stats[:slowest_query_duration]
       return unless event.payload[:sql].start_with?(*reportable_queries)
 
@@ -55,7 +55,7 @@ module SqlQueryStats
     def report_slowest_query(event)
       duration = stats[:slowest_query_duration] + event.duration
 
-      log(:slowest_query, event.payload[:sql])
+      log(:slowest_query, Sanitizer.sanitize(event.payload[:sql]))
       log(:slowest_query_duration, duration.round(1))
     end
   end

data/lib/sql_query_stats/sanitizer.rb

@@ -0,0 +1,27 @@
+module SqlQueryStats
+  # SqlQueryStats Sanitizer
+  class Sanitizer
+    def self.sanitize(sql_query_string)
+      filters = Rails.application.config.filter_parameters
+      sql = sql_query_string.dup
+      sql = filter_params(filters, sql)
+      filter_values(sql)
+    end
+
+    def self.filter_params(filters, sql)
+      filters.each do |filter|
+        sql.gsub!(/`#{filter}` = '[^']+'/, "#{filter} = '[FILTERED]'")
+      end
+
+      sql
+    end
+
+    def self.filter_values(sql)
+      sql.scan(/(?:VALUES(?:\s?)\()(.*)(?:\)+)/) do |value|
+        sql.gsub!(/#{value}/, "'[FILTERED]'")
+      end
+
+      sql
+    end
+  end
+end

data/lib/sql_query_stats/version.rb

@@ -1,3 +1,3 @@
 module SqlQueryStats
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql-query-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ben Barber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,7 +38,10 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: SqlQueryStats
+description: |-
+  Adds some useful SQL query stats to your Rails logs, \
+                     reported stats include, query count, slowest query and \
+                     slowest query duration
 email:
 - contact@benbarber.co.uk
 executables: []
@@ -52,6 +55,7 @@ files:
 - lib/sql_query_stats/controller_runtime.rb
 - lib/sql_query_stats/initializer.rb
 - lib/sql_query_stats/reporter.rb
+- lib/sql_query_stats/sanitizer.rb
 - lib/sql_query_stats/version.rb
 - lib/tasks/sql_query_stats_tasks.rake
 homepage: https://github.com/benbarber/sql-query-stats
@@ -77,5 +81,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Get more information from ActiveRecord
+summary: Adds some useful SQL query stats to your Rails logs.
 test_files: []