Class: AppMap::Tracer

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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Tracer

Records the events which happen in a program.



44
45
46
47
48
 
# File 'lib/appmap/trace.rb', line 44

def initialize
  @events = []
  @methods = Set.new
  @enabled = false
end

Instance Method Details

#disable ⇒ Object

Private function. Use AppMap.tracing#delete.



59
60
61
 
# File 'lib/appmap/trace.rb', line 59

def disable # :nodoc:
  @enabled = false
end

#enable ⇒ Object 



50
51
52
 
# File 'lib/appmap/trace.rb', line 50

def enable
  @enabled = true
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/appmap/trace.rb', line 54

def enabled?
  @enabled
end

#event? ⇒ Boolean

Whether there is an event available for processing.

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/appmap/trace.rb', line 79

def event?
  !@events.empty?
end

#event_methods ⇒ Object

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



74
75
76
 
# File 'lib/appmap/trace.rb', line 74

def event_methods
  @methods.to_a
end

#next_event ⇒ Object

Gets the next available event, if any.



84
85
86
 
# File 'lib/appmap/trace.rb', line 84

def next_event
  @events.shift
end

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

Record a program execution event.

The event should be one of the MethodEvent subclasses.



66
67
68
69
70
71
 
# File 'lib/appmap/trace.rb', line 66

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

  @events << event
  @methods << Trace::ScopedMethod.new(defined_class, method) if defined_class && method
end