debugging_rails_applications.md 29.3 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
<%= debug @article %>
30 31
<p>
  <b>Title:</b>
32
  <%= @article.title %>
33
</p>
34
```
35 36 37

You'll see something like this:

38
```yaml
39
--- !ruby/object Article
40 41 42 43 44 45 46 47 48 49 50
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
<%= simple_format @article.to_yaml %>
59 60
<p>
  <b>Title:</b>
61
  <%= @article.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
--- !ruby/object Article
71 72 73 74 75 76 77 78 79 80
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
  <%= @article.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

V
Vijay Dev 已提交
126
TIP: By default, each log is created under `Rails.root/log/` and the log file is named after the environment in which the application is running.
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
class ArticlesController < ApplicationController
157 158 159
  # ...

  def create
160 161 162 163 164 165 166 167
    @article = Article.new(params[:article])
    logger.debug "New article: #{@article.attributes.inspect}"
    logger.debug  Article should be valid: #{@article.valid?}"

    if @article.save
      flash[:notice] =  Article was successfully created.'
      logger.debug "The article was saved and now the user is going to be redirected..."
      redirect_to(@article)
168
    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
Processing ArticlesController#create (for 127.0.0.1 at 2008-09-08 11:52:54) [POST]
181 182
  Session ID: BAh7BzoMY3NyZl9pZCIlMDY5MWU1M2I1ZDRjODBlMzkyMWI1OTg2NWQyNzViZjYiCmZsYXNoSUM6J0FjdGl
vbkNvbnRyb2xsZXI6OkZsYXNoOjpGbGFzaEhhc2h7AAY6CkB1c2VkewA=--b18cd92fba90eacf8137e5f6b3b06c4d724596a4
183
  Parameters: {"commit"=>"Create", "article"=>{"title"=>"Debugging Rails",
184
 "body"=>"I'm learning how to print in logs!!!", "published"=>"0"},
185 186 187 188
 "authenticity_token"=>"2059c1286e93402e389127b1153204e0d1e275dd", "action"=>"create", "controller"=>"articles"}
