vizjerai-query_trace 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Nathaniel Talbott. All Rights Reserved.
+
+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

@@ -0,0 +1,112 @@
+= QueryTrace plugin for Rails
+
+It's nice that ActiveRecord logs the queries that are performed when your actions are executed, 
+since it makes it easy to see when you have serious inefficiencies in your application. The next 
+question, though, is always, "OK, so where are those being run from?" Before QueryTrace, that 
+question could be a real pain to answer, since you'd have to go trawling through your code looking
+for the culprit. Once you have QueryTrace installed, though, your logs won't just tell you that you
+have a problem, they will pinpoint the location of that problem for you.
+
+== Usage
+
+Either install the QueryTrace as a plugin or as a gem. You can enable QueryTrace by setting the
+QUERY_TRACE environment variable like so:
+
+	QUERY_TRACE=true
+
+If you want QueryTrace to always be enabled, create a file in config/initializers, and add the
+following line:
+
+	QueryTrace.enable!
+	
+You can also turn QueryTrace back off at any time:
+
+  QueryTrace.disable!
+
+QueryTrace only outputs traces at the at the DEBUG log level, and honors your log colorization
+settings. By default, it outputs up to 20 lines of stack trace. You can adjust this with the depth
+accessor:
+
+  QueryTrace.depth = 5
+
+== Runtime Toggling of QueryTrace
+
+Starting with version 0.1.0 of QueryTrace, you can toggle tracing on or off without restarting the
+server (thanks to Doug Barth for implementing this). To do so, include QueryTrace in your environment so that
+it loads at server startup; you can use an initializer to set its initial state (on or off). Then just
+send SIGQUIT (CTRL-\) to your server to switch from enabled to disabled and vice versa.
+
+Important note: initializers load after environment.rb, but before environment-specific configuration
+files like development.rb. So make sure you have the QueryTrace gem loaded in environment.rb or 
+the runtime toggling will not work. You can use an initializer to selectively turn it on in
+development:
+
+QueryTrace.enable! if Rails.env.development?   
+
+== Example
+
+Before:
+
+  Schedule Load (0.023687)   SELECT * FROM schedules WHERE (schedules.id = 3) LIMIT 1
+  Resource Load (0.001076)   SELECT * FROM resources WHERE (resources.id = 328) LIMIT 1
+  Schedule Load (0.011488)   SELECT * FROM schedules WHERE (schedules.id = 3) LIMIT 1
+  Resource Load (0.022471)   SELECT * FROM resources WHERE (resources.id = 328) LIMIT 1
+
+
+After:
+
+  Schedule Load (0.023687)   SELECT * FROM schedules WHERE (schedules.id = 3) LIMIT 1
+    app/models/available_work.rb:50:in `study_method'
+    app/helpers/plan_helper.rb:4:in `work_description'
+    app/views/plan/_resource_schedule.rhtml:27:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_resource_schedule.rhtml:24:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_schedule_listing.rhtml:5:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:3:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:1:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/index.rhtml:6:in `_run_rhtml_plan_index'
+    vendor/plugins/textmate_footnotes/lib/textmate_footnotes.rb:60:in `render'
+  Resource Load (0.001076)   SELECT * FROM resources WHERE (resources.id = 328) LIMIT 1
+    app/models/available_work.rb:54:in `div_type'
+    app/helpers/plan_helper.rb:6:in `work_description'
+    app/views/plan/_resource_schedule.rhtml:27:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_resource_schedule.rhtml:24:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_schedule_listing.rhtml:5:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:3:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:1:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/index.rhtml:6:in `_run_rhtml_plan_index'
+    vendor/plugins/textmate_footnotes/lib/textmate_footnotes.rb:60:in `render'
+  Schedule Load (0.011488)   SELECT * FROM schedules WHERE (schedules.id = 3) LIMIT 1
+    app/models/available_work.rb:50:in `study_method'
+    app/helpers/plan_helper.rb:4:in `work_description'
+    app/views/plan/_resource_schedule.rhtml:27:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_resource_schedule.rhtml:24:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_schedule_listing.rhtml:5:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:3:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:1:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/index.rhtml:6:in `_run_rhtml_plan_index'
+    vendor/plugins/textmate_footnotes/lib/textmate_footnotes.rb:60:in `render'
+  Resource Load (0.022471)   SELECT * FROM resources WHERE (resources.id = 328) LIMIT 1
+    app/models/available_work.rb:54:in `div_type'
+    app/helpers/plan_helper.rb:6:in `work_description'
+    app/views/plan/_resource_schedule.rhtml:27:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_resource_schedule.rhtml:24:in `_run_rhtml_plan__resource_schedule'
+    app/views/plan/_schedule_listing.rhtml:5:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:3:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/_schedule_listing.rhtml:1:in `_run_rhtml_plan__schedule_listing'
+    app/views/plan/index.rhtml:6:in `_run_rhtml_plan_index'
+    vendor/plugins/textmate_footnotes/lib/textmate_footnotes.rb:60:in `render'
+
+
+== Additional Info
+
+Original Author: Nathaniel Talbott (for Terralien)
+Contact: nathaniel@talbott.ws
+License: MIT
+Home: http://github.com/ntalbott/query_trace/
+Subversion mirror: https://terralien.devguard.com/svn/projects/plugins/query_trace
+
+Current Author: Mike Gunderloy
+Contact: MikeG1@larkfarm.com
+Home: http://github.com/ffmike/query_trace, http://codaset.com/ffmike/query_trace
+
+Copyright (c) 2006 Nathaniel Talbott. All Rights Reserved.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+GEM_NAME = "vizjerai-query_trace"
+GEM_VERSION = "0.2.0"
+AUTHORS = ["Nathaniel Talbott", "Mike Gunderloy", "Andrew Assarattanakul"]
+EMAIL = "nathaniel@terralien.com"
+HOMEPAGE = "http://github.com/vizjerai/query_trace"
+SUMMARY = "Adds query origin tracing to your logs."
+DESCRIPTION = %q{With query_trace enabled, the Rails logs will contain a partial stack trace for every executed SQL statement, making it easier to find where they are generated in your code.}
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'query_trace'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = DESCRIPTION
+  s.authors = AUTHORS
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('activerecord')
+  s.require_path = 'lib'
+  s.files = %w(MIT-LICENSE README Rakefile init.rb) + Dir.glob("{lib}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/init.rb

@@ -0,0 +1,16 @@
+require 'query_trace'
+
+def status
+  QueryTrace.enabled? ? "enabled" : "disabled"
+end
+
+puts "=> QueryTrace #{status}; CTRL-\\ to toggle"
+
+trap("QUIT") do
+  # Sending 2 backspace characters removes the ^\ that is 
+  # printed to the console.
+  rm_noise = "\b\b"
+
+  QueryTrace.toggle!
+  puts "#{rm_noise}=> QueryTrace #{status}"
+end

data/lib/query_trace.rb

@@ -0,0 +1,64 @@
+module QueryTrace
+  mattr_accessor :depth
+  self.depth = 20
+  
+  def self.enabled?
+    defined?(@@trace_queries) && @@trace_queries
+  end
+     
+  def self.enable!
+    ::ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, QueryTrace) unless defined?(@@trace_queries)
+    @@trace_queries = true
+  end
+  
+  def self.disable!
+    @@trace_queries = false
+  end
+
+  # Toggles query tracing on and off and returns a boolean indicating the new
+  # state of query tracing (true for enabled, false for disabled).
+  def self.toggle!
+    enabled? ? disable! : enable!
+    enabled?
+  end
+  
+  def self.append_features(klass)
+    super
+    klass.class_eval do
+      unless method_defined?(:log_without_trace)
+        alias_method :log_without_trace, :log
+        alias_method :log, :log_with_trace
+      end
+    end
+  end
+
+  def log_with_trace(sql, name, &block)
+    result = log_without_trace(sql, name, &block)
+
+    return result unless @@trace_queries
+
+    return result unless ActiveRecord::Base.logger and ActiveRecord::Base.logger.debug?
+    return result if / Columns$/ =~ name
+
+    ActiveRecord::Base.logger.debug(format_trace(Rails.backtrace_cleaner.clean(caller)[0..self.depth]))
+
+    result 
+  end
+
+  def format_trace(trace)
+    if (defined?(ActiveRecord::LogSubscriber) ? ActiveRecord::LogSubscriber : ActiveRecord::Base).colorize_logging
+      message_color = "35;2"
+      trace.collect{|t| "    \e[#{message_color}m#{t}\e[0m"}.join("\n")
+    else
+      trace.join("\n    ")
+    end
+  end
+
+  def clean_trace(trace)
+    Rails.respond_to?(:backtrace_cleaner) ?
+      Rails.backtrace_cleaner.clean(trace) :
+      trace
+  end
+end
+
+QueryTrace.enable! if ENV["QUERY_TRACE"]

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: vizjerai-query_trace
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Nathaniel Talbott
+- Mike Gunderloy
+- Andrew Assarattanakul
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: With query_trace enabled, the Rails logs will contain a partial stack trace for every executed SQL statement, making it easier to find where they are generated in your code.
+email: nathaniel@terralien.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/query_trace.rb
+has_rdoc: true
+homepage: http://github.com/vizjerai/query_trace
+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: query_trace
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Adds query origin tracing to your logs.
+test_files: []
+