This repository was archived by the owner on Jan 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdebugging_rails_applications.html
More file actions
910 lines (844 loc) · 48.3 KB
/
debugging_rails_applications.html
File metadata and controls
910 lines (844 loc) · 48.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Ruby on Rails Guides: Debugging Rails Applications</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
</head>
<body class="guide">
<div id="topNav">
<div class="wrapper">
<strong>More at <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<a href="http://rubyonrails.org/">Overview</a> |
<a href="http://rubyonrails.org/download">Download</a> |
<a href="http://rubyonrails.org/deploy">Deploy</a> |
<a href="http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/overview">Code</a> |
<a href="http://rubyonrails.org/screencasts">Screencasts</a> |
<a href="http://rubyonrails.org/documentation">Documentation</a> |
<a href="http://rubyonrails.org/ecosystem">Ecosystem</a> |
<a href="http://rubyonrails.org/community">Community</a> |
<a href="http://weblog.rubyonrails.org/">Blog</a>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<p class="hide"><a href="#mainCol">Skip navigation</a>.</p>
<ul class="nav">
<li><a href="index.html">홈</a></li>
<li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">목차</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<dl class="L">
<dt>시작</dt>
<dd><a href="getting_started.html">레일즈 시작하기</a></dd>
<dt>모델(Models)</dt>
<dd><a href="migrations.html">레일즈 데이터베이스 마이그레이션</a></dd>
<dd><a href="active_record_validations_callbacks.html">액티브 레코드 데이터 검증(Validation)과 Callback(콜백)</a></dd>
<dd><a href="association_basics.html">액티브 레코드 Association(관계)</a></dd>
<dd><a href="active_record_querying.html">액티브 레코드 쿼리 인터페이스</a></dd>
<dt>뷰(Views)</dt>
<dd><a href="layouts_and_rendering.html">레이아웃(Layouts)과 렌더링(Rendering)</a></dd>
<dd><a href="form_helpers.html">액션 뷰 폼 핼퍼(Action View Form Helpers)</a></dd>
<dt>컨트롤러(Controllers)</dt>
<dd><a href="action_controller_overview.html">액션 컨트롤러 둘러보기</a></dd>
<dd><a href="routing.html">외부 요청에 대한 레일즈 라우팅</a></dd>
</dl>
<dl class="R">
<dt>심화내용</dt>
<dd><a href="active_support_core_extensions.html">액티브 서포트(Active Support) 확장(Core Extensions)</a></dd>
<dd><a href="i18n.html">레일즈 국제화I(nternationalization) API</a></dd>
<dd><a href="action_mailer_basics.html">액션 메일러의 기본</a></dd>
<dd><a href="testing.html">레일즈 어플리케이션 테스트하기</a></dd>
<dd><a href="security.html">레일즈 어플리케이션의 보안</a></dd>
<dd><a href="debugging_rails_applications.html">레일즈 어플리케이션 디버깅</a></dd>
<dd><a href="performance_testing.html">레일즈 어플리케이션 성능 테스트하기</a></dd>
<dd><a href="configuring.html">레일즈 어플리케이션 설정</a></dd>
<dd><a href="command_line.html">레일즈 커멘드라인 도구와 Rake 테스크</a></dd>
<dd><a href="caching_with_rails.html">레일즈를 이용한 캐싱</a></dd>
<dt>레일즈 확장하기(Extending Rails)</dt>
<dd><a href="plugins.html">레일즈 플러그인 작성의 기본</a></dd>
<dd><a href="rails_on_rack.html">렉 위의 레일즈(Rails on Rack)</a></dd>
<dd><a href="generators.html">레일즈 제너레이터(Generator) 제작과 수정</a></dd>
<dt>루비 온 레이즈에 기여하기</dt>
<dd><a href="contributing_to_ruby_on_rails.html">루비 온 레이즈에 기여하기</a></dd>
<dd><a href="api_documentation_guidelines.html">API 문서 가이드라인</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">루비 온 레일즈 가이드에 대한 가이드라인</a></dd>
<dt>Release Notes</dt>
<dd><a href="3_0_release_notes.html">Ruby on Rails 3.0 Release Notes</a></dd>
<dd><a href="2_3_release_notes.html">Ruby on Rails 2.3 Release Notes</a></dd>
<dd><a href="2_2_release_notes.html">Ruby on Rails 2.2 Release Notes</a></dd>
</dl>
</div>
</li>
<li><a href="contribute.html">기여하기</a></li>
<li><a href="credits.html">수고하신 분들</a></li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>Debugging Rails Applications</h2>
<p>This guide introduces techniques for debugging Ruby on Rails applications. By referring to this guide, you will be able to:</p>
<ul>
<li>Understand the purpose of debugging</li>
<li>Track down problems and issues in your application that your tests aren’t identifying</li>
<li>Learn the different ways of debugging</li>
<li>Analyze the stack trace</li>
</ul>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li><a href="#view-helpers-for-debugging">View Helpers for Debugging</a><ul><li><a href="#debug"><tt>debug</tt></a></li> <li><a href="#to_yaml"><tt>to_yaml</tt></a></li> <li><a href="#inspect"><tt>inspect</tt></a></li> <li><a href="#debugging-rjs">Debugging <span class="caps">RJS</span></a></li></ul></li><li><a href="#the-logger">The Logger</a><ul><li><a href="#what-is-the-logger">What is the Logger?</a></li> <li><a href="#log-levels">Log Levels</a></li> <li><a href="#sending-messages">Sending Messages</a></li></ul></li><li><a href="#debugging-with-ruby-debug">Debugging with <tt>ruby-debug</tt></a><ul><li><a href="#setup">Setup</a></li> <li><a href="#the-shell">The Shell</a></li> <li><a href="#the-context">The Context</a></li> <li><a href="#threads">Threads</a></li> <li><a href="#inspecting-variables">Inspecting Variables</a></li> <li><a href="#step-by-step">Step by Step</a></li> <li><a href="#breakpoints">Breakpoints</a></li> <li><a href="#catching-exceptions">Catching Exceptions</a></li> <li><a href="#resuming-execution">Resuming Execution</a></li> <li><a href="#editing">Editing</a></li> <li><a href="#quitting">Quitting</a></li> <li><a href="#settings">Settings</a></li></ul></li><li><a href="#debugging-memory-leaks">Debugging Memory Leaks</a><ul><li><a href="#bleakhouse">BleakHouse</a></li> <li><a href="#valgrind">Valgrind</a></li></ul></li><li><a href="#plugins-for-debugging">Plugins for Debugging</a></li><li><a href="#references">References</a></li><li><a href="#changelog">Changelog</a></li></ol></div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="view-helpers-for-debugging">1 View Helpers for Debugging</h3>
<p>One common task is to inspect the contents of a variable. In Rails, you can do this with three methods:</p>
<ul>
<li><tt>debug</tt></li>
<li><tt>to_yaml</tt></li>
<li><tt>inspect</tt></li>
</ul>
<h4 id="debug">1.1 <tt>debug</tt></h4>
<p>The <tt>debug</tt> helper will return a <pre>-tag that renders the object using the <span class="caps">YAML</span> format. This will generate human-readable data from any object. For example, if you have this code in a view:</p>
<notextile>
<div class="code_container">
<pre class="brush: xml; gutter: false; toolbar: false">
<%= debug @post %>
<p>
<b>Title:</b>
<%=h @post.title %>
</p>
</pre>
</div>
</notextile>
<p>You’ll see something like this:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
--- !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
</pre>
</div>
</notextile>
<h4 id="to_yaml">1.2 <tt>to_yaml</tt></h4>
<p>Displaying an instance variable, or any other object or method, in <span class="caps">YAML</span> format can be achieved this way:</p>
<notextile>
<div class="code_container">
<pre class="brush: xml; gutter: false; toolbar: false">
<%= simple_format @post.to_yaml %>
<p>
<b>Title:</b>
<%=h @post.title %>
</p>
</pre>
</div>
</notextile>
<p>The <tt>to_yaml</tt> method converts the method to <span class="caps">YAML</span> format leaving it more readable, and then the <tt>simple_format</tt> helper is used to render each line as in the console. This is how <tt>debug</tt> method does its magic.</p>
<p>As a result of this, you will have something like this in your view:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
--- !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
</pre>
</div>
</notextile>
<h4 id="inspect">1.3 <tt>inspect</tt></h4>
<p>Another useful method for displaying object values is <tt>inspect</tt>, especially when working with arrays or hashes. This will print the object value as a string. For example:</p>
<notextile>
<div class="code_container">
<pre class="brush: xml; gutter: false; toolbar: false">
<%= [1, 2, 3, 4, 5].inspect %>
<p>
<b>Title:</b>
<%=h @post.title %>
</p>
</pre>
</div>
</notextile>
<p>Will be rendered as follows:</p>
<pre>
[1, 2, 3, 4, 5]
Title: Rails debugging guide
</pre>
<h4 id="debugging-rjs">1.4 Debugging <span class="caps">RJS</span></h4>
<p>Rails has optional built-in support to debug <span class="caps">RJS</span>. When enabled, responses are wrapped in a try/catch block that displays the caught exception using <tt>alert()</tt>, and then re-raises it.</p>
<p>The flag to enable <span class="caps">RJS</span> debugging in your configuration files is <tt>config.action_view.debug_rjs</tt>:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
config.action_view.debug_rjs = true
</pre>
</div>
</notextile>
<p>or at any time setting <tt>ActionView::Base.debug_rjs</tt>:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
ActionView::Base.debug_rjs = true
</pre>
</div>
</notextile>
<p>It is enabled by default in development mode, and disabled in the rest.</p>
<div class='info'><p>For more information on debugging JavaScript, refer to <a href="http://getfirebug.com/">Firebug</a>, the popular debugger for Firefox.</p></div>
<h3 id="the-logger">2 The Logger</h3>
<p>It can also be useful to save information to log files at runtime. Rails maintains a separate log file for each runtime environment.</p>
<h4 id="what-is-the-logger">2.1 What is the Logger?</h4>
<p>Rails makes use of Ruby’s standard <tt>logger</tt> to write log information. You can also substitute another logger such as <tt>Log4r</tt> if you wish.</p>
<p>You can specify an alternative logger in your <tt>environment.rb</tt> or any environment file:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
Rails.logger = Logger.new(STDOUT)
Rails.logger = Log4r::Logger.new("Application Log")
</pre>
</div>
</notextile>
<p>Or in the <tt>Initializer</tt> section, add <em>any</em> of the following</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
config.logger = Logger.new(STDOUT)
config.logger = Log4r::Logger.new("Application Log")
</pre>
</div>
</notextile>
<div class='info'><p>By default, each log is created under <tt>Rails.root/log/</tt> and the log file name is <tt>environment_name.log</tt>.</p></div>
<h4 id="log-levels">2.2 Log Levels</h4>
<p>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 <tt>Rails.logger.level</tt> method.</p>
<p>The available log levels are: <tt>:debug</tt>, <tt>:info</tt>, <tt>:warn</tt>, <tt>:error</tt>, and <tt>:fatal</tt>, corresponding to the log level numbers from 0 up to 4 respectively. To change the default log level, use</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
config.log_level = Logger::WARN # In any environment initializer, or
Rails.logger.level = 0 # at any time
</pre>
</div>
</notextile>
<p>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.</p>
<div class='info'><p>The default Rails log level is <tt>info</tt> in production mode and <tt>debug</tt> in development and test mode.</p></div>
<h4 id="sending-messages">2.3 Sending Messages</h4>
<p>To write in the current log use the <tt>logger.(debug|info|warn|error|fatal)</tt> method from within a controller, model or mailer:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
logger.debug "Person attributes hash: #{@person.attributes.inspect}"
logger.info "Processing the request..."
logger.fatal "Terminating application, raised unrecoverable error!!!"
</pre>
</div>
</notextile>
<p>Here’s an example of a method instrumented with extra logging:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
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.'
logger.debug "The post was saved and now the user is going to be redirected..."
redirect_to(@post)
else
render :action => "new"
end
end
# ...
end
</pre>
</div>
</notextile>
<p>Here’s an example of the log generated by this method:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
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')
The post was saved and now the user is going to be redirected...
Redirected to #<Post:0x20af760>
Completed in 0.01224 (81 reqs/sec) | DB: 0.00044 (3%) | 302 Found [http://localhost/posts]
</pre>
</div>
</notextile>
<p>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.</p>
<h3 id="debugging-with-ruby-debug">3 Debugging with <tt>ruby-debug</tt></h3>
<p>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.</p>
<p>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.</p>
<h4 id="setup">3.1 Setup</h4>
<p>The debugger used by Rails, <tt>ruby-debug</tt>, comes as a gem. To install it, just run:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ sudo gem install ruby-debug
</pre>
</div>
</notextile>
<div class='info'><p>If you are using Ruby 1.9, you can install a compatible version of <tt>ruby-debug</tt> by running <tt>sudo gem install ruby-debug19</tt></p></div>
<p>In case you want to download a particular version or get the source code, refer to the <a href="http://rubyforge.org/projects/ruby-debug/">project’s page on rubyforge</a>.</p>
<p>Rails has had built-in support for ruby-debug since Rails 2.0. Inside any Rails application you can invoke the debugger by calling the <tt>debugger</tt> method.</p>
<p>Here’s an example:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class PeopleController < ApplicationController
def new
debugger
@person = Person.new
end
end
</pre>
</div>
</notextile>
<p>If you see the message in the console or logs:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
***** Debugger requested, but was not available: Start server with --debugger to enable *****
</pre>
</div>
</notextile>
<p>Make sure you have started your web server with the option <tt>--debugger</tt>:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
~/PathTo/rails_project$ rails server --debugger
=> Booting WEBrick
=> Rails 3.0.0 application starting on http://0.0.0.0:3000
=> Debugger enabled
...
</pre>
</div>
</notextile>
<div class='info'><p>In development mode, you can dynamically <tt>require \'ruby-debug\'</tt> instead of restarting the server, if it was started without <tt>--debugger</tt>.</p></div>
<h4 id="the-shell">3.2 The Shell</h4>
<p>As soon as your application calls the <tt>debugger</tt> method, the debugger will be started in a debugger shell inside the terminal window where you launched your application server, and you will be placed at ruby-debug’s prompt <tt>(rdb:n)</tt>. The <em>n</em> is the thread number. The prompt will also show you the next line of code that is waiting to run.</p>
<p>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.</p>
<p>For example:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
@posts = Post.all
(rdb:7)
</pre>
</div>
</notextile>
<p>Now it’s time to explore and dig into your application. A good place to start is by asking the debugger for help… so type: <tt>help</tt> (You didn’t see that coming, right?)</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(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
</pre>
</div>
</notextile>
<div class='info'><p>To view the help menu for any command use <tt>help <command-name></tt> in active debug mode. For example: <em><tt>help var</tt></em></p></div>
<p>The next command to learn is one of the most useful: <tt>list</tt>. You can also abbreviate ruby-debug commands by supplying just enough letters to distinguish them from other commands, so you can also use <tt>l</tt> for the <tt>list</tt> command.</p>
<p>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 <tt>=></tt>.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:7) list
[1, 10] in /PathToProject/posts_controller.rb
1 class PostsController < ApplicationController
2 # GET /posts
3 # GET /posts.xml
4 def index
5 debugger
=> 6 @posts = Post.all
7
8 respond_to do |format|
9 format.html # index.html.erb
10 format.xml { render :xml => @posts }
</pre>
</div>
</notextile>
<p>If you repeat the <tt>list</tt> command, this time using just <tt>l</tt>, the next ten lines of the file will be printed out.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:7) l
[11, 20] in /PathTo/project/app/controllers/posts_controller.rb
11 end
12 end
13
14 # GET /posts/1
15 # GET /posts/1.xml
16 def show
17 @post = Post.find(params[:id])
18
19 respond_to do |format|
20 format.html # show.html.erb
</pre>
</div>
</notextile>
<p>And so on until the end of the current file. When the end of file is reached, the <tt>list</tt> command will start again from the beginning of the file and continue again up to the end, treating the file as a circular buffer.</p>
<h4 id="the-context">3.3 The Context</h4>
<p>When you start debugging your application, you will be placed in different contexts as you go through the different parts of the stack.</p>
<p>ruby-debug 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.</p>
<p>At any time you can call the <tt>backtrace</tt> command (or its alias <tt>where</tt>) 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 <tt>backtrace</tt> will supply the answer.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(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
...
</pre>
</div>
</notextile>
<p>You move anywhere you want in this trace (thus changing the context) by using the <tt>frame _n_</tt> command, where <em>n</em> is the specified frame number.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:5) frame 2
#2 ActionController::Base.perform_action_without_filters
at line /PathTo/project/vendor/rails/actionpack/lib/action_controller/base.rb:1175
</pre>
</div>
</notextile>
<p>The available variables are the same as if you were running the code line by line. After all, that’s what debugging is.</p>
<p>Moving up and down the stack frame: You can use <tt>up [n]</tt> (<tt>u</tt> for abbreviated) and <tt>down [n]</tt> commands in order to change the context <em>n</em> frames up or down the stack respectively. <em>n</em> defaults to one. Up in this case is towards higher-numbered stack frames, and down is towards lower-numbered stack frames.</p>
<h4 id="threads">3.4 Threads</h4>
<p>The debugger can list, stop, resume and switch between running threads by using the command <tt>thread</tt> (or the abbreviated <tt>th</tt>). This command has a handful of options:</p>
<ul>
<li><tt>thread</tt> shows the current thread.</li>
<li><tt>thread list</tt> is used to list all threads and their statuses. The plus + character and the number indicates the current thread of execution.</li>
<li><tt>thread stop _n_</tt> stop thread <em>n</em>.</li>
<li><tt>thread resume _n_</tt> resumes thread <em>n</em>.</li>
<li><tt>thread switch _n_</tt> switches the current thread context to <em>n</em>.</li>
</ul>
<p>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.</p>
<h4 id="inspecting-variables">3.5 Inspecting Variables</h4>
<p>Any expression can be evaluated in the current context. To evaluate an expression, just type it!</p>
<p>This example shows how you can print the instance_variables defined within the current context:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
@posts = Post.all
(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"]
</pre>
</div>
</notextile>
<p>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 <tt>next</tt> (you’ll learn more about this command later in this guide).</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(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|
</pre>
</div>
</notextile>
<p>And then ask again for the instance_variables:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:11) instance_variables.include? "@posts"
true
</pre>
</div>
</notextile>
<p>Now <tt>@posts</tt> is included in the instance variables, because the line defining it was executed.</p>
<div class='info'><p>You can also step into <strong>irb</strong> mode with the command <tt>irb</tt> (of course!). This way an irb session will be started within the context you invoked it. But be warned: this is an experimental feature.</p></div>
<p>The <tt>var</tt> method is the most convenient way to show variables and their values:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
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
</pre>
</div>
</notextile>
<p>This is a great way to inspect the values of the current context variables. For example:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:9) var local
__dbg_verbose_save => false
</pre>
</div>
</notextile>
<p>You can also inspect for an object method this way:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:9) var instance Post.new
@attributes = {"updated_at"=>nil, "body"=>nil, "title"=>nil, "published"=>nil, "created_at"...
@attributes_cache = {}
@new_record = true
</pre>
</div>
</notextile>
<div class='info'><p>The commands <tt>p</tt> (print) and <tt>pp</tt> (pretty print) can be used to evaluate Ruby expressions and display the value of variables to the console.</p></div>
<p>You can use also <tt>display</tt> to start watching variables. This is a good way of tracking the values of a variable while the execution goes on.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:1) display @recent_comments
1: @recent_comments =
</pre>
</div>
</notextile>
<p>The variables inside the displaying list will be printed with their values after you move in the stack. To stop displaying a variable use <tt>undisplay _n_</tt> where <em>n</em> is the variable number (1 in the last example).</p>
<h4 id="step-by-step">3.6 Step by Step</h4>
<p>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.</p>
<p>Use <tt>step</tt> (abbreviated <tt>s</tt>) to continue running your program until the next logical stopping point and return control to ruby-debug.</p>
<div class='info'><p>You can also use <tt>step</tt> <em>n</em><tt> and </tt>step- _n_+ to move forward or backward <em>n</em> steps respectively.</p></div>
<p>You may also use <tt>next</tt> 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 <em>n</em> steps.</p>
<p>The difference between <tt>next</tt> and <tt>step</tt> is that <tt>step</tt> stops at the next line of code executed, doing just a single step, while <tt>next</tt> moves to the next line without descending inside methods.</p>
<p>For example, consider this block of code with an included <tt>debugger</tt> statement:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
class Author < ActiveRecord::Base
has_one :editorial
has_many :comments
def find_recent_comments(limit = 10)
debugger
@recent_comments ||= comments.find(
:all,
:conditions => ["created_at > ?", 1.week.ago],
:limit => limit
)
end
end
</pre>
</div>
</notextile>
<div class='info'><p>You can use ruby-debug while using <tt>rails console</tt>. Just remember to <tt>require "ruby-debug"</tt> before calling the <tt>debugger</tt> method.</p></div>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
/PathTo/project $ rails console
Loading development environment (Rails 2.1.0)
>> require "ruby-debug"
=> []
>> 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
)
</pre>
</div>
</notextile>
<p>With the code stopped, take a look around:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:1) list
[6, 15] in /PathTo/project/app/models/author.rb
6 debugger
7 @recent_comments ||= comments.find(
8 :all,
9 :conditions => ["created_at > ?", 1.week.ago],
10 :limit => limit
=> 11 )
12 end
13 end
</pre>
</div>
</notextile>
<p>You are at the end of the line, but… was this line executed? You can inspect the instance variables.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:1) var instance
@attributes = {"updated_at"=>"2008-07-31 12:46:10", "id"=>"1", "first_name"=>"Bob", "las...
@attributes_cache = {}
</pre>
</div>
</notextile>
<p><tt>@recent_comments</tt> hasn’t been defined yet, so it’s clear that this line hasn’t been executed yet. Use the <tt>next</tt> command to move on in the code:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(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 = []
</pre>
</div>
</notextile>
<p>Now you can see that the <tt>@comments</tt> relationship was loaded and @recent_comments defined because the line was executed.</p>
<p>If you want to go deeper into the stack trace you can move single <tt>steps</tt>, 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.</p>
<h4 id="breakpoints">3.7 Breakpoints</h4>
<p>A breakpoint makes your application stop whenever a certain point in the program is reached. The debugger shell is invoked in that line.</p>
<p>You can add breakpoints dynamically with the command <tt>break</tt> (or just <tt>b</tt>). There are 3 possible ways of adding breakpoints manually:</p>
<ul>
<li><tt>break line</tt>: set breakpoint in the <em>line</em> in the current source file.</li>
<li><tt>break file:line [if expression]</tt>: set breakpoint in the <em>line</em> number inside the <em>file</em>. If an <em>expression</em> is given it must evaluated to <em>true</em> to fire up the debugger.</li>
<li><tt>break class(.|\#)method [if expression]</tt>: set breakpoint in <em>method</em> (. and \# for class and instance method respectively) defined in <em>class</em>. The <em>expression</em> works the same way as with file:line.</li>
</ul>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:5) break 10
Breakpoint 1 file /PathTo/project/vendor/rails/actionpack/lib/action_controller/filters.rb, line 10
</pre>
</div>
</notextile>
<p>Use <tt>info breakpoints _n_</tt> or <tt>info break _n_</tt> to list breakpoints. If you supply a number, it lists that breakpoint. Otherwise it lists all breakpoints.</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:5) info breakpoints
Num Enb What
1 y at filters.rb:10
</pre>
</div>
</notextile>
<p>To delete breakpoints: use the command <tt>delete _n_</tt> to remove the breakpoint number <em>n</em>. If no number is specified, it deletes all breakpoints that are currently active..</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
(rdb:5) delete 1
(rdb:5) info breakpoints
No breakpoints.
</pre>
</div>
</notextile>
<p>You can also enable or disable breakpoints:</p>
<ul>
<li><tt>enable breakpoints</tt>: allow a list <em>breakpoints</em> or all of them if no list is specified, to stop your program. This is the default state when you create a breakpoint.</li>
<li><tt>disable breakpoints</tt>: the <em>breakpoints</em> will have no effect on your program.</li>
</ul>
<h4 id="catching-exceptions">3.8 Catching Exceptions</h4>
<p>The command <tt>catch exception-name</tt> (or just <tt>cat exception-name</tt>) can be used to intercept an exception of type <em>exception-name</em> when there would otherwise be is no handler for it.</p>
<p>To list all active catchpoints use <tt>catch</tt>.</p>
<h4 id="resuming-execution">3.9 Resuming Execution</h4>
<p>There are two ways to resume execution of an application that is stopped in the debugger:</p>
<ul>
<li><tt>continue</tt> [line-specification] (or <tt>c</tt>): 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.</li>
<li><tt>finish</tt> [frame-number] (or <tt>fin</tt>): 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.</li>
</ul>
<h4 id="editing">3.10 Editing</h4>
<p>Two commands allow you to open code from the debugger into an editor:</p>
<ul>
<li><tt>edit [file:line]</tt>: edit <em>file</em> using the editor specified by the <span class="caps">EDITOR</span> environment variable. A specific <em>line</em> can also be given.</li>
<li><tt>tmate _n_</tt> (abbreviated <tt>tm</tt>): open the current file in TextMate. It uses n-th frame if <em>n</em> is specified.</li>
</ul>
<h4 id="quitting">3.11 Quitting</h4>
<p>To exit the debugger, use the <tt>quit</tt> command (abbreviated <tt>q</tt>), or its alias <tt>exit</tt>.</p>
<p>A simple quit tries to terminate all threads in effect. Therefore your server will be stopped and you will have to start it again.</p>
<h4 id="settings">3.12 Settings</h4>
<p>There are some settings that can be configured in ruby-debug to make it easier to debug your code. Here are a few of the available options:</p>
<ul>
<li><tt>set reload</tt>: Reload source code when changed.</li>
<li><tt>set autolist</tt>: Execute <tt>list</tt> command on every breakpoint.</li>
<li><tt>set listsize _n_</tt>: Set number of source lines to list by default to <em>n</em>.</li>
<li><tt>set forcestep</tt>: Make sure the <tt>next</tt> and <tt>step</tt> commands always move to a new line</li>
</ul>
<p>You can see the full list by using <tt>help set</tt>. Use <tt>help set _subcommand_</tt> to learn about a particular <tt>set</tt> command.</p>
<div class='info'><p>You can include any number of these configuration lines inside a <tt>.rdebugrc</tt> file in your <span class="caps">HOME</span> directory. ruby-debug will read this file every time it is loaded and configure itself accordingly.</p></div>
<p>Here’s a good start for an <tt>.rdebugrc</tt>:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
set autolist
set forcestep
set listsize 25
</pre>
</div>
</notextile>
<h3 id="debugging-memory-leaks">4 Debugging Memory Leaks</h3>
<p>A Ruby application (on Rails or not), can leak memory – either in the Ruby code or at the C code level.</p>
<p>In this section, you will learn how to find and fix such leaks by using tools such as BleakHouse and Valgrind.</p>
<h4 id="bleakhouse">4.1 BleakHouse</h4>
<p><a href="http://github.com/fauna/bleak_house/tree/master">BleakHouse</a> is a library for finding memory leaks.</p>
<p>If a Ruby object does not go out of scope, the Ruby Garbage Collector won’t sweep it since it is referenced somewhere. Leaks like this can grow slowly and your application will consume more and more memory, gradually affecting the overall system performance. This tool will help you find leaks on the Ruby heap.</p>
<p>To install it run:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
sudo gem install bleak_house
</pre>
</div>
</notextile>
<p>Then setup your application for profiling. Then add the following at the bottom of config/environment.rb:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
require 'bleak_house' if ENV['BLEAK_HOUSE']
</pre>
</div>
</notextile>
<p>Start a server instance with BleakHouse integration:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
RAILS_ENV=production BLEAK_HOUSE=1 ruby-bleak-house rails server
</pre>
</div>
</notextile>
<p>Make sure to run a couple hundred requests to get better data samples, then press <tt>CTRL-C</tt>. The server will stop and Bleak House will produce a dumpfile in <tt>/tmp</tt>:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
** BleakHouse: working...
** BleakHouse: complete
** Bleakhouse: run 'bleak /tmp/bleak.5979.0.dump' to analyze.
</pre>
</div>
</notextile>
<p>To analyze it, just run the listed command. The top 20 leakiest lines will be listed:</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
191691 total objects
Final heap size 191691 filled, 220961 free
Displaying top 20 most common line/class pairs
89513 __null__:__null__:__node__
41438 __null__:__null__:String
2348 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:Array
1508 /opt/local//lib/ruby/gems/1.8/specifications/gettext-1.90.0.gemspec:14:String
1021 /opt/local//lib/ruby/gems/1.8/specifications/heel-0.2.0.gemspec:14:String
951 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:111:String
935 /opt/local//lib/ruby/site_ruby/1.8/rubygems/specification.rb:557:String
834 /opt/local//lib/ruby/site_ruby/1.8/rubygems/version.rb:146:Array
...
</pre>
</div>
</notextile>
<p>This way you can find where your application is leaking memory and fix it.</p>
<p>If <a href="http://github.com/fauna/bleak_house/tree/master">BleakHouse</a> doesn’t report any heap growth but you still have memory growth, you might have a broken C extension, or real leak in the interpreter. In that case, try using Valgrind to investigate further.</p>
<h4 id="valgrind">4.2 Valgrind</h4>
<p><a href="http://valgrind.org/">Valgrind</a> is a Linux-only application for detecting C-based memory leaks and race conditions.</p>
<p>There are Valgrind tools that can automatically detect many memory management and threading bugs, and profile your programs in detail. For example, a C extension in the interpreter calls <tt>malloc()</tt> but is doesn’t properly call <tt>free()</tt>, this memory won’t be available until the app terminates.</p>
<p>For further information on how to install Valgrind and use with Ruby, refer to <a href="http://blog.evanweaver.com/articles/2008/02/05/valgrind-and-ruby/">Valgrind and Ruby</a> by Evan Weaver.</p>
<h3 id="plugins-for-debugging">5 Plugins for Debugging</h3>
<p>There are some Rails plugins to help you to find errors and debug your application. Here is a list of useful plugins for debugging:</p>
<ul>
<li><a href="http://github.com/josevalim/rails-footnotes">Footnotes</a>: Every Rails page has footnotes that give request information and link back to your source via TextMate.</li>
<li><a href="http://github.com/ntalbott/query_trace/tree/master">Query Trace</a>: Adds query origin tracing to your logs.</li>
<li><a href="http://github.com/dan-manges/query_stats/tree/master">Query Stats</a>: A Rails plugin to track database queries.</li>
<li><a href="http://code.google.com/p/query-reviewer/">Query Reviewer</a>: This rails plugin not only runs “<span class="caps">EXPLAIN</span>” before each of your select queries in development, but provides a small <span class="caps">DIV</span> in the rendered output of each page with the summary of warnings for each query that it analyzed.</li>
<li><a href="http://github.com/rails/exception_notification/tree/master">Exception Notifier</a>: Provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application.</li>
<li><a href="http://github.com/defunkt/exception_logger/tree/master">Exception Logger</a>: Logs your Rails exceptions in the database and provides a funky web interface to manage them.</li>
</ul>
<h3 id="references">6 References</h3>
<ul>
<li><a href="http://www.datanoise.com/ruby-debug">ruby-debug Homepage</a></li>
<li><a href="http://www.sitepoint.com/article/debug-rails-app-ruby-debug/">Article: Debugging a Rails application with ruby-debug</a></li>
<li><a href="http://brian.maybeyoureinsane.net/blog/2007/05/07/ruby-debug-basics-screencast/">ruby-debug Basics screencast</a></li>
<li><a href="http://railscasts.com/episodes/54-debugging-with-ruby-debug">Ryan Bate’s ruby-debug screencast</a></li>
<li><a href="http://railscasts.com/episodes/24-the-stack-trace">Ryan Bate’s stack trace screencast</a></li>
<li><a href="http://railscasts.com/episodes/56-the-logger">Ryan Bate’s logger screencast</a></li>
<li><a href="http://bashdb.sourceforge.net/ruby-debug.html">Debugging with ruby-debug</a></li>
<li><a href="http://cheat.errtheblog.com/s/rdebug/">ruby-debug cheat sheet</a></li>
<li><a href="http://wiki.rubyonrails.org/rails/pages/HowtoConfigureLogging">Ruby on Rails Wiki: How to Configure Logging</a></li>
<li><a href="http://blog.evanweaver.com/files/doc/fauna/bleak_house/files/README.html">Bleak House Documentation</a></li>
</ul>
<h3 id="changelog">7 Changelog</h3>
<ul>
<li>April 4, 2010: Fixed document to validate <span class="caps">XHTML</span> 1.0 Strict. <a href="http://jaimeiniesta.com">Jaime Iniesta</a></li>
<li>November 3, 2008: Accepted for publication. Added <span class="caps">RJS</span>, memory leaks and plugins chapters by <a href="credits.html#miloops">Emilio Tagua</a></li>
<li>October 19, 2008: Copy editing pass by <a href="credits.html#mgunderloy">Mike Gunderloy</a></li>
<li>September 16, 2008: initial version by <a href="credits.html#miloops">Emilio Tagua</a></li>
</ul>
<h3>Feedback</h3>
<p>
You're encouraged to help in keeping the quality of this guide.
</p>
<p>
If you see any typos or factual errors you are confident to
patch, please clone <a href="https://github.com/lifo/docrails">docrails</a>
and push the change yourself. That branch of Rails has public write access.
Commits are still reviewed, but that happens after you've submitted your
contribution. <a href="https://github.com/lifo/docrails">docrails</a> is
cross-merged with master periodically.
</p>
<p>
You may also find incomplete content, or stuff that is not up to date.
Please do add any missing documentation for master. Check the
<a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
Issues may also be reported in <a href="https://github.com/lifo/docrails/issues">Github</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome in the <a href="http://groups.google.com/group/rubyonrails-docs">rubyonrails-docs mailing list</a>.
</p>
</div>
</div>
</div>
<hr class="hide" />
<div id="footer">
<div class="wrapper">
<p>This work is licensed under a <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
<script type="text/javascript" src="javascripts/guides.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
<script type="text/javascript">
SyntaxHighlighter.all()
</script>
</body>
</html>