Class: AppMap::Tracer

Inherits:
Object show all
Defined in:
lib/appmap/trace.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Tracer

Records the events which happen in a program.



119
120
121
122
123
124
125
 
# File 'lib/appmap/trace.rb', line 119

def initialize
  @events = []
  @last_package_for_thread = {}
  @methods = Set.new
  @stack_printer = StackPrinter.new if StackPrinter.enabled?
  @enabled = false
end

Instance Attribute Details

#stacks ⇒ Object

Returns the value of attribute stacks.



116
117
118
 
# File 'lib/appmap/trace.rb', line 116

def stacks
  @stacks
end

Instance Method Details

#disable ⇒ Object

Private function. Use AppMap.tracing#delete.



136
137
138
 
# File 'lib/appmap/trace.rb', line 136

def disable # :nodoc:
  @enabled = false
end

#enable ⇒ Object 



127
128
129
 
# File 'lib/appmap/trace.rb', line 127

def enable
  @enabled = true
end

#enabled? ⇒ Boolean 



131
132
133
 
# File 'lib/appmap/trace.rb', line 131

def enabled?
  @enabled
end

#event? ⇒ Boolean

Whether there is an event available for processing.



177
178
179
 
# File 'lib/appmap/trace.rb', line 177

def event?
  !@events.empty? && @events.first.ready?
end

#event_methods ⇒ Object

Gets a unique list of the methods that were invoked by the program.



172
173
174
 
# File 'lib/appmap/trace.rb', line 172

def event_methods
  @methods.to_a
end

#last_package_for_current_thread ⇒ Object

Gets the last package which was observed on the current thread.



167
168
169
 
# File 'lib/appmap/trace.rb', line 167

def last_package_for_current_thread
  @last_package_for_thread[Thread.current.object_id]
end

#next_event ⇒ Object

Gets the next available event, if any.



182
183
184
 
# File 'lib/appmap/trace.rb', line 182

def next_event
  @events.shift if event?
end

#record_event(event, package: nil, defined_class: nil, method: nil) ⇒ Object

Record a program execution event.

The event should be one of the MethodEvent subclasses.



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/appmap/trace.rb', line 143

def record_event(event, package: nil, defined_class: nil, method: nil)
  return unless @enabled

  @stack_printer.record(event) if @stack_printer
  @last_package_for_thread[Thread.current.object_id] = package if package
  @events << event
  static = event.static if event.respond_to?(:static)
  record_method Trace::RubyMethod.new(package, defined_class, method, static) \
    if package && defined_class && method && (event.event == :call)
end

#record_method(method) ⇒ Object

method should be duck-typed to respond to the following:

  • package
  • defined_class
  • name
  • static
  • comment
  • labels
  • source_location


162
163
164
 
# File 'lib/appmap/trace.rb', line 162

def record_method(method)
  @methods << method
end