1.2 to_yaml

The to_yaml method converts the method to YAML format leaving it more readable, and then the simple_format helper is used to render each line as in the console. This is how debug method does its magic.

1.4 Debugging JavaScript

Rails has built-in support to debug RJS, to active it, set ActionView::Base.debug_rjs to true, this will specify whether RJS responses should be wrapped in a try/catch block that alert()s the caught exception (and then re-raises it).

To enable it, add the following in the Rails::Initializer do |config| block inside environment.rb:

config.action_view[:debug_rjs] = true

Or, at any time, setting ActionView::Base.debug_rjs to true:

ActionView::Base.debug_rjs = true

For more information on debugging javascript refer to Firebug, the popular debugger for Firefox.

2 The Logger

It can also be useful to save information to log files at runtime. Rails maintains a separate log file for each runtime environment.

2.1 What is the Logger?

Rails makes use of Ruby’s standard logger to write log information. You can also substitute another logger such as Log4R if you wish.

You can specify an alternative logger in your environment.rb or any environment file:

By default, each log is created under RAILS_ROOT/log/ and the log file name is environment_name.log.

2.2 Log Levels

When something is logged it’s printed into the corresponding log if the log level of the message is equal or higher than the configured log level. If you want to know the current log level you can call the ActiveRecord::Base.logger.level method.

The available log levels are: :debug, :info, :warn, :error, and :fatal, corresponding to the log level numbers from 0 up to 4 respectively. To change the default log level, use

config.log_level = Logger::WARN # In any environment initializer, or
ActiveRecord::Base.logger.level = 0 # at any time

This is useful when you want to log under development or staging, but you don’t want to flood your production log with unnecessary information.

The default Rails log level is info in production mode and debug in development and test mode.

2.3 Sending Messages

To write in the current log use the logger.(debug|info|warn|error|fatal) method from within a controller, model or mailer:

Adding extra logging like this makes it easy to search for unexpected or unusual behavior in your logs. If you add extra logging, be sure to make sensible use of log levels, to avoid filling your production logs with useless trivia.

3 Debugging with ruby-debug

When your code is behaving in unexpected ways, you can try printing to logs or the console to diagnose the problem. Unfortunately, there are times when this sort of error tracking is not effective in finding the root cause of a problem. When you actually need to journey into your running source code, the debugger is your best companion.

The debugger can also help you if you want to learn about the Rails source code but don’t know where to start. Just debug any request to your application and use this guide to learn how to move from the code you have written deeper into Rails code.

3.1 Setup

The debugger used by Rails, ruby-debug, comes as a gem. To install it, just run:

In development mode, you can dynamically require \'ruby-debug\' instead of restarting the server, if it was started without --debugger.

In order to use Rails debugging you’ll need to be running either WEBrick or Mongrel. For the moment, no alternative servers are supported.

3.2 The Shell

As soon as your application calls the debugger method, the debugger will be started in a debugger shell inside the terminal window where you launched your application server, and you will be placed at ruby-debug’s prompt (rdb:n). The n is the thread number. The prompt will also show you the next line of code that is waiting to run.

If you got there by a browser request, the browser tab containing the request will be hung until the debugger has finished and the trace has finished processing the entire request.

For example:

@posts = Post.find(:all)
(rdb:7)

Now it’s time to explore and dig into your application. A good place to start is by asking the debugger for help… so type: help (You didn’t see that coming, right?)

To view the help menu for any command use help in active debug mode. For example: help var

The next command to learn is one of the most useful: list. You can also abbreviate ruby-debug commands by supplying just enough letters to distinguish them from other commands, so you can also use l for the list command.

This command shows you where you are in the code by printing 10 lines centered around the current line; the current line in this particular case is line 6 and is marked by =>.

And so on until the end of the current file. When the end of file is reached, the list command will start again from the beginning of the file and continue again up to the end, treating the file as a circular buffer.

3.3 The Context

When you start debugging your application, you will be placed in different contexts as you go through the different parts of the stack.

ruby-debug creates a content when a stopping point or an event is reached. The context has information about the suspended program which enables a debugger to inspect the frame stack, evaluate variables from the perspective of the debugged program, and contains information about the place where the debugged program is stopped.

