debugging_rails_applications.md 28.6 KB
Newer Older
1 2
Debugging Rails Applications
============================
3

4 5 6
This guide introduces techniques for debugging Ruby on Rails applications.

After reading this guide, you will know:
7

8 9 10 11
* The purpose of debugging.
* How to track down problems and issues in your application that your tests aren't identifying.
* The different ways of debugging.
* How to analyze the stack trace.
12

13
--------------------------------------------------------------------------------
14

15 16
View Helpers for Debugging
--------------------------
17 18 19

One common task is to inspect the contents of a variable. In Rails, you can do this with three methods:

20 21 22
* `debug`
* `to_yaml`
* `inspect`
23

24
### `debug`
25

J
Jonathan Roes 已提交
26
The `debug` helper will return a \<pre> tag that renders the object using the YAML format. This will generate human-readable data from any object. For example, if you have this code in a view:
27

28
```html+erb
29 30 31
<%= debug @post %>
<p>
  <b>Title:</b>
32
  <%= @post.title %>
33
</p>
34
```
35 36 37

You'll see something like this:

38
```yaml
39 40 41 42 43 44 45 46 47 48 49 50
--- !ruby/object:Post
attributes:
  updated_at: 2008-09-05 22:55:47
  body: It's a very helpful guide for debugging your Rails app.
  title: Rails debugging guide
  published: t
  id: "1"
  created_at: 2008-09-05 22:55:47
attributes_cache: {}


Title: Rails debugging guide
51
```
52

53
### `to_yaml`
54

V
Vijay Dev 已提交
55
Displaying an instance variable, or any other object or method, in YAML format can be achieved this way:
56

57
```html+erb
58 59 60
<%= simple_format @post.to_yaml %>
<p>
  <b>Title:</b>
61
  <%= @post.title %>
62
</p>
63
```
64

65
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.
66 67 68

As a result of this, you will have something like this in your view:

69
```yaml
70 71 72 73 74 75 76 77 78 79 80
--- !ruby/object:Post
attributes:
updated_at: 2008-09-05 22:55:47
body: It's a very helpful guide for debugging your Rails app.
title: Rails debugging guide
published: t
id: "1"
created_at: 2008-09-05 22:55:47
attributes_cache: {}

Title: Rails debugging guide
81
```
82

83
### `inspect`
84

85
Another useful method for displaying object values is `inspect`, especially when working with arrays or hashes. This will print the object value as a string. For example:
86

87
```html+erb
88 89 90
<%= [1, 2, 3, 4, 5].inspect %>
<p>
  <b>Title:</b>
91
  <%= @post.title %>
92
</p>
93
```
94 95 96

Will be rendered as follows:

97
```
98 99 100
[1, 2, 3, 4, 5]

Title: Rails debugging guide
101
```
102

103 104
The Logger
----------
105 106 107

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

108
### What is the Logger?
109

110
Rails makes use of the `ActiveSupport::Logger` class to write log information. You can also substitute another logger such as `Log4r` if you wish.
111

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

114
```ruby
115 116
Rails.logger = Logger.new(STDOUT)
Rails.logger = Log4r::Logger.new("Application Log")
117
```
118

119
Or in the `Initializer` section, add _any_ of the following
120

121
```ruby
122 123
config.logger = Logger.new(STDOUT)
config.logger = Log4r::Logger.new("Application Log")
124
```
125

126
TIP: By default, each log is created under `Rails.root/log/` and the log file name is `environment_name.log`.
127

128
### Log Levels
129

130
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 `Rails.logger.level` method.
131

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

134
```ruby
135
config.log_level = :warn # In any environment initializer, or
136
Rails.logger.level = 0 # at any time
137
```
138 139 140

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.

141
TIP: The default Rails log level is `info` in production mode and `debug` in development and test mode.
142

143
### Sending Messages
144

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

147
```ruby
148 149 150
logger.debug "Person attributes hash: #{@person.attributes.inspect}"
logger.info "Processing the request..."
logger.fatal "Terminating application, raised unrecoverable error!!!"
151
```
152 153 154

Here's an example of a method instrumented with extra logging:

155
```ruby
156 157 158 159 160 161 162 163 164 165
class PostsController < ApplicationController
  # ...

  def create
    @post = Post.new(params[:post])
    logger.debug "New post: #{@post.attributes.inspect}"
    logger.debug "Post should be valid: #{@post.valid?}"

    if @post.save
      flash[:notice] = 'Post was successfully created.'
V
Vijay Dev 已提交
166
      logger.debug "The post was saved and now the user is going to be redirected..."
167 168
      redirect_to(@post)
    else
A
Agis Anastasopoulos 已提交
169
      render action: "new"
170 171 172 173 174
    end
  end

  # ...
end
175
```
176

