query_tracer 0.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.gem

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/README.markdown

@@ -0,0 +1,54 @@
+# QueryTracer
+
+* https://github.com/daemon/query_tracer
+
+## DESCRIPTION
+
+QueryTracer is designed to log where from queries to DB were made.
+
+## Origins
+
+Original code was built for Scribd by Dmitry Shteflyuk.
+
+## TODO
+
+Rewrite SQL queries adding small trace as a comment. It will show where long running queries came from.
+
+## Usage
+
+Add following code to config/initializers/query_tracer.rb:
+
+    QueryTracer::Configuration.set do |tracer|
+      tracer.enabled = true
+      tracer.colorize = true
+      tracer.show_revision = true
+      tracer.multiline = true
+      tracer.skip_queries = [%r{FROM sqlite_master}]
+    end
+
+    QueryTracer::Logger.attach_to :active_record
+    
+`skip_queries` will merge one/many regexps into default expressions list (QueryTracer::Tracer::EXCLUDE_SQL) for current DB.
+
+## Example
+
+Let's say we have model
+
+    class User < ActiveRecord::Base
+      scope :active, where(:active => true)
+      
+      def self.traceme
+        active.to_a
+      end
+    end
+
+Invoking `User.traceme` will produce in logs:
+
+      SQL (0.9ms)   SELECT name
+     FROM sqlite_master
+     WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+    
+      User Load (25.8ms)  SELECT "users".* FROM "users" WHERE "users"."active" = 't'
+    ^^^^ Called from: Rev[d11816c90c2a38dcd866b115ed2ffa28d7d84e2c]
+    -> /Users/dm/Projects/tmp/loggertest/app/models/user.rb:5:in `traceme'
+    -> (irb):1:in `irb_binding'

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require "bundler"
+  Bundler.setup
+rescue LoadError
+  $stderr.puts "You need to have Bundler installed to be able build this gem."
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end

data/lib/query_tracer/configuration.rb

@@ -0,0 +1,32 @@
+module QueryTracer
+  class Configuration
+    
+    class << self
+      
+      attr_accessor :show_revision, :enabled, :colorize
+      attr_accessor :multiline, :log_level
+    
+      def set
+        db_adapter = ActiveRecord::Base.connection.adapter_name.capitalize
+        begin
+          QueryTracer::Tracer::EXCLUDE_SQL << QueryTracer::Db.const_get(db_adapter)::SKIP_QUERIES
+          QueryTracer::Tracer::EXCLUDE_SQL.flatten!
+        rescue
+        end
+        
+        yield self
+      end
+      
+      def log_level
+        @log_level || :debug
+      end
+      
+      def skip_queries=(val)
+        QueryTracer::Tracer::EXCLUDE_SQL << val
+        QueryTracer::Tracer::EXCLUDE_SQL.flatten!
+      end
+      
+    end
+      
+  end
+end

data/lib/query_tracer/db/mysql.rb

@@ -0,0 +1,11 @@
+module QueryTracer
+  module Db
+    module Mysql
+      SKIP_QUERIES = [%r{^(SET|SHOW)}]
+      
+      def execute_with_trace(sql)
+        
+      end
+    end
+  end
+end

data/lib/query_tracer/db/sqlite.rb

@@ -0,0 +1,11 @@
+module QueryTracer
+  module Db
+    module Sqlite
+      SKIP_QUERIES = [%r{FROM sqlite_master}]
+      
+      def execute_with_trace(sql)
+        
+      end
+    end
+  end
+end

data/lib/query_tracer/db.rb

@@ -0,0 +1,7 @@
+require 'query_tracer/db/mysql'
+require 'query_tracer/db/sqlite'
+
+module QueryTracer
+  module Db
+  end
+end

data/lib/query_tracer/logger.rb

@@ -0,0 +1,32 @@
+require 'active_record/log_subscriber'
+
+require 'query_tracer/configuration'
+require 'query_tracer/tracer'
+
+module QueryTracer
+
+  class Logger < ActiveSupport::LogSubscriber
+    # event.payload[:name]
+    # event.duration
+    # event.payload[:sql]
+    def sql(event)
+      return unless Configuration.enabled
+      
+      sql = event.payload[:sql]
+      # Skip noisy queries
+      trace = Tracer.build_trace(sql)
+      return if trace.blank?
+      # We're done
+      if Configuration.colorize
+        message = "\e[34m\e[43m^^^^ Called from:\e[0m "
+        indent = "\e[34m\e[43m->\e[0m "
+      else
+        message = '^^^^ Called from: '
+        indent = " "
+      end
+      logger.send QueryTracer::Configuration.log_level.to_sym, message + trace.join("\n#{indent}")
+    end
+  end
+end
+
+

data/lib/query_tracer/tracer/revision.rb

