sql_tracker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0e4058d31c7fa127cfe022ef763b942c8835187
+  data.tar.gz: e8ae58b2c8e734631444a810a8d780fa8e52f520
+SHA512:
+  metadata.gz: 2db4e2a2060c9fae17014d38d166d4fac55eeaa2c9377ddb64043abf81ef48bb793eefcdd4a826aad0fa755972d8a30d9542a6b6aec311f62cc76dc2efc6e8d3
+  data.tar.gz: ccdee35b3d94e968c541c827e7340bcd97542a4c060ca7800cf98c93512e1a7dc3349dad7993d985ff599c945f671db332c64758b672758560d073d40551b089

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steven Yue
+
+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,40 @@
+# Rails SQL Query Tracker
+
+`sql_tracker` tracks SQL queries by subscribing to Rails' `sql.active_record` event notifications.
+
+It then aggregates and generates report to give you insights about all the sql queries happened in your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  ... ...
+  gem 'sql_tracker'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Tracking
+
+To start tracking, simply start your rails application server. When your server is shutting down, `sql_tracker` will dump all the tracking data into one or more json file(s) under the `tmp` folder of your application.
+
+`sql_tracker` can also track sql queries when running rails tests (e.g. your controller or integration tests), it will dump the data after all the tests are finished.
+
+
+## Reporting
+
+To generate report, run
+```bash
+sql_tracker tmp/sql_tracker-*.json
+```
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sql_tracker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/sql_tracker

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'sql_tracker/report'
+require 'json'
+
+reports = []
+until ARGV.empty?
+  begin
+    file = ARGV.pop
+    report = SqlTracker::Report.new(JSON.load(IO.binread(file)))
+    if report.valid?
+      reports << report
+    else
+      STDOUT.puts "Skip incompatible file: #{file}"
+    end
+  rescue => e
+    STDERR.puts "Error when parsing #{file}: #{e.inspect}"
+  end
+end
+
+if reports.empty?
+  STDERR.puts 'Unable to find sql_tracker json dump to generate report'
+  exit
+end
+
+report = reports.inject(:+)
+report.print_text

data/lib/sql_tracker.rb

@@ -0,0 +1,20 @@
+require 'sql_tracker/config'
+require 'sql_tracker/handler'
+require 'sql_tracker/report'
+
+module SqlTracker
+  def self.initialize!
+    raise 'sql tracker initialized twice' if @already_initialized
+
+    config = SqlTracker::Config.apply_defaults
+    handler = SqlTracker::Handler.new(config)
+    ActiveSupport::Notifications.subscribe('sql.active_record', handler)
+    @already_initialized = true
+
+    at_exit { handler.save }
+  end
+end
+
+if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
+  require 'sql_tracker/railtie'
+end

data/lib/sql_tracker/config.rb

@@ -0,0 +1,17 @@
+require 'active_support/configurable'
+
+module SqlTracker
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :tracked_paths, :tracked_sql_command, :output_path
+
+    class << self
+      def apply_defaults
+        self.tracked_paths ||= %w(app lib)
+        self.tracked_sql_command ||= %w(SELECT INSERT UPDATE DELETE)
+        self.output_path ||= File.join(Rails.root.to_s, 'tmp')
+        self
+      end
+    end
+  end
+end

data/lib/sql_tracker/handler.rb

