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.



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

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

Instance Method Details

#disable ⇒ Object

Private function. Use AppMap.tracing#delete.



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

def disable # :nodoc:
  @enabled = false
end

#enable ⇒ Object 



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

def enable
  @enabled = true
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/appmap/trace.rb', line 63

def enabled?
  @enabled
end

#event? ⇒ Boolean

Whether there is an event available for processing.

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/appmap/trace.rb', line 89

def event?
  !@events.empty?
end

#event_methods ⇒ Object

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



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

def event_methods
  @methods.to_a
end

#next_event ⇒ Object

Gets the next available event, if any.



94
95
96
 
# File 'lib/appmap/trace.rb', line 94

def next_event
  @events.shift
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.



75
76
77
78
79
80
81
 
# File 'lib/appmap/trace.rb', line 75

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

  @events << event
  @methods << Trace::ScopedMethod.new(package, defined_class, method, event.static) \
    if package && defined_class && method && (event.event == :call)
end