tatyree-query-analyzer 0.1.0

data/README.rdoc

@@ -0,0 +1,108 @@
+= Query Analyzer Plugin for MySQL on Rails
+
+A gem version of the Query Analyzer plugin. Modified by Todd Tyree.
+
+MODIFIED by John Eberly originally take from http://svn.nfectio.us
+
+The Query Analyzer plugin will expand the usability of your log files
+by providing query analysis using the MySQL query execution plan. Each SQL
+select query will be 'EXPLAIN'ed and added to the log files right below
+the original query.
+
+Using this plugin and a good understanding of the results, you will be 
+able to analyze and optimize the queries your application is making.
+
+Refer to http://www.mysql.org/doc/refman/5.0/en/explain.html for more
+information on understanding the results. 
+
+= Compatibility 
+
+It only works with MySQL at the moment. 
+
+= Installation
+
+  sudo gem install git://github.com/tatyree/query-analyzer.git
+  
+In your environment.rb, *after* the Rails::Initializer block:
+
+  require 'query_analyzer'
+  
+*NOTE THE UNDERSCORE!* +require 'query-analyzer'+ won't find it. 
+
+= Example Use
+
+Here is a real life usage of the plugin that detected the omission of indexes on
+a table. In this case, it was a join table and the keys didn't have indexes (silly me!).
+Names have been changed to protect the innocent (and make it fit 80 columns)
+
+  # development.log
+
+  P Load (0.008669)
+   => SELECT p.* FROM p INNER JOIN d ON p.id = d.p_id WHERE (d.p_id = 2 AND ((d.type = 'P'))) 
+
+  Analyzing P Load
+   
+  select_type | key_len | type   | Extra       | id | possible_keys | rows | table  | ref    | key    
+  ----------------------------------------------------------------------------------------------------
+  SIMPLE      |         | ALL    | Using where | 1  |               | 74   |    d   |        |        
+  SIMPLE      | 4       | eq_ref | Using where | 1  | PRIMARY       | 1    |    p   | d.p_id | PRIMARY
+
+
+= Analyze the results
+
+Looking at the results of the execution plan, we can see that the lookup in
+the d table is missing an index (possible_keys=null) and performed a full 
+table scan (type=ALL) to satisfy the WHERE condition. In this case, there was only one 
+row that matched the condition in the table, but MySQL still had to search all 74 rows 
+in the table to find it, a key indicator of a missing
+or malformed index(es). Once it has pulled all the records to satisfy the WHERE, it then
+starts the p table join. This time, it was able to match d.p_id to p.id using
+the PRIMARY key on the p table. The type=eq_ref indicates a 1 to 1 match against a primary 
+or unique column.
+
+Lets add some indexes to the join table and see if we can cut that full table scan down in the
+number of rows it needs to search.
+
+  #> script/generate Migration AddIndexesToD
+
+  # file: 005_add_indexes_to_d
+  class AddIndexesToD < ActiveRecord::Migration
+    def self.up
+      add_index :d, [ :p_id, :type ]
+      add_index :d, :type
+    end
+
+    def self.remove
+      remove_index :d, [ :p_id, :type ]
+      remove_index :d, :type  
+    end
+  end
+
+
+Now that we have an index on the foreign_key column and type, lets re-run the query and
+see if we got rid of that full table scan.
+
+  # development.log
+
+  P Load (0.009011)   
+   => SELECT p.* FROM p INNER JOIN d ON p.id = d.p_id WHERE (d.p_id = 2 AND ((d.type = 'P'))) 
+
+  Analyzing P Load
+   
+  select_type | key_len | type   | Extra       | id | possible_keys                  | rows | table | ref    | key                             
+  ------------------------------------------------------------------------------------------------------------------------------
+  SIMPLE      | 255     | ref    | Using where | 1  | d_p_id_type_index,d_type_index | 1    |   d   | const  | d_p_id_type_index
+  SIMPLE      | 4       | eq_ref | Using where | 1  | PRIMARY                        | 1    |   p   | d.p_id | PRIMARY                         
+
+Okay. Now MySQL is using an index satisfy the WHERE condition. Using the index, it was able to
+find the single row that matched, preventing the full table scan.
+
+
+Credits:
+The extension of the Array class for printing the columnized records was originally
+written by Peter Cooper who adapted it from Courtenay from #caboose.
+
+http://www.rubyinside.com/columnized-text-datasets-in-rails-71.html
+http://habtm.com/articles/2006/06/10/pretty-tables-for-ruby-objects
+
+Released under the MIT license (download your own if you need it)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('query-analyzer', '0.1.0') do |p|
+  p.description    = "Run explain on all the sql queries rails generates."
+  p.url            = "http://github.com/tatyree/cookieless_sessions"
+  p.author         = "John Eberly and Todd Tyree"
+  p.email          = "todd@snappl.co.uk"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/init.rb

