Class: ScoutApm::Utils::BacktraceParser

Inherits:
Object
  • Object
show all
Defined in:
lib/scout_apm/utils/backtrace_parser.rb

Constant Summary collapse

APP_FRAMES =

will return this many backtrace frames from the app stack.

8

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(call_stack, root = ScoutApm::Agent.instance.context.environment.root, additional_dirs = ScoutApm::Agent.instance.context.config.value('backtrace_additional_directories')) ⇒ BacktraceParser

call_stack - an Array of calls, typically generated via the caller method. Example single line: “/Users/dlite/.rvm/rubies/ruby-2.4.5/lib/ruby/2.4.0/irb/workspace.rb:87:in ‘eval’” additional_dirs - an Array of additional directory names to include beyond lib/, app/, and config/



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/scout_apm/utils/backtrace_parser.rb', line 18

def initialize(call_stack, root=ScoutApm::Agent.instance.context.environment.root, additional_dirs=ScoutApm::Agent.instance.context.config.value('backtrace_additional_directories'))
  @call_stack = call_stack
  # We can't use a constant as it'd be too early to fetch environment info
  #
  # This regex looks for files under the app root, inside lib/, app/, and
  # config/ dirs (plus any additional configured directories), and captures the path under root.
  base_dirs = %w[lib app config]
  all_dirs = base_dirs + Array(additional_dirs)
  dir_pattern = all_dirs.map { |d| Regexp.escape(d) + "/" }.join("|")
  @@app_dir_regex = %r[#{root}/((?:#{dir_pattern}).*)]
end

Instance Attribute Details

#call_stack ⇒ Object (readonly)

Returns the value of attribute call_stack.



12
13
14
 
# File 'lib/scout_apm/utils/backtrace_parser.rb', line 12

def call_stack
  @call_stack
end

Instance Method Details

#call ⇒ Object 



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/scout_apm/utils/backtrace_parser.rb', line 30

def call
  stack = []
  call_stack.each do |c|
    if m = c.match(@@app_dir_regex)
      stack << ScoutApm::Utils::Scm.relative_scm_path(m[1])
      break if stack.size == APP_FRAMES
    end
  end
  stack
end