Class: AppMap::Tracer

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

Instance Method Summary collapse

Constructor Details

#initializeTracer

Records the events which happen in a program.



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

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

Instance Method Details

#disableObject

Private function. Use AppMap.tracing#delete.



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

def disable # :nodoc:
  @enabled = false
end

#enableObject



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

def enable
  @enabled = true
end

#enabled?Boolean

Returns:

  • (Boolean)


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

def enabled?
  @enabled
end

#event?Boolean

Whether there is an event available for processing.

Returns:

  • (Boolean)


100
101
102
# File 'lib/appmap/trace.rb', line 100

def event?
  !@events.empty?
end

#event_methodsObject

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



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

def event_methods
  @methods.to_a
end

#last_package_for_current_threadObject

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



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

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

#next_eventObject

Gets the next available event, if any.



105
106
107
# File 'lib/appmap/trace.rb', line 105

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.



80
81
82
83
84
85
86
87
# File 'lib/appmap/trace.rb', line 80

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

  @last_package_for_thread[Thread.current.object_id] = package if package
  @events << event
  @methods << Trace::ScopedMethod.new(package, defined_class, method, event.static) \
    if package && defined_class && method && (event.event == :call)
end