@@ -0,0 +1 @@
+require 'query_analyzer'

data/lib/query_analyzer.rb

@@ -0,0 +1,56 @@
+class Array
+  protected
+    def qa_columnized_row(fields, sized)
+      row = []
+      fields.each_with_index do |f, i|
+        row << sprintf("%0-#{sized[i]}s", f.to_s)
+      end
+      row.join(' | ')
+    end
+
+  public
+
+  def qa_columnized
+    sized = {}
+    self.each do |row|
+      row.values.each_with_index do |value, i|
+        sized[i] = [sized[i].to_i, row.keys[i].length, value.to_s.length].max
+      end
+    end
+
+    table = []
+    table << qa_columnized_row(self.first.keys, sized)
+    table << '-' * table.first.length
+    self.each { |row| table << qa_columnized_row(row.values, sized) }
+    table.join("\n   ") # Spaces added to work with format_log_entry
+  end
+end
+
+
+# TODO: Postgres? Oracle? Firebird? 
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter < AbstractAdapter
+      private
+        alias_method :select_without_analyzer, :select
+        
+        def select(sql, name = nil)
+          query_results = select_without_analyzer(sql, name)
+          
+          # I went back to showing all queries.  This makes for a heavy log file, but you pick up 
+          # things like filesorts (which the latest plugin wouldn't have caught).
+          
+          if @logger and @logger.level == Logger::DEBUG
+            @logger.debug(
+              ActiveRecord::Base.silence do
+                format_log_entry("\033[1;34mAnalyzing #{name}  \033[0m\n\n",
+                  "\033[1;34m#{select_without_analyzer("explain #{sql}", name).qa_columnized}  \033[0m\n\n"
+                ) 
+              end
+            ) if sql =~ /^select/i
+          end          
+          query_results
+        end
+    end
+  end
+end

data/query-analyzer.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{query-analyzer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Eberly and Todd Tyree"]
+  s.date = %q{2009-02-07}
+  s.description = %q{Run explain on all the sql queries rails generates.}
+  s.email = %q{todd@snappl.co.uk}
+  s.extra_rdoc_files = ["lib/query_analyzer.rb", "README.rdoc"]
+  s.files = ["init.rb", "lib/query_analyzer.rb", "Rakefile", "README.rdoc", "Manifest", "query-analyzer.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tatyree/cookieless_sessions}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Query-analyzer", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{query-analyzer}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Run explain on all the sql queries rails generates.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: tatyree-query-analyzer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Eberly and Todd Tyree
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Run explain on all the sql queries rails generates.
+email: todd@snappl.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/query_analyzer.rb
+- README.rdoc
+files: 
+- init.rb
+- lib/query_analyzer.rb
+- Rakefile
+- README.rdoc
+- Manifest
+- query-analyzer.gemspec
+has_rdoc: true
+homepage: http://github.com/tatyree/cookieless_sessions
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Query-analyzer
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: query-analyzer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Run explain on all the sql queries rails generates.
+test_files: []
+