J
Jonathan Roes 已提交
177
Here's an example of the log generated when this controller action is executed:
178

179
```
180 181 182 183 184 185 186 187 188 189 190 191
Processing PostsController#create (for 127.0.0.1 at 2008-09-08 11:52:54) [POST]
  Session ID: BAh7BzoMY3NyZl9pZCIlMDY5MWU1M2I1ZDRjODBlMzkyMWI1OTg2NWQyNzViZjYiCmZsYXNoSUM6J0FjdGl
vbkNvbnRyb2xsZXI6OkZsYXNoOjpGbGFzaEhhc2h7AAY6CkB1c2VkewA=--b18cd92fba90eacf8137e5f6b3b06c4d724596a4
  Parameters: {"commit"=>"Create", "post"=>{"title"=>"Debugging Rails",
 "body"=>"I'm learning how to print in logs!!!", "published"=>"0"},
 "authenticity_token"=>"2059c1286e93402e389127b1153204e0d1e275dd", "action"=>"create", "controller"=>"posts"}
New post: {"updated_at"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs!!!",
 "published"=>false, "created_at"=>nil}
Post should be valid: true
  Post Create (0.000443)   INSERT INTO "posts" ("updated_at", "title", "body", "published",
 "created_at") VALUES('2008-09-08 14:52:54', 'Debugging Rails',
 'I''m learning how to print in logs!!!', 'f', '2008-09-08 14:52:54')
V
Vijay Dev 已提交
192
The post was saved and now the user is going to be redirected...
193 194
Redirected to #<Post:0x20af760>
Completed in 0.01224 (81 reqs/sec) | DB: 0.00044 (3%) | 302 Found [http://localhost/posts]
195
```
196

J
Jonathan Roes 已提交
197
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.
V
Vijay Dev 已提交
198

199
### Tagged Logging
200

201
When running multi-user, multi-account applications, it's often useful
Y
Yves Senn 已提交
202 203
to be able to filter the logs using some custom rules. `TaggedLogging`
in Active Support helps in doing exactly that by stamping log lines with subdomains, request ids, and anything else to aid debugging such applications.
V
Vijay Dev 已提交
204

205
```ruby
V
Vijay Dev 已提交
206 207 208 209
logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged("BCX") { logger.info "Stuff" }                            # Logs "[BCX] Stuff"
logger.tagged("BCX", "Jason") { logger.info "Stuff" }                   # Logs "[BCX] [Jason] Stuff"
logger.tagged("BCX") { logger.tagged("Jason") { logger.info "Stuff" } } # Logs "[BCX] [Jason] Stuff"
210
```
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
### Impact of Logs on Performance
Logging will always have a small impact on performance of your rails app, 
        particularly when logging to disk.However, there are a few subtleties:

Using the `:debug` level will have a greater performance penalty than `:fatal`,
      as a far greater number of strings are being evaluated and written to the
      log output (e.g. disk).

Another potential pitfall is that if you have many calls to `Logger` like this
      in your code:

```ruby
logger.debug "Person attributes hash: #{@person.attributes.inspect}"
```

In the above example, There will be a performance impact even if the allowed 
output level doesn't include debug. The reason is that Ruby has to evaluate 
these strings, which includes instantiating the somewhat heavy `String` object 
and interpolating the variables, and which takes time.
Therefore, it's recommended to pass blocks to the logger methods, as these are 
only evaluated if the output level is the same or included in the allowed level 
(i.e. lazy loading). The same code rewritten would be:

```ruby
logger.debug {"Person attibutes hash: #{@person.attributes.inspect}"}
```

The contents of the block, and therefore the string interpolation, is only 
evaluated if debug is enabled. This performance savings is only really 
noticeable with large amounts of logging, but it's a good practice to employ.

243
Debugging with the `debugger` gem
244
---------------------------------
245 246 247 248 249

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.

250
### Setup
251

J
Jonathan Roes 已提交
252
You can use the `debugger` gem to set breakpoints and step through live code in Rails. To install it, just run:
253

P
Prem Sichanugrist 已提交
254
```bash
A
Aditya Sanghi 已提交
255
$ gem install debugger
256
```
257

258
Rails has had built-in support for debugging since Rails 2.0. Inside any Rails application you can invoke the debugger by calling the `debugger` method.
259

260 261
Here's an example:

