sql_tracker 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8d236c5adb10928d77ae8547ab0a88fffe16c4c
-  data.tar.gz: af52c90be114c030abbe35ee5c4babda01b4a21f
+  metadata.gz: 65a35dfb502edde6f30c4f342ea42e3d118f7459
+  data.tar.gz: bf16c892168e7df593c3812352d53aefea633172
 SHA512:
-  metadata.gz: d0231bef73e7f00395eebc0afce207544cade7bd702b57abeea697ffd9dbd9da0b4cb4d42023b85b4a91d2d8c3044a936ffbbee720b59266b0e023cb5c0a08f3
-  data.tar.gz: b41ac6f658f2dfcd9ebeab95bd694c998e8cf6a4d8ec5753564088af0110b918efa437a66fbd4687df206369d5a53927c266427f6c91ea9fbcdfed29eebd762a
+  metadata.gz: deacfae440353615e04f3b88acd48c8e0ea38754f694b2cab0eec0946b878c7e6b338e830d955501e5f905d3fece5a5c726604534d9b7814dca5350dd9e45e9f
+  data.tar.gz: d57bc72264b859df7d681f371507c82c19e121f71ba49fb6df5dac99ad27535adbf4f0fe2b37d8cea64475c57613ffd042bad8c367aca658cf778b77ef6a78e2

data/README.md

@@ -36,6 +36,28 @@ To generate report, run
 ```bash
 sql_tracker tmp/sql_tracker-*.json
 ```
+The output report looks like this:
+```
+==================================
+Total Unique SQL Queries: 24
+==================================
+Count | Avg Time (ms)   | SQL Query                                                                                                 | Source
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+8     | 0.33            | SELECT `users`.* FROM `users` WHERE `users`.`id` = xxx LIMIT 1                                            | app/controllers/users_controller.rb:125:in `create'
+      |                 |                                                                                                           | app/controllers/projects_controller.rb:9:in `block in update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+4     | 0.27            | SELECT `projects`.* FROM `projects` WHERE `projects`.`user_id` = xxx AND `projects`.`id` = xxx LIMIT 1    | app/controllers/projects_controller.rb:4:in `update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+2     | 0.27            | UPDATE `projects` SET `updated_at` = xxx WHERE `projects`.`id` = xxx                                      | app/controllers/projects_controller.rb:9:in `block in update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+2     | 1.76            | SELECT projects.* FROM projects WHERE projects.priority BETWEEN xxx AND xxx ORDER BY created_at DESC      | app/controllers/projects_controller.rb:35:in `index'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+... ...
+```
+By default, the report will be sorted by the total count of each query, you can also choose to sort it by average duration:
+```bash
+sql_tracker tmp/sql_tracker-*.json --sort-by=duration
+```
 
 ## Configurations
 

data/bin/sql_tracker

@@ -1,6 +1,24 @@
 #!/usr/bin/env ruby
 require 'sql_tracker/report'
 require 'json'
+require 'optparse'
+
+options = {}
+
+parser = OptionParser.new(ARGV) do |o|
+  o.banner = 'Usage: sql_tracker [file.json]+ [--sort-by=COLUMN]'
+
+  o.on('-s', '--sort-by COLUMN', 'The name of column that is used for sorting the table. Options: count, duration') do |arg|
+    options[:sort_by] = arg if %(count duration).include?(arg)
+  end
+end
+
+parser.parse!
+parser.abort(parser.help) if ARGV.empty?
+
+default_options = { sort_by: 'count' }
+
+options = default_options.merge(options)
 
 reports = []
 until ARGV.empty?
@@ -23,4 +41,4 @@ if reports.empty?
 end
 
 report = reports.inject(:+)
-report.print_text
+report.print_text(options)

data/lib/sql_tracker/handler.rb

@@ -47,9 +47,12 @@ module SqlTracker
 
     def clean_sql_query(query)
       query.squish!
-      query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|\w+)/, '\1xxx')
+      query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|[\$\+\-\w\.]+)/, '\1xxx')
       query.gsub!(/(\sIN\s)\([^\(\)]+\)/i, '\1(xxx)')
-      query.gsub!(/(\sBETWEEN\s)('[^']+'|\w+)(\sAND\s)('[^']+'|\w+)/i, '\1xxx\3xxx')
+      query.gsub!(/(\sBETWEEN\s)('[^']+'|[\+\-\w\.]+)(\sAND\s)('[^']+'|[\+\-\w\.]+)/i, '\1xxx\3xxx')
+      query.gsub!(/(\sVALUES\s)\(.+\)/i, '\1(xxx)')
+      query.gsub!(/(\s(LIKE|ILIKE|SIMILAR TO|NOT SIMILAR TO)\s)('[^']+')/i, '\1xxx')
+      query.gsub!(/(\s(LIMIT|OFFSET)\s)(\d+)/i, '\1xxx')
       query
     end
 

data/lib/sql_tracker/report.rb

@@ -25,7 +25,8 @@ module SqlTracker
       raw_data['data']
     end
 
-    def print_text(f = STDOUT)
+    def print_text(options)
+      f = STDOUT
       f.puts '=================================='
       f.puts "Total Unique SQL Queries: #{data.keys.size}"
       f.puts '=================================='
@@ -35,7 +36,8 @@ module SqlTracker
       )
       f.puts '-' * terminal_width
 
-      data.values.sort_by { |d| -d['count'] }.each do |row|
+      sorted_data = sort_data(data.values, options[:sort_by])
+      sorted_data.each do |row|
         chopped_sql = wrap_text(row['sql'], sql_width)
         source_list = wrap_list(row['source'].uniq, sql_width - 10)
         avg_duration = row['duration'].to_f / row['count']
@@ -50,15 +52,26 @@ module SqlTracker
           duration = line == 0 ? avg_duration.round(2) : ''
           source = source_list.length > line ? source_list[line] : ''
           query = row['sql'].length > line ? chopped_sql[line] : ''
-          f.printf(
-            "%-#{count_width}s | %-#{duration_width}s | %-#{sql_width}s | %-#{sql_width}s\n",
-            count, duration, query, source
-          )
+          f.printf(row_format, count, duration, query, source)
         end
         f.puts '-' * terminal_width
       end
     end
 
+    def row_format
+      "%-#{count_width}s | %-#{duration_width}s | %-#{sql_width}s | %-#{sql_width}s\n"
+    end
+
+    def sort_data(data, sort_by)
+      data.sort_by do |d|
+        if sort_by == 'duration'
+          -d['duration'].to_f / d['count']
+        else
+          -d['count']
+        end
+      end
+    end
+
     def +(other)
       unless self.class == other.class
         raise ArgumentError, "cannot combine #{other.class}"

data/lib/sql_tracker/version.rb

@@ -1,3 +1,3 @@
 module SqlTracker
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracker
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Steven Yue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler