sql-logging 3.0.1

data/README.rdoc

@@ -0,0 +1,69 @@
+= SQL Logging
+
+The SQL Logging gem adds useful SQL debugging tools to ActiveRecord. The gem
+is a repackaging of the old SQL Logging plug-in for Rails 2.x. It, in turn,
+was based on ideas and plug-ins from Adam Doppelt's (standard logging
+enhancements) and Nathaniel Talbott (the QueryTrace plug-in).
+
+This gem is for Rails 3 only. It supports MySQL (including the mysql2 gem),
+PostgreSQL and SQLite.
+
+== Usage
+
+Once installed, the out-of-the-box behavior gives you:
+
+* A cleaned-up backtrace after every SQL query, so you know exactly what
+  piece of code triggered the query.
+* A report of the number of rows and rough count of bytes returned after
+  each query.
+* After each request completes, additional summary information telling you
+  the number of statements executed, as well as a rough total number of
+  bytes received from the database.
+* A top 10 list of SQL executions, sorted by total execution time (based on
+  the location of the query in code), including the total number of rows
+  and bytes returned over all executions.
+
+All of this additional information is logged at DEBUG level, so it won't
+clutter up your production log files.
+
+== Options
+
+The Top 10 summary provides the most options to customize its behavior.
+
+If you want more or fewer than 10 queries, you can easily change that:
+
+  SqlLogging::Statistics.top_sql_queries = 5
+
+If you want the sorted by something other than the total execution time,
+you can instead sort by the median execution time, number of executions
+or rows/bytes returned over all executions of the query:
+
+  SqlLogging::Statistics.show_top_sql_queries = :median_time
+  SqlLogging::Statistics.show_top_sql_queries = :queries
+  SqlLogging::Statistics.show_top_sql_queries = :rows
+  SqlLogging::Statistics.show_top_sql_queries = :bytes
+
+You can also turn the list off entirely:
+
+  SqlLogging::Statistics.show_top_sql_queries = false
+
+If you don't want to see query backtraces:
+
+  SqlLogging::Statistics.show_sql_backtrace = false
+
+= Acknowledgments
+
+Adam's post describing his logging improvements is at
+http://gurge.com/blog/2006/11/09/rails-sql-logging-improvements/.
+
+Nathaniel's QueryTrace is available at
+http://terralien.com/projects/querytrace/.
+
+= Contact
+
+Feedback and/or patches to make this gem better are greatly appreciated!
+
+Steve Madsen
+Light Year Software, LLC
+http://lightyearsoftware.com
+steve@lightyearsoftware.com

data/lib/sql-logging.rb

@@ -0,0 +1 @@
+require 'sql-logging/railtie'

data/lib/sql-logging/adapters/mysql.rb

@@ -0,0 +1,15 @@
+require 'active_record/connection_adapters/mysql_adapter'
+
+class ActiveRecord::ConnectionAdapters::MysqlAdapter
+  def select_with_sql_logging(sql, name = nil)
+    rows = nil
+    elapsed = Benchmark.measure do
+      rows = select_without_sql_logging(sql, name)
+    end
+    msec = elapsed.real * 1000
+    SqlLogging::Statistics.record_query(sql, name, msec, rows)
+    rows
+  end
+  
+  alias_method_chain :select, :sql_logging
+end

data/lib/sql-logging/adapters/mysql2.rb

@@ -0,0 +1,15 @@
+require 'active_record/connection_adapters/mysql2_adapter'
+
+class ActiveRecord::ConnectionAdapters::Mysql2Adapter
+  def select_with_sql_logging(sql, name = nil)
+    rows = nil
+    elapsed = Benchmark.measure do
+      rows = select_without_sql_logging(sql, name)
+    end
+    msec = elapsed.real * 1000
+    SqlLogging::Statistics.record_query(sql, name, msec, rows)
+    rows
+  end
+  
+  alias_method_chain :select, :sql_logging
+end

data/lib/sql-logging/adapters/postgresql.rb

@@ -0,0 +1,19 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
+class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+  def execute_with_sql_logging(sql, name = nil)
+    result = nil
+    elapsed = Benchmark.measure do
+      result = execute_without_sql_logging(sql, name)
+    end
+    msec = elapsed.real * 1000
+    if result.respond_to?(:rows)
+      SqlLogging::Statistics.record_query(sql, name, msec, result.rows)
+    else
+      SqlLogging::Statistics.record_query(sql, name, msec, result)
+    end
+    result
+  end
+  
+  alias_method_chain :execute, :sql_logging
+end

data/lib/sql-logging/adapters/sqlite.rb

@@ -0,0 +1,13 @@
+class ActiveRecord::ConnectionAdapters::SQLiteAdapter
+  def execute_with_sql_logging(sql, name = nil)
+    res = nil
+    elapsed = Benchmark.measure do
+      res = execute_without_sql_logging(sql, name)
+    end
+    msec = elapsed.real * 1000
+    SqlLogging::Statistics.record_query(sql, name, msec, res)
+    res
+  end
+
+  alias_method_chain :execute, :sql_logging
+end

data/lib/sql-logging/adapters/sqlite3.rb

@@ -0,0 +1 @@
+require 'sql-logging/adapters/sqlite'

data/lib/sql-logging/controller_runtime.rb

@@ -0,0 +1,14 @@
+module SqlLogging
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+  protected
+
+    module ClassMethods
+      def log_process_action(payload)
+        SqlLogging::Statistics.log_report
+        super
+      end
+    end
+  end
+end

data/lib/sql-logging/logged_query.rb

@@ -0,0 +1,50 @@
+class LoggedQuery
+  attr_accessor :sql, :name, :backtrace, :queries, :rows, :bytes
+  
+  def initialize(sql, name, backtrace)
+    @sql = sql
+    @name = name
+    @backtrace = backtrace
+    @queries = 0
+    @rows = 0
+    @bytes = 0
+    @times = []
+  end
+  
+  def log_query(rows, bytes, time)
+    @queries += 1
+    @rows += rows
+    @bytes += bytes
+    @times << time
+  end
+  
+  def [](key)
+    case key.to_sym
+    when :sql: @sql
+    when :name: @name
+    when :backtrace: @backtrace
+    when :queries: @queries
+    when :rows: @rows
+    when :bytes: @bytes
+    when :median_time: median_time
+    when :total_time: total_time
+    else nil
+    end
+  end
+  
+  def median_time
+    total_time / @times.length
+  end
+  
+  def min_time
+    @times.min
+  end
+  
+  def max_time
+    @times.max
+  end
+  
+  def total_time
+    @times.inject(0) { |sum, time| sum += time }
+  end
+end

data/lib/sql-logging/railtie.rb

@@ -0,0 +1,33 @@
+require 'sql-logging/statistics'
+require 'rails'
+require 'active_record'
+
+module SqlLogging
+  class Railtie < Rails::Railtie
+    initializer 'sql_logging.load_adapter_extensions' do
+      ActiveSupport.on_load(:active_record, :after => 'active_record.initialize_database') do
+        adapter = ActiveRecord::Base.configurations[Rails.env]['adapter']
+        begin
+          require "sql-logging/adapters/#{adapter}"
+        rescue LoadError => e
+          Rails.logger.warn "SQL Logging extensions are not available for #{adapter}; functionality will be limited"
+        end
+      end
+    end
+    
+    initializer 'sql_logging.reset_statistics' do
+      ActiveSupport.on_load(:active_record) do
+        ActionDispatch::Callbacks.before do
+          SqlLogging::Statistics.reset_statistics!
+        end
+      end
+    end
+
+    initializer 'sql_logging.log_runtime' do
+      require "sql-logging/controller_runtime"
+      ActiveSupport.on_load(:action_controller) do
+        include SqlLogging::ControllerRuntime
+      end
+    end
+  end
+end

data/lib/sql-logging/statistics.rb