At any time you can call the backtrace command (or its alias where) to print the backtrace of the application. This can be very helpful to know how you got where you are. If you ever wondered about how you got somewhere in your code, then backtrace will supply the answer.

(rdb:5) where
#0 PostsController.index
at line /PathTo/project/app/controllers/posts_controller.rb:6
#1 Kernel.send
at line /PathTo/project/vendor/rails/actionpack/lib/action_controller/base.rb:1175
#2 ActionController::Base.perform_action_without_filters
at line /PathTo/project/vendor/rails/actionpack/lib/action_controller/base.rb:1175
#3 ActionController::Filters::InstanceMethods.call_filters(chain#ActionController::Fil...,...)
at line /PathTo/project/vendor/rails/actionpack/lib/action_controller/filters.rb:617
...

You move anywhere you want in this trace (thus changing the context) by using the frame _n_ command, where n is the specified frame number.

The available variables are the same as if you were running the code line by line. After all, that’s what debugging is.

Moving up and down the stack frame: You can use up [n] (u for abbreviated) and down [n] commands in order to change the context n frames up or down the stack respectively. n defaults to one. Up in this case is towards higher-numbered stack frames, and down is towards lower-numbered stack frames.

3.4 Threads

The debugger can list, stop, resume and switch between running threads by using the command thread (or the abbreviated th). This command has a handful of options:

thread shows the current thread.

thread list is used to list all threads and their statuses. The plus + character and the number indicates the current thread of execution.

thread stop _n_ stop thread n.

thread resume _n_ resumes thread n.

thread switch _n_ switches the current thread context to n.

This command is very helpful, among other occasions, when you are debugging concurrent threads and need to verify that there are no race conditions in your code.

3.5 Inspecting Variables

Any expression can be evaluated in the current context. To evaluate an expression, just type it!

This example shows how you can print the instance_variables defined within the current context:

As you may have figured out, all of the variables that you can access from a controller are displayed. This list is dynamically updated as you execute code. For example, run the next line using next (you’ll learn more about this command later in this guide).

The commands p (print) and pp (pretty print) can be used to evaluate Ruby expressions and display the value of variables to the console.

You can use also display to start watching variables. This is a good way of tracking the values of a variable while the execution goes on.

(rdb:1) display @recent_comments
1: @recent_comments =

The variables inside the displaying list will be printed with their values after you move in the stack. To stop displaying a variable use undisplay _n_ where n is the variable number (1 in the last example).

3.6 Step by Step

Now you should know where you are in the running trace and be able to print the available variables. But lets continue and move on with the application execution.

Use step (abbreviated s) to continue running your program until the next logical stopping point and return control to ruby-debug.

You can also use stepn and step- _n_+ to move forward or backward n steps respectively.

You may also use next which is similar to step, but function or method calls that appear within the line of code are executed without stopping. As with step, you may use plus sign to move n steps.

The difference between next and step is that step stops at the next line of code executed, doing just a single step, while next moves to the next line without descending inside methods.

For example, consider this block of code with an included debugger statement:

Now you can see that the @comments relationship was loaded and @recent_comments defined because the line was executed.

If you want to go deeper into the stack trace you can move single steps, through your calling methods and into Rails code. This is one of the best ways to find bugs in your code, or perhaps in Ruby or Rails.

3.7 Breakpoints

A breakpoint makes your application stop whenever a certain point in the program is reached. The debugger shell is invoked in that line.

You can add breakpoints dynamically with the command break (or just b). There are 3 possible ways of adding breakpoints manually:

break line: set breakpoint in the line in the current source file.

break file:line [if expression]: set breakpoint in the line number inside the file. If an expression is given it must evaluated to true to fire up the debugger.

