debugging_rails_applications.md 29.2 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 `debug` in all environments.
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
    @article = Article.new(params[:article])
    logger.debug "New article: #{@article.attributes.inspect}"
R
Robin Dupret 已提交
162
    logger.debug "Article should be valid: #{@article.valid?}"
163 164

    if @article.save
R
Robin Dupret 已提交
165
      flash[:notice] =  'Article was successfully created.'
166 167
      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
 "authenticity_token"=>"2059c1286e93402e389127b1153204e0d1e275dd", "action"=>"create", "controller"=>"articles"}
New article: {"updated_at"=>nil, "title"=>"Debugging Rails", "body"=>"I'm learning how to print in logs!!!",
R
Robin Dupret 已提交
187 188
 "published"=>false, "created_at"=>nil}
Article should be valid: true
189
  Article Create (0.000443)   INSERT INTO "articles" ("updated_at", "title", "body", "published",
190 191
 "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')
192 193 194
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]
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
### Impact of Logs on Performance
R
Robin Dupret 已提交
213
Logging will always have a small impact on performance of your rails app,
G
Guo Xiang Tan 已提交
214
        particularly when logging to disk. However, there are a few subtleties:
215 216 217 218 219 220 221 222 223 224 225 226

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

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

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

243
Debugging with the `byebug` gem
244
---------------------------------
245

246 247 248 249 250
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.
251

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

257
### Setup
258

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

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

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

269 270
Here's an example:

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

280
### The Shell
281

282 283 284 285
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
286
displayed and the current line will be marked by '=>'. Like this:
287

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

301
(byebug)
302
```
303

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

308 309 310
For example:

```bash
311
=> Booting WEBrick
R
Robin Dupret 已提交
312
=> Rails 4.2.0 application starting in development on http://0.0.0.0:3000
313 314 315 316 317 318 319 320 321 322
=> 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"
323
Processing by ArticlesController#index as HTML
324

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

(byebug)
338
```
339 340 341 342

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`

343
```
344
(byebug) help
345 346

byebug 2.7.0
347

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

350 351 352 353 354 355 356 357 358 359 360 361 362 363
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-`)
364

365
```
366
(byebug) l-
367

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

380
```
381

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

386
```
387
(byebug) list=
388

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

(byebug)
402
```
403

404
### The Context
405

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

409 410 411 412 413
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.
414

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

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

433 434 435 436
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.
437

438
```
439
(byebug) frame 2
440

R
Robin Dupret 已提交
441
[184, 193] in /PathToGems/actionpack-4.2.0/lib/abstract_controller/base.rb
442 443 444 445 446 447 448 449 450 451 452 453
   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)
454
```
455

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

459 460 461 462
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.
463

464
### Threads
465

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

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

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

481
### Inspecting Variables
482

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

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

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

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

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

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

And then ask again for the instance_variables:

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

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

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

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

547
```
548 549 550 551 552 553
(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
554
```
555

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

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

You can also inspect for an object method this way:

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

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

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

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

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

592
### Step by Step
593

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

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

601
You may also use `next` which is similar to step, but function or method calls
602 603 604
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.
605

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

610
For example, consider the following situation:
611

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

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

626
(byebug)
627
```
628

R
Robin Dupret 已提交
629
If we use `next`, we want go deep inside method calls. Instead, byebug will go
630 631 632
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.

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

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

649
(byebug)
650
```
651

652 653
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.
654

655
```
656
(byebug) step
657

R
Robin Dupret 已提交
658
[50, 59] in /PathToGems/activesupport-4.2.0/lib/active_support/core_ext/numeric/time.rb
659 660 661 662 663 664 665 666 667 668
   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
669

670
(byebug)
671
```
672

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

676
### Breakpoints
677

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

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

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

692

693 694
For example, in the previous situation

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

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

711
```
712

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

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

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

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

You can also enable or disable breakpoints:

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

739
### Catching Exceptions
740

741 742 743
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.
744

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

747
### Resuming Execution
748

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

764
### Editing
765 766 767

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

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

771
### Quitting
772

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

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

779
### Settings
780

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

783 784 785 786 787 788
* `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.
789

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

793 794
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:
795

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

801 802
Debugging Memory Leaks
----------------------
803

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

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

810
### Valgrind
811

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

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

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

824 825
Plugins for Debugging
---------------------
826

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

851 852
References
----------
853

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