@@ -0,0 +1,103 @@
+require 'sql-logging/logged_query'
+
+module SqlLogging
+  class Helper
+    include Singleton
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::NumberHelper
+  end
+  
+  class Statistics
+    @@show_sql_backtrace = true
+    @@show_top_sql_queries = :total_time
+    @@top_sql_queries = 10
+  
+    cattr_accessor :show_sql_backtrace, :top_sql_queries
+  
+    def self.show_top_sql_queries
+      @@show_top_sql_queries
+    end
+  
+    def self.show_top_sql_queries=(value)
+      unless [ false, :rows, :queries, :bytes, :total_time, :median_time ].include?(value)
+        raise ArgumentError, "show_top_sql_queries must be one of false, :rows, :queries, :bytes, :total_time or :median_time"
+      end
+    
+      @@show_top_sql_queries = value
+    end
+
+    def self.reset_statistics!
+      @@queries = @@bytes = @@rows = 0
+      @@top_queries = {}
+    end
+  
+    @@backtrace_cleaner = Rails.backtrace_cleaner.dup
+    @@backtrace_cleaner.add_silencer { |line| line =~ %r{sql-logging/lib} }
+  
+    def self.record_query(sql, name, msec, result)
+      unless name.blank? || name =~ / Columns$/ || name == :skip_logging
+        bytes = 0
+        if result.nil?
+          ntuples = 0
+        else
+          result.each do |row|
+            row.each do |key, value|
+              bytes += key.size if key && key.respond_to?(:size)
+              bytes += value.size if value && value.respond_to?(:size)
+            end
+          end if result.respond_to?(:each)
+          ntuples = 0
+          if result.respond_to?(:length)
+            ntuples = result.length
+          elsif result.respond_to?(:num_rows)
+            ntuples = result.num_rows
+          elsif result.respond_to?(:ntuples)
+            ntuples = result.ntuples
+          end
+        end
+      
+        @@queries += 1
+        @@rows += ntuples
+        @@bytes += bytes
+
+        backtrace = @@backtrace_cleaner.clean(caller).join("\n    ")
+        unless @@show_top_sql_queries == false
+          key = "#{name}:#{backtrace}"
+          unless query = @@top_queries[key]
+            query = LoggedQuery.new(sql, name, backtrace)
+            @@top_queries[key] = query
+          end
+          query.log_query(ntuples || 0, bytes || 0, msec)
+        end
+
+        Rails.logger.debug "    #{helper.pluralize(ntuples, 'row')}, #{helper.number_to_human_size(bytes)}"
+        Rails.logger.debug "    #{backtrace}" if @@show_sql_backtrace
+      end
+    end
+  
+    def self.log_report
+      Rails.logger.debug "SQL Logging: #{helper.pluralize(@@queries, 'statement')} executed, returning #{helper.number_to_human_size(@@bytes)}"
+    
+      unless @@show_top_sql_queries == false
+        Rails.logger.debug "Top #{@@top_sql_queries} SQL executions:"
+        sorted_keys = @@top_queries.keys.sort_by { |k| @@top_queries[k][@@show_top_sql_queries] }.reverse
+        sorted_keys.slice(0..@@top_sql_queries).each do |key|
+          query = @@top_queries[key]
+          Rails.logger.debug "  Executed #{helper.pluralize(query.queries, 'time')} in #{'%.1f' % query.total_time}ms " +
+            "(#{'%.1f' % query.min_time}/#{'%.1f' % query.median_time}/#{'%.1f' % query.max_time}ms min/median/max), " +
+            "returning #{helper.pluralize(query.rows, 'row')} " +
+            "(#{helper.number_to_human_size(query.bytes)}):\n" +
+            "    #{query.name}\n" +
+            "    First exec was: #{query.sql}\n" +
+            "    #{query.backtrace}"
+        end
+      end
+    end
+  
+    protected
+  
+    def self.helper
+      Helper.instance
+    end
+  end
+end

data/lib/sql-logging/version.rb

@@ -0,0 +1,3 @@
+module SqlLogging
+  VERSION = '3.0.1'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: sql-logging
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 1
+  version: 3.0.1
+platform: ruby
+authors: 
+- Steve Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Adds SQL analysis and debugging info to Rails 3 apps.
+email: steve@lightyearsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/sql-logging/adapters/mysql.rb
+- lib/sql-logging/adapters/mysql2.rb
+- lib/sql-logging/adapters/postgresql.rb
+- lib/sql-logging/adapters/sqlite.rb
+- lib/sql-logging/adapters/sqlite3.rb
+- lib/sql-logging/controller_runtime.rb
+- lib/sql-logging/logged_query.rb
+- lib/sql-logging/railtie.rb
+- lib/sql-logging/statistics.rb
+- lib/sql-logging/version.rb
+- lib/sql-logging.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/lightyear/sql-logging
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds SQL analysis and debugging info to Rails 3 apps.
+test_files: []
+