break class(.|\#)method [if expression]: set breakpoint in method (. and \# for class and instance method respectively) defined in class. The expression works the same way as with file:line.

Use info breakpoints _n_ or info break _n_ to list breakpoints. If you supply a number, it lists that breakpoint. Otherwise it lists all breakpoints.

(rdb:5) info breakpoints
Num Enb What
1 y at filters.rb:10

To delete breakpoints: use the command delete _n_ to remove the breakpoint number n. If no number is specified, it deletes all breakpoints that are currently active..

(rdb:5) delete 1
(rdb:5) info breakpoints
No breakpoints.

You can also enable or disable breakpoints:

enable breakpoints: allow a list breakpoints or all of them if no list is specified, to stop your program. This is the default state when you create a breakpoint.

disable breakpoints: the breakpoints will have no effect on your program.

3.8 Catching Exceptions

The command catch exception-name (or just cat exception-name) can be used to intercept an exception of type exception-name when there would otherwise be is no handler for it.

To list all active catchpoints use catch.

3.9 Resuming Execution

There are two ways to resume execution of an application that is stopped in the debugger:

continue [line-specification] (or c): resume program execution, at the address where your script last stopped; any breakpoints set at that address are bypassed. The optional argument line-specification allows you to specify a line number to set a one-time breakpoint which is deleted when that breakpoint is reached.

finish [frame-number] (or fin): execute until the selected stack frame returns. If no frame number is given, the application will run until the currently selected frame returns. The currently selected frame starts out the most-recent frame or 0 if no frame positioning (e.g up, down or frame) has been performed. If a frame number is given it will run until the specified frame returns.

3.10 Editing

Two commands allow you to open code from the debugger into an editor:

edit [file:line]: edit file using the editor specified by the EDITOR environment variable. A specific line can also be given.

tmate _n_ (abbreviated tm): open the current file in TextMate. It uses n-th frame if n is specified.

3.11 Quitting

To exit the debugger, use the quit command (abbreviated q), or its alias exit.

A simple quit tries to terminate all threads in effect. Therefore your server will be stopped and you will have to start it again.

3.12 Settings

There are some settings that can be configured in ruby-debug to make it easier to debug your code. Here are a few of the available options:

set reload: Reload source code when changed.

set autolist: Execute list command on every breakpoint.

set listsize _n_: Set number of source lines to list by default to n.

set forcestep: Make sure the next and step commands always move to a new line

You can see the full list by using help set. Use help set _subcommand_ to learn about a particular set command.

You can include any number of these configuration lines inside a .rdebugrc file in your HOME directory. ruby-debug will read this file every time it is loaded. and configure itself accordingly.

Here’s a good start for an .rdebugrc:

set autolist
set forcestep
set listsize 25

4 Debugging Memory Leaks

A Ruby application (on Rails or not), can leak memory – either in the Ruby code or at the C code level.

In this section, you will learn how to find and fix such leaks by using Bleak House and Valgrind debugging tools.

4.1 BleakHouse

If a Ruby object does not go out of scope, the Ruby Garbage Collector won’t sweep it since it is referenced somewhere. Leaks like this can grow slowly and your application will consume more and more memory, gradually affecting the overall system performance. This tool will help you find leaks on the Ruby heap.

To install it run:

sudo gem install bleak_house

Then setup your application for profiling. Then add the following at the bottom of config/environment.rb:

require 'bleak_house' if ENV['BLEAK_HOUSE']

Start a server instance with BleakHouse integration:

RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house ./script/server

Make sure to run a couple hundred requests to get better data samples, then press CTRL-C. The server will stop and Bleak House will produce a dumpfile in /tmp:

This way you can find where your application is leaking memory and fix it.

If BleakHouse doesn’t report any heap growth but you still have memory growth, you might have a broken C extension, or real leak in the interpreter. In that case, try using Valgrind to investigate further.

4.2 Valgrind

Valgrind is a Linux-only application for detecting C-based memory leaks and race conditions.

There are Valgrind tools that can automatically detect many memory management and threading bugs, and profile your programs in detail. For example, a C extension in the interpreter calls malloc() but is doesn’t properly call free(), this memory won’t be available until the app terminates.

For further information on how to install Valgrind and use with Ruby, refer to Valgrind and Ruby by Evan Weaver.

5 Plugins for Debugging

There are some Rails plugins to help you to find errors and debug your application. Here is a list of useful plugins for debugging:

Footnotes: Every Rails page has footnotes that give request information and link back to your source via TextMate.

Query Reviewer: This rails plugin not only runs “EXPLAIN” before each of your select queries in development, but provides a small DIV in the rendered output of each page with the summary of warnings for each query that it analyzed.

Exception Notifier: Provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application.