@@ -0,0 +1,87 @@
+require 'digest/md5'
+require 'json'
+require 'fileutils'
+
+module SqlTracker
+  class Handler
+    def initialize(config)
+      @config = config
+      @started_at = Time.now.to_s
+      @data = {} # {key: {sql:, count:, duration, source: []}, ...}
+    end
+
+    def call(name, started, finished, id, payload)
+      sql = payload[:sql]
+
+      return unless sql.start_with?(*@config.tracked_sql_command)
+
+      cleaned_trace = clean_trace(caller)
+      return if cleaned_trace.empty?
+
+      sql = clean_sql_query(sql)
+      duration = 1000.0 * (finished - started) # in milliseconds
+      sql_key = Digest::MD5.hexdigest(sql)
+
+      if @data.key?(sql_key)
+        update_data(sql_key, cleaned_trace, duration)
+      else
+        add_data(sql_key, sql, cleaned_trace, duration)
+      end
+    end
+
+    def clean_sql_query(query)
+      query.squish!
+      query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|\w+)/, '\1xxx')
+      query.gsub!(/(\sIN\s)\([^\(\)]+\)/, '\1(xxx)')
+      query.gsub!(/BETWEEN ('[^']+'|\w+) AND ('[^']+'|\w+)/, 'BETWEEN xxx AND xxx')
+      query
+    end
+
+    def clean_trace(trace)
+      if Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
+        Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
+      end
+
+      Rails.backtrace_cleaner.remove_silencers!
+      Rails.backtrace_cleaner.add_silencer do |line|
+        line !~ %r{^(#{@config.tracked_paths.join('|')})\/}
+      end
+      Rails.backtrace_cleaner.clean(trace)
+    end
+
+    def add_data(key, sql, trace, duration)
+      @data[key] = {}
+      @data[key][:sql] = sql
+      @data[key][:count] = 1
+      @data[key][:duration] = duration
+      @data[key][:source] = [trace.first]
+      @data
+    end
+
+    def update_data(key, trace, duration)
+      @data[key][:count] += 1
+      @data[key][:duration] += duration
+      @data[key][:source] << trace.first
+      @data
+    end
+
+    # save the data to file
+    def save
+      return if @data.empty?
+      output = {}
+      output[:data] = @data
+      output[:generated_at] = Time.now.to_s
+      output[:started_at] = @started_at
+      output[:format_version] = '1.0'
+      output[:rails_version] = Rails.version
+      output[:rails_path] = Rails.root.to_s
+
+      FileUtils.mkdir_p(@config.output_path)
+      filename = "sql_tracker-#{Process.pid}-#{Time.now.to_i}.json"
+
+      File.open(File.join(@config.output_path, filename), 'w') do |f|
+        f.write JSON.dump(output)
+      end
+    end
+  end
+end

data/lib/sql_tracker/railtie.rb

@@ -0,0 +1,7 @@
+module SqlTracker
+  class Railtie < ::Rails::Railtie
+    initializer 'sql_tracker.configure_rails_initialization' do
+      SqlTracker.initialize!
+    end
+  end
+end

data/lib/sql_tracker/report.rb

@@ -0,0 +1,140 @@
+module SqlTracker
+  class Report
+    attr_accessor :raw_data
+
+    def initialize(data)
+      self.raw_data = data
+    end
+
+    def valid?
+      return false unless raw_data.key?('format_version')
+      return false unless raw_data.key?('data')
+      return false if raw_data['data'].nil? || raw_data['data'].empty?
+      sample = raw_data['data'].values.first
+      %w(sql count source).each do |key|
+        return false unless sample.key?(key)
+      end
+      true
+    end
+
+    def version
+      raw_data['format_version']
+    end
+
+    def data
+      raw_data['data']
+    end
+
+    def print_text(f = STDOUT)
+      f.puts '=================================='
+      f.puts "Total Unique SQL Queries: #{data.keys.size}"
+      f.puts '=================================='
+      f.printf(
+        "%-#{count_width}s | %-#{duration_width}s | %-#{sql_width}s | Source\n",
+        'Count', 'Avg Time (ms)', 'SQL Query'
+      )
+      f.puts '-' * terminal_width
+
+      data.values.sort_by { |d| -d['count'] }.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']
+        total_lines = if chopped_sql.length >= source_list.length
+                        chopped_sql.length
+                      else
+                        source_list.length
+                      end
+
+        (0...total_lines).each do |line|
+          count = line == 0 ? row['count'].to_s : ''
+          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
+          )
+        end
+        f.puts '-' * terminal_width
+      end
+    end
+
+    def +(other)
+      unless self.class == other.class
+        raise ArgumentError, "cannot combine #{other.class}"
+      end
+      unless version == other.version
+        raise ArgumentError, "cannot combine v#{version} with v#{other.version}"
+      end
+
+      r1 = data
+      r2 = other.data
+
+      merged = (r1.keys + r2.keys).uniq.each_with_object({}) do |id, memo|
+        if !r1.key?(id)
+          memo[id] = r2[id]
+        elsif r2.key?(id)
+          memo[id] = r1[id]
+          memo[id]['count'] += r2[id]['count']
+          memo[id]['duration'] += r2[id]['duration']
+          memo[id]['source'] += r2[id]['source']
+        else
+          memo[id] = r1[id]
+        end
+      end
+      merged_data = { 'data' => merged, 'format_version' => version }
+
+      self.class.new(merged_data)
+    end
+
+    private
+
+    def wrap_text(text, width)
+      return [text] if text.length <= width
+      text.scan(/.{1,#{width}}/)
+    end
+
+    # an array of text
+    def wrap_list(list, width)
+      list.map do |text|
+        wrap_text(text, width)
+      end.flatten
+    end
+
+    def sql_width
+      @sql_width ||= (terminal_width - count_width - duration_width) / 2
+    end
+
+    def count_width
+      5
+    end
+
+    def duration_width
+      15
+    end
+
+    def terminal_width
+      @terminal_width ||= begin
+        result = unix? ? dynamic_width : 80
+        result < 10 ? 80 : result
+      end
+    end
+
+    def dynamic_width
+      @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
+    end
+
+    def dynamic_width_stty
+      `stty size 2>/dev/null`.split[1].to_i
+    end
+
+    def dynamic_width_tput
+      `tput cols 2>/dev/null`.to_i
+    end
+
+    def unix?
+      RUBY_PLATFORM =~
+        /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+    end
+  end
+end

data/lib/sql_tracker/version.rb

@@ -0,0 +1,3 @@
+module SqlTracker
+  VERSION = '1.0.0'.freeze
+end

data/sql_tracker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sql_tracker'
+  spec.version       = SqlTracker::VERSION
+  spec.authors       = ['Steven Yue']
+  spec.email         = ['jincheker@gmail.com']
+
+  spec.summary       = 'Rails SQL Query Tracker'
+  spec.description   = 'Track and analyze sql queries of your rails application'
+  spec.homepage      = 'http://www.github.com/steventen/sql_tracker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['sql_tracker']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'activesupport', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sql_tracker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steven Yue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Track and analyze sql queries of your rails application
+email:
+- jincheker@gmail.com
+executables:
+- sql_tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sql_tracker
+- lib/sql_tracker.rb
+- lib/sql_tracker/config.rb
+- lib/sql_tracker/handler.rb
+- lib/sql_tracker/railtie.rb
+- lib/sql_tracker/report.rb
+- lib/sql_tracker/version.rb
+- sql_tracker.gemspec
+homepage: http://www.github.com/steventen/sql_tracker
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails SQL Query Tracker
+test_files: []