262
```ruby
263 264 265 266 267 268
class PeopleController < ApplicationController
  def new
    debugger
    @person = Person.new
  end
end
269
```
270

J
Jonathan Roes 已提交
271
If you see this message in the console or logs:
272

273
```
274
***** Debugger requested, but was not available: Start server with --debugger to enable *****
275
```
276

277
Make sure you have started your web server with the option `--debugger`:
278

P
Prem Sichanugrist 已提交
279
```bash
280
$ rails server --debugger
R
Rob Zolkos 已提交
281
=> Booting WEBrick
V
Vipul A M 已提交
282
=> Rails 4.0.0 application starting on http://0.0.0.0:3000
283 284
=> Debugger enabled
...
285
```
286

J
Jonathan Roes 已提交
287
TIP: In development mode, you can dynamically `require \'debugger\'` instead of restarting the server, even if it was started without `--debugger`.
288

289
### The Shell
290

291
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 the debugger'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.
292 293 294 295 296

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:

P
Prem Sichanugrist 已提交
297
```bash
298
@posts = Post.all
299
(rdb:7)
300
```
301

J
Jonathan Roes 已提交
302
Now it's time to explore and dig into your application. A good place to start is by asking the debugger for help. Type: `help`
303

304
```
305 306 307 308 309 310 311 312 313 314
(rdb:7) help
ruby-debug help v0.10.2
Type 'help <command-name>' for help on a specific command

Available commands:
backtrace  delete   enable  help    next  quit     show    trace
break      disable  eval    info    p     reload   source  undisplay
catch      display  exit    irb     pp    restart  step    up
condition  down     finish  list    ps    save     thread  var
continue   edit     frame   method  putl  set      tmate   where
315
```
316

J
Jonathan Roes 已提交
317
TIP: To view the help menu for any command use `help <command-name>` at the debugger prompt. For example: _`help var`_
318

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

321
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 `=>`.
322

323
```
324
(rdb:7) list
J
Jonathan Roes 已提交
325
[1, 10] in /PathTo/project/app/controllers/posts_controller.rb
326 327
   1  class PostsController < ApplicationController
   2    # GET /posts
328
   3    # GET /posts.json
329 330
   4    def index
   5      debugger
331
=> 6      @posts = Post.all
332 333 334
   7
   8      respond_to do |format|
   9        format.html # index.html.erb
R
Rashmi Yadav 已提交
335
   10        format.json { render json: @posts }
336
```
337

338
If you repeat the `list` command, this time using just `l`, the next ten lines of the file will be printed out.
339

340
```
341 342 343 344 345 346
(rdb:7) l
[11, 20] in /PathTo/project/app/controllers/posts_controller.rb
   11      end
   12    end
   13
   14    # GET /posts/1
347
   15    # GET /posts/1.json
348 349 350 351 352
   16    def show
   17      @post = Post.find(params[:id])
   18
   19      respond_to do |format|
   20        format.html # show.html.erb
353
```
354

355
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.
356

357
On the other hand, to see the previous ten lines you should type `list-` (or `l-`)
358

359
```
360
(rdb:7) l-
J
Jonathan Roes 已提交
361
[1, 10] in /PathTo/project/app/controllers/posts_controller.rb
362 363
   1  class PostsController < ApplicationController
   2    # GET /posts
364
   3    # GET /posts.json
365 366 367 368 369 370
   4    def index
   5      debugger
   6      @posts = Post.all
   7
   8      respond_to do |format|
   9        format.html # index.html.erb
R
Rashmi Yadav 已提交
371
   10        format.json { render json: @posts }
372
```
373

374 375
This way you can move inside the file, being able to see the code above and over the line you added the `debugger`.
Finally, to see where you are in the code again you can type `list=`
376

377
```
378
(rdb:7) list=
J
Jonathan Roes 已提交
379
[1, 10] in /PathTo/project/app/controllers/posts_controller.rb
380 381
   1  class PostsController < ApplicationController
   2    # GET /posts
382
   3    # GET /posts.json
383 384 385 386 387 388
   4    def index
   5      debugger
=> 6      @posts = Post.all
   7
   8      respond_to do |format|
   9        format.html # index.html.erb
389
   10        format.json { render :json => @posts }
390
```
391

392
### The Context
393 394 395

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

A
Aditya Sanghi 已提交
396
The debugger creates a context 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.
397

398
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.
399

400
```
401 402 403 404 405 406 407 408 409 410
(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
...
411
```
412

413
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.
414