@@ -0,0 +1,36 @@
+module QueryTracer
+  module Tracer
+
+    module Revision
+      # Detect the current code revision and memoize it for the future.
+      def self.current
+        return nil unless QueryTracer::Configuration.show_revision
+        
+        begin
+          # Do we have the code revision memoized?
+          unless defined?(@@current_code_revision)
+            @@current_code_revision = if File.exists?("#{Rails.root}/REVISION")
+              # Capistrano-deployed application, we know where to get current revision
+              File.read("#{Rails.root}/REVISION").chomp.strip
+            else
+              # Try to use git
+              rev = `git rev-parse HEAD 2>/dev/null`.chomp.strip
+              rev.empty? ? nil : rev
+            end
+          end
+        rescue
+          nil
+        end
+        humanized_revision
+      end
+      
+      def self.humanized_revision
+        if @@current_code_revision
+          "Rev[#{@@current_code_revision}]"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/query_tracer/tracer.rb

@@ -0,0 +1,50 @@
+require 'query_tracer/configuration'
+require 'query_tracer/tracer/revision'
+
+module QueryTracer
+  module Tracer
+    extend self
+    
+    INCLUDE_CODEPOINTS = [
+      %r{^#{Rails.root}/(app/presenters/.*)},
+      %r{^#{Rails.root}/(app/views/.*)},
+      %r{^#{Rails.root}/(app/controllers/.*)},
+      %r{^#{Rails.root}/(app/models/.*)},
+      %r{^#{Rails.root}/(lib/.*)},
+      %r{^#{Rails.root}/(spec/.*)},
+      %r{^#{Rails.root}/(app/.*)},
+      %r{^#{Rails.root}/(vendor/(?:gems|plugins)/.*)},
+      %r{^#{Rails.root}/(.*)},
+      %r{in `(irb)_binding'}
+    ]
+    # A regular expression used to skip certain code points (gems that do nothing
+    # but add noice to the result).
+    EXCLUDE_CODEPOINT = %r{^(#{Rails.root}/(?:vendor/(?:rails|gems/(?:composite_primary_keys|db-charmer)|plugins/(?:paginating_find|acts_as_sluggable))|config/initializers/mysql_adapter_extensions\.rb|tmp/gems|lib/query_tracer))|\.rvm/|/gems/}
+    # A regular expression to exclude certain SQL queries from processing (who cares
+    # where SHOW TABLES was issues from).
+    EXCLUDE_SQL = []
+
+    def build_trace(sql)
+      unless skip_query?(sql)
+        # Skip noisy codepoints
+        lines = caller.inject([]) do |filtered, line|
+          unless line =~ EXCLUDE_CODEPOINT
+            filtered << line unless INCLUDE_CODEPOINTS.select{ |expr| line =~ expr }.blank?
+          end
+          filtered
+        end
+        
+        unless lines.blank?
+          lines = lines.first unless QueryTracer::Configuration.multiline
+          [QueryTracer::Tracer::Revision.current, lines].flatten
+        end
+        
+      end
+    end
+
+    def skip_query?(sql)
+      !EXCLUDE_SQL.select { |expr| sql =~ expr }.blank?
+    end
+
+  end
+end

data/lib/query_tracer.rb

@@ -0,0 +1,4 @@
+require 'query_tracer/configuration'
+require 'query_tracer/tracer'
+require 'query_tracer/logger'
+require 'query_tracer/db'

data/query_tracer.gemspec

@@ -0,0 +1,30 @@
+# coding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name              = "query_tracer"
+  s.version           = "0.0.2"
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ["Dmitry Shaposhnik", "Dmytro Shteflyuk"]
+  s.email             = ["dmitry@shaposhnik.name", "kpumuk@kpumuk.info"]
+  s.homepage          = "http://github.com/daemon/query_tracer"
+  s.summary           = "Query tracer and logger for Rails3"
+  s.description       = ""
+
+  s.required_rubygems_version = ">= 1.3.6"
+  
+  # If you have runtime dependencies, add them here
+  # s.add_runtime_dependency "other", "~> 1.2"
+  
+  # If you have development dependencies, add them here
+  # s.add_development_dependency "another", "= 0.9"
+
+  # The list of files to be contained in the gem
+  s.files         = `git ls-files`.split("\n")
+  # s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  # s.extensions    = `git ls-files ext/extconf.rb`.split("\n")
+  
+  s.require_path = 'lib'
+
+  # For C extensions
+  # s.extensions = "ext/extconf.rb"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: query_tracer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dmitry Shaposhnik
+- Dmytro Shteflyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: 
+- dmitry@shaposhnik.name
+- kpumuk@kpumuk.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/query_tracer.rb
+- lib/query_tracer/configuration.rb
+- lib/query_tracer/db.rb
+- lib/query_tracer/db/mysql.rb
+- lib/query_tracer/db/sqlite.rb
+- lib/query_tracer/logger.rb
+- lib/query_tracer/tracer.rb
+- lib/query_tracer/tracer/revision.rb
+- query_tracer.gemspec
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/daemon/query_tracer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Query tracer and logger for Rails3
+test_files: []
+