Tracing Rails 3 SQL queries

Question

Is there any gem which works on Rails 3 that can show which part of my code generated which SQL query?

On Rails 2.3 there was plugin called query_trace, but it doesn't seem to work on Rails 3, it generates following error:

alias_method': undefined method `log_info' for class `ActiveRecord::ConnectionAdapters::AbstractAdapter' (NameError)

Zabba · Accepted Answer · 2010-12-25T20:07:31.603

QueryTrace doesn't work as-is because many changes were made in Rails 3 esp in the area of ActiveRecord.

So, hacking around, I made it work like this:

You just need the 2 files below in the locations mentioned. Then restart the web server. After the SQL, you should see Called from: in a console (magenta on white) and log file

In /vendor/plugins/query_trace/lib/query_trace.rb

module QueryTrace
  def self.append_features(klass)
    super
    klass.class_eval do
      unless method_defined?(:log_info_without_trace)
        alias_method :log_info_without_trace, :sql
        alias_method :sql, :log_info_with_trace
      end
    end
  end

  def log_info_with_trace(event)
    log_info_without_trace(event)
    logger.debug("\e[1m\e[35m\e[1m\e[47mCalled from:\e[0m " + clean_trace(caller[2..-2]).join("\n "))
  end

  def clean_trace(trace)
    Rails.respond_to?(:backtrace_cleaner) ?
      Rails.backtrace_cleaner.clean(trace) :
      trace
  end
end

In /vendor/plugins/query_trace/init.rb

require 'query_trace'

class ::ActiveRecord::LogSubscriber
  include QueryTrace
end

Great solution. I would add "if Rails.env.development?" in the init.rb file. — Ryenski, Apr 28 '11 at 00:25

score 7 · Answer 2 · answered Mar 05 '12 at 18:39

7

https://github.com/lightyear/sql-logging

answered Mar 05 '12 at 18:39

Bryan Larsen

9,468
8
56
46

This appears to be a rewrite of query_trace for rails3. At least, the credits acknowledge the original query_trace. – Rob Jul 03 '13 at 19:37
Had really good results with this gem. Not color-coded but the depth and accuracy of the stack trace is excellent. – Joshua Pinter Apr 24 '15 at 15:38

score 5 · Answer 3 · answered Aug 10 '11 at 16:36

5

A port of query_trace to rails3

https://gist.github.com/1137342

answered Aug 10 '11 at 16:36

paul.belt

289
3
3

score 1 · Answer 4 · answered Mar 10 '19 at 14:56

The active_record_query_trace also does that.

Add the following to your Gemfile:

group :development do
  gem 'active_record_query_trace'
end

Create an initializer such as config/initializers/active_record_query_trace.rb to enable the gem. If you want to customize how the gem behaves, you can add any combination of the options described in the docs to the initializer as well.

if Rails.env.development?
 ActiveRecordQueryTrace.enabled = true
 # Optional: other gem config options go here
end

Restart the Rails development server.

score 0 · Answer 5 · answered Jul 05 '11 at 18:13

0

There appears to be a good fork here:

https://github.com/dolzenko/query_trace

Note that the QUERY_TRACE constant in the documentation doesn't seem to work, but the QueryTrace.enable! does (must be in an initializer, I tried putting it into config/development.rb first)

answered Jul 05 '11 at 18:13

Brian Underwood

10,746
1
22
34

that gave me a "wrong number of arguments" backtrace, so I don't think it is working for rails 3.2 at least – Rob Jul 03 '13 at 19:38

Tracing Rails 3 SQL queries

5 Answers5

Linked