415
```
416 417 418
(rdb:5) frame 2
#2 ActionController::Base.perform_action_without_filters
       at line /PathTo/project/vendor/rails/actionpack/lib/action_controller/base.rb:1175
419
```
420 421 422

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

423
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.
424

425
### Threads
426

427
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:
428

429 430 431 432 433
* `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_.
434 435 436

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.

437
### Inspecting Variables
438 439 440 441 442

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:

443
```
444
@posts = Post.all
445 446
(rdb:11) instance_variables
["@_response", "@action_name", "@url", "@_session", "@_cookies", "@performed_render", "@_flash", "@template", "@_params", "@before_filter_chain_aborted", "@request_origin", "@_headers", "@performed_redirect", "@_request"]
447
```
448

449
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).
450

451
```
452 453 454 455 456 457
(rdb:11) next
Processing PostsController#index (for 127.0.0.1 at 2008-09-04 19:51:34) [GET]
  Session ID: BAh7BiIKZmxhc2hJQzonQWN0aW9uQ29udHJvbGxlcjo6Rmxhc2g6OkZsYXNoSGFzaHsABjoKQHVzZWR7AA==--b16e91b992453a8cc201694d660147bba8b0fd0e
  Parameters: {"action"=>"index", "controller"=>"posts"}
/PathToProject/posts_controller.rb:8
respond_to do |format|
458
```
459 460 461

And then ask again for the instance_variables:

462
```
463 464
(rdb:11) instance_variables.include? "@posts"
true
465
```
466

467
Now `@posts` is included in the instance variables, because the line defining it was executed.
468

469
TIP: You can also step into **irb** mode with the command `irb` (of course!). This way an irb session will be started within the context you invoked it. But be warned: this is an experimental feature.
470

471
The `var` method is the most convenient way to show variables and their values:
472

473
```
474 475 476 477 478
var
(rdb:1) v[ar] const <object>            show constants of object
(rdb:1) v[ar] g[lobal]                  show global variables
(rdb:1) v[ar] i[nstance] <object>       show instance variables of object
(rdb:1) v[ar] l[ocal]                   show local variables
479
```
480 481 482

This is a great way to inspect the values of the current context variables. For example:

483
```
484 485
(rdb:9) var local
  __dbg_verbose_save => false
486
```
487 488 489

You can also inspect for an object method this way:

490
```
491 492 493 494
(rdb:9) var instance Post.new
@attributes = {"updated_at"=>nil, "body"=>nil, "title"=>nil, "published"=>nil, "created_at"...
@attributes_cache = {}
@new_record = true
495
```
496

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

499
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.
500

501
```
502 503
(rdb:1) display @recent_comments
1: @recent_comments =
504
```
505

506
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).
507

508
### Step by Step
509 510 511

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.

512
Use `step` (abbreviated `s`) to continue running your program until the next logical stopping point and return control to the debugger.
513

514
TIP: You can also use `step+ n` and `step- n` to move forward or backward `n` steps respectively.
515

516
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.
517

518
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.
519

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

522
```ruby
523 524 525 526 527 528
class Author < ActiveRecord::Base
  has_one :editorial
  has_many :comments

  def find_recent_comments(limit = 10)
    debugger
A
Akira Matsuda 已提交
529
    @recent_comments ||= comments.where("created_at > ?", 1.week.ago).limit(limit)
530 531
  end
end
532
```
533

534
TIP: You can use the debugger while using `rails console`. Just remember to `require "debugger"` before calling the `debugger` method.
535

536
```
537
$ rails console
V
Vipul A M 已提交
538
Loading development environment (Rails 4.0.0)
539
>> require "debugger"
540 541 542 543 544 545
=> []
>> author = Author.first
=> #<Author id: 1, first_name: "Bob", last_name: "Smith", created_at: "2008-07-31 12:46:10", updated_at: "2008-07-31 12:46:10">
>> author.find_recent_comments
/PathTo/project/app/models/author.rb:11
)
546
```
547 548 549

With the code stopped, take a look around:

550
```
551
(rdb:1) list
A
Akira Matsuda 已提交
552 553 554 555 556
[2, 9] in /PathTo/project/app/models/author.rb
   2    has_one :editorial
   3    has_many :comments
   4
   5    def find_recent_comments(limit = 10)
557
   6      debugger
A
Akira Matsuda 已提交
558 559 560
=> 7      @recent_comments ||= comments.where("created_at > ?", 1.week.ago).limit(limit)
   8    end
   9  end
