Cleanup and comments

scoutapp · Sep 23, 2019 · 84575a5 · 84575a5
1 parent 7da3f13
commit 84575a5
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 9 deletions.
diff --git a/lib/scout_apm/instant/middleware.rb b/lib/scout_apm/instant/middleware.rb
@@ -94,6 +94,7 @@ def call
 
       def preconditions_met?
         if dev_trace_disabled?
+          # The line below is very noise as it is called on every request.
           # logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
           return false
         end

diff --git a/lib/scout_apm/layer.rb b/lib/scout_apm/layer.rb
@@ -38,7 +38,7 @@ def children
     # backtrace of where it occurred.
     attr_accessor :backtrace
 
-    # The file name associated with the layer. Used for autoinstruments overhead logging.
+    # The file name associated with the layer. Only used for autoinstruments overhead logging.
     attr_accessor :file_name
 
     # As we go through a part of a request, instrumentation can store additional data

diff --git a/lib/scout_apm/periodic_work.rb b/lib/scout_apm/periodic_work.rb
@@ -27,7 +27,7 @@ def log_layer_histograms
           {total: total=v.map(&:last).inject(:+), significant: (v.last.last/total.to_f).round(2)}
         ]
       }.to_h
-      context.logger.debug("AutoInstrument Layer Histograms: #{hists_summary.pretty_inspect}")
+      context.logger.debug("AutoInstrument Significant Layer Histograms: #{hists_summary.pretty_inspect}")
     end
 
     # XXX: Move logic into a RequestHistogramsByTime class that can keep the timeout logic in it

diff --git a/lib/scout_apm/tracked_request.rb b/lib/scout_apm/tracked_request.rb
@@ -183,11 +183,12 @@ def capture_backtrace?(layer)
     # Returns +true+ if the total call time of AutoInstrument layers exceeds +AUTO_INSTRUMENT_TIMING_THRESHOLD+ and
     # records a Histogram of insignificant / significant layers by file name.
     def layer_insignificant?(layer)
-      result = false
+      result = false # default is significant
       if layer.type == 'AutoInstrument'
         if layer.total_call_time < AUTO_INSTRUMENT_TIMING_THRESHOLD
-          result = true
+          result = true # not significant
         end
+        # 0 = not significant, 1 = significant
         @agent_context.auto_instruments_layer_histograms.add(layer.file_name, (result ? 0 : 1))
       end
       result
@@ -236,11 +237,6 @@ def start_request(layer)
     def stop_request
       @stopping = true
 
-      if layer_finder.scope
-        # context.logger.debug("AutoInstrument Ignored Layers [#{layer_finder.scope.name}] : #{@ignored_layers.sort_by{ |k, v| v }.reverse.to_h}")
-        # context.logger.debug("AutoInstrument Kept Layers [#{layer_finder.scope.name}] : #{@kept_layers.sort_by{ |k, v| v }.reverse.to_h}")
-      end
-
       if @recorder
         @recorder.record!(self)
       end