New article: {"updated_at"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs!!!",
 "published"=>false, "created_at"=>nil} Article should be valid: true
  Article Create (0.000443)   INSERT INTO "articles" ("updated_at", "title", "body", "published",
189 190
 "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')
191 192 193
The article was saved and now the user is going to be redirected...
Redirected to # Article:0x20af760>
Completed in 0.01224 (81 reqs/sec) | DB: 0.00044 (3%) | 302 Found [http://localhost/articles]
194
```
195

J
Jonathan Roes 已提交
196
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 已提交
197

198
### Tagged Logging
199

200
When running multi-user, multi-account applications, it's often useful
Y
Yves Senn 已提交
201 202
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 已提交
203

204
```ruby
V
Vijay Dev 已提交
205 206 207 208
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"
209
```
210

211
### Impact of Logs on Performance
R
Robin Dupret 已提交
212
Logging will always have a small impact on performance of your rails app,
213 214 215 216 217 218 219 220 221 222 223 224 225
        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}"
```

R
Robin Dupret 已提交
226 227 228
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
229
and interpolating the variables, and which takes time.
R
Robin Dupret 已提交
230 231
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
232 233 234
(i.e. lazy loading). The same code rewritten would be:

```ruby
V
Vipul A M 已提交
235
logger.debug {"Person attributes hash: #{@person.attributes.inspect}"}
236 237
```

R
Robin Dupret 已提交
238 239
The contents of the block, and therefore the string interpolation, is only
evaluated if debug is enabled. This performance savings is only really
240 241
noticeable with large amounts of logging, but it's a good practice to employ.

242
Debugging with the `byebug` gem
243
---------------------------------
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.
250

251 252 253 254
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.
255

256
### Setup
257

258 259
You can use the `byebug` gem to set breakpoints and step through live code in
Rails. To install it, just run:
260

P
Prem Sichanugrist 已提交
261
```bash
262
$ gem install byebug
263
```
264

265 266
Inside any Rails application you can then invoke the debugger by calling the
`byebug` method.
267

268 269
Here's an example:

270
```ruby
271 272
class PeopleController < ApplicationController
  def new
273
    byebug
274 275 276
    @person = Person.new
  end
end
277
```
278

279
### The Shell
280

281 282 283 284
As soon as your application calls the `byebug` 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 `(byebug)`.
Before the prompt, the code around the line that is about to be run will be
285
displayed and the current line will be marked by '=>'. Like this:
286

287
```
288
[1, 10] in /PathTo/project/app/controllers/articles_controller.rb
289
    3:
290 291
    4:   # GET /articles
    5:   # GET /articles.json
292 293
    6:   def index
    7:     byebug
294
=>  8:     @articles = Article.find_recent
295 296 297
    9:
   10:     respond_to do |format|
   11:       format.html # index.html.erb
298
   12:       format.json { render json: @articles }
299

300
(byebug)
301
```
302

303 304 305
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.
306

307 308 309
For example:

```bash
310
=> Booting WEBrick
311
=> Rails 4.1.1 application starting in development on http://0.0.0.0:3000
312 313 314 315 316 317 318 319 320 321
=> Run `rails server -h` for more startup options
=> Notice: server is listening on all interfaces (0.0.0.0). Consider using 127.0.0.1 (--binding option)
=> Ctrl-C to shutdown server
[2014-04-11 13:11:47] INFO  WEBrick 1.3.1
[2014-04-11 13:11:47] INFO  ruby 2.1.1 (2014-02-24) [i686-linux]
[2014-04-11 13:11:47] INFO  WEBrick::HTTPServer#start: pid=6370 port=3000


Started GET "/" for 127.0.0.1 at 2014-04-11 13:11:48 +0200
  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
322
Processing by ArticlesController#index as HTML
323

324
[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
325
    3:
326 327
    4:   # GET /articles
    5:   # GET /articles.json
328 329
    6:   def index
    7:     byebug
330
=>  8:     @articles = Article.find_recent
331 332 333
    9:
   10:     respond_to do |format|
   11:       format.html # index.html.erb
334
   12:       format.json { render json: @articles }
335 336

(byebug)
337
```
338 339 340 341

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`

342
```
343
(byebug) help
344 345

byebug 2.7.0
346

347
Type 'help <command-name>' for help on a specific command
348

349 350 351 352 353 354 355 356 357 358 359 360 361 362
Available commands:
backtrace  delete   enable  help       list    pry next  restart  source     up
break      disable  eval    info       method  ps        save     step       var
catch      display  exit    interrupt  next    putl      set      thread
condition  down     finish  irb        p       quit      show     trace
continue   edit     frame   kill       pp      reload    skip     undisplay
```

TIP: To view the help menu for any command use `help <command-name>` at the
debugger prompt. For example: _`help 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, for example.

To see the previous ten lines you should type `list-` (or `l-`)
363

364
```
365
(byebug) l-
366

367 368 369
[1, 10] in /PathTo/project/app/controllers/articles_controller.rb
   1  class ArticlesController < ApplicationController
   2    before_action :set_article, only: [:show, :edit, :update, :destroy]
370
   3
371 372
   4    # GET /articles
   5    # GET /articles.json
373 374
   6    def index
   7      byebug
375
   8      @articles = Article.find_recent
376 377 378
   9
   10      respond_to do |format|

379
```
380

381
This way you can move inside the file, being able to see the code above and over
R
Robin Dupret 已提交
382
the line where you added the `byebug` call. Finally, to see where you are in
383
the code again you can type `list=`
384

385
```
386
(byebug) list=
387

388
[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
389
    3:
390 391
    4:   # GET /articles
    5:   # GET /articles.json
392 393
    6:   def index
    7:     byebug
394
=>  8:     @articles = Article.find_recent
395 396 397
    9:
   10:     respond_to do |format|
   11:       format.html # index.html.erb
398
   12:       format.json { render json: @articles }
399 400

(byebug)
401
```
402

403
### The Context
404

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

408 409 410 411 412
The debugger creates a context when a stopping point or an event is reached. The
context has information about the suspended program which enables the 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.
413

414 415 416 417
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.
418

419
```
420
(byebug) where
421 422
--> #0  ArticlesController.index
      at /PathTo/project/test_app/app/controllers/articles_controller.rb:8
423
    #1  ActionController::ImplicitRender.send_action(method#String, *args#Array)
424
      at /PathToGems/actionpack-4.1.1/lib/action_controller/metal/implicit_render.rb:4
425
    #2  AbstractController::Base.process_action(action#NilClass, *args#Array)
426
      at /PathToGems/actionpack-4.1.1/lib/abstract_controller/base.rb:189
427
    #3  ActionController::Rendering.process_action(action#NilClass, *args#NilClass)
428
      at /PathToGems/actionpack-4.1.1/lib/action_controller/metal/rendering.rb:10
429
...
430
```
431

432 433 434 435
The current frame is marked with `-->`. You can move anywhere you want in this
trace (thus changing the context) by using the `frame _n_` command, where _n_ is
the specified frame number. If you do that, `byebug` will display your new
context.
436

437
```
438
(byebug) frame 2
439

440
[184, 193] in /PathToGems/actionpack-4.1.1/lib/abstract_controller/base.rb
441 442 443 444 445 446 447 448 449 450 451 452
   184:       # is the intended way to override action dispatching.
   185:       #
   186:       # Notice that the first argument is the method to be dispatched
   187:       # which is *not* necessarily the same as the action name.
   188:       def process_action(method_name, *args)
=> 189:         send_action(method_name, *args)
   190:       end
   191:
   192:       # Actually call the method associated with the action. Override
   193:       # this method if you wish to change how action methods are called,

(byebug)
453
```
454

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

458 459 460 461
You can also 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.
462

463
### Threads
464

465
The debugger can list, stop, resume and switch between running threads by using
R
Robin Dupret 已提交
466
the `thread` command (or the abbreviated `th`). This command has a handful of
467
options:
468

469
* `thread` shows the current thread.
470 471
* `thread list` is used to list all threads and their statuses. The plus +
character and the number indicates the current thread of execution.
472 473 474
* `thread stop _n_` stop thread _n_.
* `thread resume _n_` resumes thread _n_.
* `thread switch _n_` switches the current thread context to _n_.
475

476 477 478
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.
479

480
### Inspecting Variables
481

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

R
Robin Dupret 已提交
485
This example shows how you can print the instance variables defined within the
486
current context:
487

488
```
489
[3, 12] in /PathTo/project/app/controllers/articles_controller.rb
490
    3:
491 492
    4:   # GET /articles
    5:   # GET /articles.json
493 494
    6:   def index
    7:     byebug
495
=>  8:     @articles = Article.find_recent
496 497 498
    9:
   10:     respond_to do |format|
   11:       format.html # index.html.erb
499
   12:       format.json { render json: @articles }
500

501
(byebug) instance_variables
502 503 504
[:@_action_has_layout, :@_routes, :@_headers, :@_status, :@_request,
 :@_response, :@_env, :@_prefixes, :@_lookup_context, :@_action_name,
 :@_response_body, :@marked_for_same_origin_verification, :@_config]
505
```
506

507 508 509 510
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).
511

512
```
513
(byebug) next
514 515
[5, 14] in /PathTo/project/app/controllers/articles_controller.rb
   5     # GET /articles.json
516 517
   6     def index
   7       byebug
518
   8       @articles = Article.find_recent
519 520 521
   9
=> 10       respond_to do |format|
   11         format.html # index.html.erb
522
   12        format.json { render json: @articles }
523 524 525 526
   13      end
   14    end
   15
(byebug)
527
```
528 529 530

And then ask again for the instance_variables:

531
```
532
(byebug) instance_variables.include? "@articles"
533
true
534
```
535

536
Now `@articles` is included in the instance variables, because the line defining it
537
was executed.
538

539 540 541
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.
542

543 544
The `var` method is the most convenient way to show variables and their values.
Let's let `byebug` to help us with it.
545

546
```
547 548 549 550 551 552
(byebug) help var
v[ar] cl[ass]                   show class variables of self
v[ar] const <object>            show constants of object
v[ar] g[lobal]                  show global variables
v[ar] i[nstance] <object>       show instance variables of object
v[ar] l[ocal]                   show local variables
553
```
554

555
This is a great way to inspect the values of the current context variables. For
556
example, to check that we have no local variables currently defined.
557

558
```
559
(byebug) var local
560
(byebug)
561
```
562 563 564

You can also inspect for an object method this way:

565
```
566
(byebug) var instance Article.new
567 568 569 570
@_start_transaction_state = {}
@aggregation_cache = {}
@association_cache = {}
@attributes = {"id"=>nil, "created_at"=>nil, "updated_at"=>nil}
571
@attributes_cache = {}
572 573
@changed_attributes = nil
...
574
```
575

576 577
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.
578

579 580
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.
581

582
```
583 584
(byebug) display @articles
1: @articles = nil
585
```
586

587 588 589
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).
590

