jayjlawrence / active-record-query-trace Goto Github PK

Logs the source of execution of all queries to the Rails log. Helpful to track down where queries are being executed in your application, for performance optimizations most likely.

Install the latest stable release:

gem install active_record_query_trace

In Rails, add it to your Gemfile, then restart the server:

gem 'active_record_query_trace'

Enable it in an initializer:

ActiveRecordQueryTrace.enabled = true

There are four levels/types of debug.

1. app - includes only files in your app/, lib/, and engines/ directories.
2. rails - includes files in your app as well as rails.
3. full - alternate output of full backtrace, useful for debugging gems.
4. cleaner - using a backtrace cleaner either created or supplied

ActiveRecordQueryTrace.level = :app # default
ActiveRecordQueryTrace.backtrace_cleaner = #<ActiveSupport::BacktraceCleaner:.....>

By default, a backtrace will be logged for every query, even cached queries that do not actually hit the database. You might find it useful not to print the backtrace for cached queries:

ActiveRecordQueryTrace.ignore_cached_queries = true # Default is false.

Additionally, if you are working with a large app, you may wish to limit the number of lines displayed for each query.

ActiveRecordQueryTrace.lines = 10 # Default is 5. Setting to 0 includes entire trace.

If you want the output can be colorized with a string of the color or a code. Valid colors are: 'black', 'red', 'green', 'brown', 'blue', 'purple', 'cyan', 'gray', 'dark gray', 'light red', 'light green', 'yellow', 'light blue', 'light purple', 'light cyan', 'white'

ActiveRecordQueryTrace.colorize = false # No colorization(default)
ActiveRecordQueryTrace.colorize = 'light purple'
ActiveRecordQueryTrace.colorize = true # Colorize in default color
ActiveRecordQueryTrace.colorize = 35 # Magenta

When enabled every query source will be logged like:

  IntuitAccount Load (1.2ms)  SELECT "intuit_accounts".* FROM "intuit_accounts" WHERE "intuit_accounts"."user_id" = 20 LIMIT 1
Called from:
  app/views/users/edit.html.haml:78:in `block in _app_views_users_edit_html_haml___1953197429694975654_70177901460360'
  app/views/users/edit.html.haml:16:in `_app_views_users_edit_html_haml___1953197429694975654_70177901460360'

Rails 3+

Copyright (c) 2011 Cody Caughlan

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.