561
```
562 563 564

You are at the end of the line, but... was this line executed? You can inspect the instance variables.

565
```
566 567 568
(rdb:1) var instance
@attributes = {"updated_at"=>"2008-07-31 12:46:10", "id"=>"1", "first_name"=>"Bob", "las...
@attributes_cache = {}
569
```
570

571
`@recent_comments` hasn't been defined yet, so it's clear that this line hasn't been executed yet. Use the `next` command to move on in the code:
572

573
```
574 575 576 577 578 579 580 581
(rdb:1) next
/PathTo/project/app/models/author.rb:12
@recent_comments
(rdb:1) var instance
@attributes = {"updated_at"=>"2008-07-31 12:46:10", "id"=>"1", "first_name"=>"Bob", "las...
@attributes_cache = {}
@comments = []
@recent_comments = []
582
```
583

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

586
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.
587

588
### Breakpoints
589 590 591

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

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

594 595 596
* `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.
597

598
```
599 600
(rdb:5) break 10
Breakpoint 1 file /PathTo/project/vendor/rails/actionpack/lib/action_controller/filters.rb, line 10
601
```
602

603
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.
604

605
```
606 607 608
(rdb:5) info breakpoints
Num Enb What
  1 y   at filters.rb:10
609
```
610

611
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..
612

613
```
614 615 616
(rdb:5) delete 1
(rdb:5) info breakpoints
No breakpoints.
617
```
618 619 620

You can also enable or disable breakpoints:

621 622
* `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.
623

624
### Catching Exceptions
625

626
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.
627

628
To list all active catchpoints use `catch`.
629

630
### Resuming Execution
631 632 633

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

634 635
* `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.
636

637
### Editing
638 639 640

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

641 642
* `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.
643

644
### Quitting
645

646
To exit the debugger, use the `quit` command (abbreviated `q`), or its alias `exit`.
647 648 649

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

650
### Settings
651

652
The `debugger` gem can automatically show the code you're stepping through and reload it when you change it in an editor. Here are a few of the available options:
653

654 655 656 657
* `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
658

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

661
TIP: You can save these settings in an `.rdebugrc` file in your home directory. The debugger reads these global settings when it starts.
662

663
Here's a good start for an `.rdebugrc`:
664

P
Prem Sichanugrist 已提交
665
```bash
666 667 668
set autolist
set forcestep
set listsize 25
669
```
670

671 672
Debugging Memory Leaks
----------------------
673 674 675

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

676
In this section, you will learn how to find and fix such leaks by using tool such as Valgrind.
677

678
### Valgrind
679

680
[Valgrind](http://valgrind.org/) is a Linux-only application for detecting C-based memory leaks and race conditions.
681

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

684
For further information on how to install Valgrind and use with Ruby, refer to [Valgrind and Ruby](http://blog.evanweaver.com/articles/2008/02/05/valgrind-and-ruby/) by Evan Weaver.
685

686 687
Plugins for Debugging
---------------------
688 689 690

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

691 692 693 694
* [Footnotes](https://github.com/josevalim/rails-footnotes) Every Rails page has footnotes that give request information and link back to your source via TextMate.
* [Query Trace](https://github.com/ntalbott/query_trace/tree/master) Adds query origin tracing to your logs.
* [Query Reviewer](https://github.com/nesquena/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](https://github.com/smartinez87/exception_notification/tree/master) Provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application.
695 696
* [Better Errors](https://github.com/charliesome/better_errors) Replaces the standard Rails error page with a new one containing more contextual information, like source code and variable inspection.
* [RailsPanel](https://github.com/dejan/rails_panel) Chrome extension for Rails development that will end your tailing of development.log. Have all information about your Rails app requests in the browser - in the Developer Tools panel. Provides insight to db/rendering/total times, parameter list, rendered views and more.
697

698 699
References
----------
700

701
* [ruby-debug Homepage](http://bashdb.sourceforge.net/ruby-debug/home-page.html)
A
Akira Matsuda 已提交
702
* [debugger Homepage](https://github.com/cldwalker/debugger)
K
Ken Lu 已提交
703
* [Article: Debugging a Rails application with ruby-debug](http://www.sitepoint.com/debug-rails-app-ruby-debug/)
704 705 706 707
* [Ryan Bates' debugging ruby (revised) screencast](http://railscasts.com/episodes/54-debugging-ruby-revised)
* [Ryan Bates' stack trace screencast](http://railscasts.com/episodes/24-the-stack-trace)
* [Ryan Bates' logger screencast](http://railscasts.com/episodes/56-the-logger)
* [Debugging with ruby-debug](http://bashdb.sourceforge.net/ruby-debug.html)