591
### Step by Step
592

593 594 595
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.
596

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

600
You may also use `next` which is similar to step, but function or method calls
601 602 603
that appear within the line of code are executed without stopping.

TIP: You can also use `step n` or `next n` to move forwards `n` steps at once.
604

605 606 607
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.
608

609
For example, consider the following situation:
610

611
```ruby
612
Started GET "/" for 127.0.0.1 at 2014-04-11 13:39:23 +0200
613
Processing by ArticlesController#index as HTML
614

615 616
[1, 8] in /home/davidr/Proyectos/test_app/app/models/article.rb
   1: class Article < ActiveRecord::Base
617 618 619 620 621 622 623
   2:
   3:   def self.find_recent(limit = 10)
   4:     byebug
=> 5:     where('created_at > ?', 1.week.ago).limit(limit)
   6:   end
   7:
   8: end
624

625
(byebug)
626
```
627

R
Robin Dupret 已提交
628
If we use `next`, we want go deep inside method calls. Instead, byebug will go
629 630 631
to the next line within the same context. In this case, this is the last line of
the method, so `byebug` will jump to next next line of the previous frame.

632
```
633 634 635
(byebug) next
Next went up a frame because previous frame finished

636 637 638
[4, 13] in /PathTo/project/test_app/app/controllers/articles_controller.rb
    4:   # GET /articles
    5:   # GET /articles.json
639
    6:   def index
640
    7:     @articles = Article.find_recent
641 642 643
    8:
=>  9:     respond_to do |format|
   10:       format.html # index.html.erb
644
   11:       format.json { render json: @articles }
645 646 647
   12:     end
   13:   end

648
(byebug)
649
```
650

