Class: ScoutApm::LayerConverters::SlowJobConverter

Inherits:
ConverterBase
  • Object
show all
Defined in:
lib/scout_apm/layer_converters/slow_job_converter.rb

Instance Attribute Summary

Attributes inherited from ConverterBase

#request, #root_layer, #walker

Instance Method Summary collapse

Methods inherited from ConverterBase

#scope_layer

Constructor Details

#initialize ⇒ SlowJobConverter

Returns a new instance of SlowJobConverter.



4
5
6
7
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 4

def initialize(*)
  @backtraces = []
  super
end

Instance Method Details

#attach_backtraces(metric_hash) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 104

def attach_backtraces(metric_hash)
  ScoutApm::Agent.instance.logger.info("Attaching backtraces to job #{@backtraces}")
  @backtraces.each do |meta_with_backtrace|
    metric_hash.keys.find { |k| k == meta_with_backtrace }.backtrace = meta_with_backtrace.backtrace
  end
  metric_hash
end

#call ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 9

def call
  return unless request.job?

  job_name = [queue_layer.name, job_layer.name]

  slow_enough = ScoutApm::Agent.instance.slow_job_policy.slow?(job_name, root_layer.total_call_time)
  return unless slow_enough

  SlowJobRecord.new(
    queue_layer.name,
    job_layer.name,
    root_layer.stop_time,
    job_layer.total_call_time,
    job_layer.total_exclusive_time,
    request.context,
    create_metrics)
end

#create_metrics ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 41

def create_metrics
  metric_hash = Hash.new

  # Keep a list of subscopes, but only ever use the front one.  The rest
  # get pushed/popped in cases when we have many levels of subscopable
  # layers.  This lets us push/pop without otherwise keeping track very closely.
  subscope_layers = []

  walker.before do |layer|
    if layer.subscopable?
      subscope_layers.push(layer)
    end
  end

  walker.after do |layer|
    if layer.subscopable?
      subscope_layers.pop
    end
  end

  walker.walk do |layer|
    next if layer == queue_layer

    meta_options = if subscope_layers.first && layer != subscope_layers.first # Don't scope under ourself.
                     subscope_name = subscope_layers.first.legacy_metric_name
                     {:scope => subscope_name}
                   elsif layer == job_layer # We don't scope the controller under itself
                     {}
                   else
                     {:scope => job_layer.legacy_metric_name}
                   end

    # Specific Metric
    meta_options.merge!(:desc => layer.desc.to_s) if layer.desc
    meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
    if layer.backtrace
      bt = ScoutApm::Utils::BacktraceParser.new(layer.backtrace).call
      if bt.any? # we could walk thru the call stack and not find in-app code
        meta.backtrace = bt
        # Why not just call meta.backtrace and call it done? The walker could access a later later that generates the same MetricMeta but doesn't have a backtrace. This could be
        # lost in the metric_hash if it is replaced by the new key.
        @backtraces << meta
      else
        ScoutApm::Agent.instance.logger.debug { "Unable to capture an app-specific backtrace for #{meta.inspect}\n#{layer.backtrace}" }
      end
    end

    metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
    stat = metric_hash[meta]
    stat.update!(layer.total_call_time, layer.total_exclusive_time)

    # Merged Metric (no specifics, just sum up by type)
    meta = MetricMeta.new("#{layer.type}/all")
    metric_hash[meta] ||= MetricStats.new(false)
    stat = metric_hash[meta]
    stat.update!(layer.total_call_time, layer.total_exclusive_time)
  end

  metric_hash = attach_backtraces(metric_hash)

  metric_hash
end

#find_first_layer_of_type(layer_type) ⇒ Object 



35
36
37
38
39
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 35

def find_first_layer_of_type(layer_type)
  walker.walk do |layer|
    return layer if layer.type == layer_type
  end
end

#job_layer ⇒ Object 



31
32
33
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 31

def job_layer
  @job_layer ||= find_first_layer_of_type("Job")
end

#queue_layer ⇒ Object 



27
28
29
 
# File 'lib/scout_apm/layer_converters/slow_job_converter.rb', line 27

def queue_layer
  @queue_layer ||= find_first_layer_of_type("Queue")
end