Tracer
Outputs a source level execution trace of a Ruby program.
It does this by registering an event handler with Kernel#set_trace_func for processing incoming events. It also provides methods for filtering unwanted trace output (see Tracer.add_filter, Tracer.on, and Tracer.off).
Example
Consider the following Ruby script
class A def square(a) return a*a end end a = A.new a.square(5)
Running the above script using ruby -r tracer example.rb will output the following trace to STDOUT (Note you can also explicitly require ‘tracer’)
#0:<internal:lib/rubygems/custom_require>:38:Kernel:<: - #0:example.rb:3::-: class A #0:example.rb:3::C: class A #0:example.rb:4::-: def square(a) #0:example.rb:7::E: end #0:example.rb:9::-: a = A.new #0:example.rb:10::-: a.square(5) #0:example.rb:4:A:>: def square(a) #0:example.rb:5:A:-: return a*a #0:example.rb:6:A:<: end | | | | | | | | | ---------------------+ event | | | ------------------------+ class | | --------------------------+ line | ------------------------------------+ filename ---------------------------------------+ thread
Symbol table used for displaying incoming events:
+}+ |
call a C-language routine |
+{+ |
return from a C-language routine |
+>+ |
call a Ruby method |
C |
start a class or module definition |
E |
finish a class or module definition |
- |
|
+^+ |
raise an exception |
+<+ |
return from a Ruby method |
Copyright
by Keiju ISHITSUKA([email protected])
Constants
EVENT_SYMBOL = {\n"line" => "-",\n"call" => ">",\n"return" => "<",\n"class" => "C",\n"end" => "E",\n"raise" => "^",\n"c-call" => "}",\n"c-return" => "{",\n"unknown" => "?"\n}
Single = new
Attributes
| [RW] | display_c_call |
| [RW] | display_c_call? |
| [RW] | display_process_id |
| [RW] | display_process_id? |
| [RW] | display_thread_id |
| [RW] | display_thread_id? |
| [RW] | stdout |
| [R] | stdout_mutex |
| [RW] | verbose |
| [RW] | verbose? |
Files
- lib/debug.rb
- lib/tracer.rb