651 652
If we use `step` in the same situation, we will literally go the next ruby
instruction to be executed. In this case, the activesupport's `week` method.
653

654
```
655
(byebug) step
656

657
[50, 59] in /PathToGems/activesupport-4.1.1/lib/active_support/core_ext/numeric/time.rb
658 659 660 661 662 663 664 665 666 667
   50:     ActiveSupport::Duration.new(self * 24.hours, [[:days, self]])
   51:   end
   52:   alias :day :days
   53:
   54:   def weeks
=> 55:     ActiveSupport::Duration.new(self * 7.days, [[:days, self * 7]])
   56:   end
   57:   alias :week :weeks
   58:
   59:   def fortnights
668

669
(byebug)
670
```
671

672 673
This is one of the best ways to find bugs in your code, or perhaps in Ruby on
Rails.
674

675
### Breakpoints
676

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

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

683
* `break line`: set breakpoint in the _line_ in the current source file.
684 685 686 687 688 689 690
* `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.

691

692 693
For example, in the previous situation

694
```
695 696 697
[4, 13] in /PathTo/project/app/controllers/articles_controller.rb
    4:   # GET /articles
    5:   # GET /articles.json
698
    6:   def index
699
    7:     @articles = Article.find_recent
700 701 702
    8:
=>  9:     respond_to do |format|
   10:       format.html # index.html.erb
703
   11:       format.json { render json: @articles }
704 705 706 707
   12:     end
   13:   end

(byebug) break 11
708
Created breakpoint 1 at /PathTo/project/app/controllers/articles_controller.rb:11
709

710
```
711

712 713
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.
714

715
```
716
(byebug) info breakpoints
717
Num Enb What
718
1   y   at /PathTo/project/app/controllers/articles_controller.rb:11
719
```
720

721 722 723
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.
724

725
```
726 727
(byebug) delete 1
(byebug) info breakpoints
728
No breakpoints.
729
```
730 731 732

You can also enable or disable breakpoints:

R
Robin Dupret 已提交
733
* `enable breakpoints`: allow a _breakpoints_ list or all of them if no list is
734 735
specified, to stop your program. This is the default state when you create a
breakpoint.
736
* `disable breakpoints`: the _breakpoints_ will have no effect on your program.
737

738
### Catching Exceptions
739

740 741 742
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 no
handler for it.
743

744
To list all active catchpoints use `catch`.
745

746
### Resuming Execution
747

748 749 750 751 752 753 754 755 756 757 758 759 760 761
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.
762

763
### Editing
764 765 766

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

767 768
* `edit [file:line]`: edit _file_ using the editor specified by the EDITOR
environment variable. A specific _line_ can also be given.
769

770
### Quitting
771

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

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

778
### Settings
779

780
`byebug` has a few available options to tweak its behaviour:
781

782 783 784 785 786 787
* `set autoreload`: Reload source code when changed (default: true).
* `set autolist`: Execute `list` command on every breakpoint (default: true).
* `set listsize _n_`: Set number of source lines to list by default to _n_
(default: 10)
* `set forcestep`: Make sure the `next` and `step` commands always move to a new
line.
788

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

792 793
TIP: You can save these settings in an `.byebugrc` file in your home directory.
The debugger reads these global settings when it starts. For example:
794

P
Prem Sichanugrist 已提交
795
```bash
796 797
set forcestep
set listsize 25
798
```
799

800 801
Debugging Memory Leaks
----------------------
802

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

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

809
### Valgrind
810

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

814 815 816 817
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.
818

819 820 821
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.
822

823 824
Plugins for Debugging
---------------------
825

826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
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](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.
* [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.
849

850 851
References
----------
852

853
* [ruby-debug Homepage](http://bashdb.sourceforge.net/ruby-debug/home-page.html)
A
Akira Matsuda 已提交
854
* [debugger Homepage](https://github.com/cldwalker/debugger)
855
* [byebug Homepage](https://github.com/deivid-rodriguez/byebug)
K
Ken Lu 已提交
856
* [Article: Debugging a Rails application with ruby-debug](http://www.sitepoint.com/debug-rails-app-ruby-debug/)
857 858 859 860
* [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)