scout_apm 2.4.12 → 2.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7e5d2b9fe9d2fd469d56bda28c282bd2b100d35
-  data.tar.gz: 3da3eba76be22b53891292dca9675c3dd03b198a
+  metadata.gz: 2ec07b46e556c0beae2648d2c25a610199814179
+  data.tar.gz: ed6284b5c6a58a7ab08a464eb6e60cb65334d12f
 SHA512:
-  metadata.gz: fd1c158b0acae2f310e15312af1eb7a258cbbf1fa4566e609c40eca4157406d54d2a50e9c13cde6d7c82af52ccc3d0e76c4f8d6cfb8b05a151da2da29f1b1550
-  data.tar.gz: 561089fdc52667d956594f473b60086d5c3d5a536936a84963c5e28a30e2c4ef5b4ef211b6ddd833b58044ad4b18acd5e4941e945b337032b4f7f281f550db6d
+  metadata.gz: 15c5a89d33a1af9e605a03390b9344cfad0ceefbb18a3afe6800c4afb3797bca60af57d15ef0323165e344d55454877d15e8455f12e3ba5fd15bf3c3eaf01867
+  data.tar.gz: 1caf6345c5900c54a493aa87bd95168fa5733ae91a7b73211094045b0437c707e6e755286481d89514f43dca1a8a2e31f3a8eeb5dec8cbbabdfebbfb8aed52ac

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 2.4.13
+
+* Incorporating total time consumed into transaction trace policy
+
 # 2.4.12
 
 * Calculates DelayedJob queue latency correctly when jobs are scheduled to run in the future

data/lib/scout_apm/agent_context.rb

@@ -114,6 +114,10 @@ module ScoutApm
       @request_histograms_by_time ||= Hash.new { |h, k| h[k] = ScoutApm::RequestHistograms.new }
     end
 
+    def transaction_time_consumed
+      @transaction_time_consumed ||= ScoutApm::TransactionTimeConsumed.new
+    end
+
     def store
       return @store if @store
       self.store = ScoutApm::Store.new(self)

data/lib/scout_apm/config.rb

@@ -20,6 +20,7 @@ require 'scout_apm/environment'
 # key              - the account key with Scout APM. Found in Settings in the Web UI
 # log_file_path    - either a directory or "STDOUT".
 # log_level        - DEBUG / INFO / WARN as usual
+# max_traces       - Internal: An experiment in trace quality, this requires a server-side setting as well. Setting this to a higher value will make your app server work harder for no benefit.
 # monitor          - true or false.  False prevents any instrumentation from starting
 # name             - override the name reported to APM. This is the name that shows in the Web UI
 # profile          - turn on/off scoutprof (only applicable in Gem versions including scoutprof)
@@ -57,6 +58,7 @@ module ScoutApm
         'log_level',
         'log_stderr',
         'log_stdout',
+        'max_traces',
         'monitor',
         'name',
         'profile',
@@ -151,6 +153,7 @@ module ScoutApm
       "dev_trace"              => BooleanCoercion.new,
       "enable_background_jobs" => BooleanCoercion.new,
       "ignore"                 => JsonCoercion.new,
+      "max_traces"             => IntegerCoercion.new,
       "monitor"                => BooleanCoercion.new,
       'database_metric_limit'  => IntegerCoercion.new,
       'database_metric_report_limit' => IntegerCoercion.new,
@@ -250,6 +253,7 @@ module ScoutApm
         'host'                   => 'https://checkin.scoutapp.com',
         'ignore'                 => [],
         'log_level'              => 'info',
+        'max_traces'             => 10,
         'profile'                => true, # for scoutprof
         'report_format'          => 'json',
         'scm_subdirectory'       => '',

data/lib/scout_apm/slow_job_policy.rb

@@ -17,6 +17,10 @@ module ScoutApm
     # Outliers are worth up to "1000ms" of weight
     POINT_MULTIPLIER_PERCENTILE = 1.0
 
+    # Points for an endpoint's who's throughput * response time is a large % of
+    # overall time spent processing requests
+    POINT_MULTIPLIER_PERCENT_TIME = 2.5
+
     # A hash of Job Names to the last time we stored a slow trace for it.
     #
     # Defaults to a start time that is pretty close to application boot time.
@@ -60,7 +64,9 @@ module ScoutApm
       # What approximate percentile was this request?
       percentile = context.request_histograms.approximate_quantile_of_value(unique_name, total_time)
 
-      return speed_points(total_time) + percentile_points(percentile) + age_points(age)
+      percent_of_total_time = context.transaction_time_consumed.percent_of_total(unique_name)
+
+      return speed_points(total_time) + percentile_points(percentile) + age_points(age) + percent_time_points(percent_of_total_time)
     end
 
     private
@@ -90,5 +96,16 @@ module ScoutApm
     def age_points(age)
       age / 60.0 * POINT_MULTIPLIER_AGE
     end
+
+    # Of the total time spent handling endpoints in this app, if this endpoint
+    # is a higher percent, it should get more points.
+    #
+    # A: 20 calls @ 100ms each => 2 seconds of total time
+    # B: 10 calls @ 100ms each => 1 second of total time
+    #
+    # Then A is 66% of the total call time
+    def percent_time_points(percent) # Scale 0.0 - 1.0
+      percent * POINT_MULTIPLIER_PERCENT_TIME
+    end
   end
 end

data/lib/scout_apm/slow_request_policy.rb

@@ -17,6 +17,10 @@ module ScoutApm
     # Outliers are worth up to "1000ms" of weight
     POINT_MULTIPLIER_PERCENTILE = 1.0
 
+    # Points for an endpoint's who's throughput * response time is a large % of
+    # overall time spent processing requests
+    POINT_MULTIPLIER_PERCENT_TIME = 2.5
+
     # A hash of Endpoint Name to the last time we stored a slow transaction for it.
     #
     # Defaults to a start time that is pretty close to application boot time.
@@ -60,7 +64,9 @@ module ScoutApm
       # What approximate percentile was this request?
       percentile = context.request_histograms.approximate_quantile_of_value(unique_name, total_time)
 
-      return speed_points(total_time) + percentile_points(percentile) + age_points(age)
+      percent_of_total_time = context.transaction_time_consumed.percent_of_total(unique_name)
+
+      return speed_points(total_time) + percentile_points(percentile) + age_points(age) + percent_time_points(percent_of_total_time)
     end
 
     private
@@ -90,5 +96,16 @@ module ScoutApm
     def age_points(age)
       age / 60.0 * POINT_MULTIPLIER_AGE
     end
+
+    # Of the total time spent handling endpoints in this app, if this endpoint
+    # is a higher percent, it should get more points.
+    #
+    # A: 20 calls @ 100ms each => 2 seconds of total time
+    # B: 10 calls @ 100ms each => 1 second of total time
+    #
+    # Then A is 66% of the total call time
+    def percent_time_points(percent) # Scale 0.0 - 1.0
+      percent * POINT_MULTIPLIER_PERCENT_TIME
+    end
   end
 end

data/lib/scout_apm/store.rb

@@ -205,8 +205,8 @@ module ScoutApm
     def initialize(timestamp, context)
       @timestamp = timestamp
 
-      @request_traces = ScoredItemSet.new
-      @job_traces = ScoredItemSet.new
+      @request_traces = ScoredItemSet.new(context.config.value('max_traces'))
+      @job_traces = ScoredItemSet.new(context.config.value('max_traces'))
 
       @histograms = []
 

data/lib/scout_apm/tracked_request.rb

@@ -273,6 +273,8 @@ module ScoutApm
 
       apply_name_override
 
+      @agent_context.transaction_time_consumed.add(unique_name, root_layer.total_call_time)
+
       # Make a constant, then call converters.dup.each so it isn't inline?
       converters = {
         :histograms => LayerConverters::Histograms,

data/lib/scout_apm/transaction_time_consumed.rb

@@ -0,0 +1,51 @@
+module ScoutApm
+  class TransactionTimeConsumed
+    # Private Accessor:
+    # A hash of Endpoint Name to an time consumed record
+    attr_reader :endpoints
+    private :endpoints
+
+    # Private Accessor:
+    # The total time spent across all endpoints
+    attr_reader :total_duration
+    private :total_duration
+
+    def initialize
+      @total_duration = 0.0
+      @endpoints = Hash.new { |h, k| h[k] = TotalTimeRecord.new }
+    end
+
+    def add(item, duration)
+      @total_duration += duration.to_f
+      @endpoints[item].add(duration.to_f)
+    end
+
+    def percent_of_total(item)
+      if total_duration == 0.0
+        0
+      else
+        @endpoints[item].total_duration / total_duration
+      end
+    end
+
+    def total_time_for(item)
+      @endpoints[item].total_duration
+    end
+
+    def call_count_for(item)
+      @endpoints[item].count
+    end
+
+    # Time is in seconds
+    TotalTimeRecord = Struct.new(:total_duration, :count) do
+      def initialize
+        super(0, 0)
+      end
+
+      def add(duration)
+        self.total_duration += duration.to_f
+        self.count += 1
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.4.12"
+  VERSION = "2.4.13"
 end
 

data/lib/scout_apm.rb

@@ -138,6 +138,7 @@ require 'scout_apm/slow_request_policy'
 require 'scout_apm/slow_job_policy'
 require 'scout_apm/job_record'
 require 'scout_apm/request_histograms'
+require 'scout_apm/transaction_time_consumed'
 
 require 'scout_apm/attribute_arranger'
 require 'scout_apm/git_revision'

data/test/unit/extensions/periodic_callbacks_test.rb

@@ -38,7 +38,7 @@ class PeriodicCallbacksTest < Minitest::Test
   private
 
   def reporting_period
-    rp = ScoutApm::StoreReportingPeriod.new(ScoutApm::AgentContext.new, Time.at(metadata[:agent_time].to_i))
+    rp = ScoutApm::StoreReportingPeriod.new(Time.at(metadata[:agent_time].to_i), ScoutApm::AgentContext.new)
     rp.absorb_metrics!(metrics)
   end
 
@@ -55,4 +55,4 @@ class PeriodicCallbacksTest < Minitest::Test
     {:app_root=>"/srv/rails_app", :unique_id=>"ID", :agent_version=>"2.4.10", :agent_time=>"1523287920", :agent_pid=>21581, :platform=>"ruby"}
   end
 
-end
+end

data/test/unit/slow_request_policy_test.rb

@@ -37,9 +37,14 @@ class SlowRequestPolicyTest < Minitest::Test
     request.set_duration(10) # 10 seconds
     policy.last_seen[request.unique_name] = Time.now - 120 # 2 minutes since last seen
     @context.request_histograms.add(request.unique_name, 1)
+    @context.transaction_time_consumed.add(request.unique_name, 1)
 
-    # Actual value I have in console is 1.499
-    assert policy.score(request) > 1.45
-    assert policy.score(request) < 1.55
+    # Actual value I have in console is 4.01
+    # Score uses Time.now to compare w/ last_seen, and will tick up slowly as
+    # time passes, hence the range below.
+    score = policy.score(request)
+
+    assert score > 3.95
+    assert score < 4.05
   end
 end

data/test/unit/transaction_time_consumed_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+require 'scout_apm/transaction_time_consumed'
+
+module ScoutApm
+  class TransactionTimeConsumedTest < Minitest::Test
+    def setup
+      @ttc = ScoutApm::TransactionTimeConsumed.new
+    end
+
+    def test_insert_new_times
+      @ttc.add("Controller/Foo", 1.5)
+      @ttc.add("Controller/Foo", 2.75)
+      assert_equal 4.25, @ttc.total_time_for("Controller/Foo")
+    end
+
+    def test_insert_tracks_endpoints_separately
+      @ttc.add("Controller/Foo", 1.5)
+      @ttc.add("Controller/Foo", 2.75)
+      @ttc.add("Controller/Bar", 5)
+      @ttc.add("Controller/Bar", 5)
+      assert_equal 4.25, @ttc.total_time_for("Controller/Foo")
+      assert_equal 10.0, @ttc.total_time_for("Controller/Bar")
+    end
+
+    def test_calculates_percent_of_total
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Bar", 4)
+      assert_equal 0.2, @ttc.percent_of_total("Controller/Foo")
+      assert_equal 0.8, @ttc.percent_of_total("Controller/Bar")
+    end
+
+    def test_counts_total_call_count
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Bar", 4)
+      assert_equal 3, @ttc.call_count_for("Controller/Foo")
+      assert_equal 1, @ttc.call_count_for("Controller/Bar")
+    end
+
+    def test_percent_of_total_is_0_with_no_data
+      assert_equal 0.0, @ttc.percent_of_total("Controller/Foo")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.12
+  version: 2.4.13
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -310,6 +310,7 @@ files:
 - lib/scout_apm/tracer.rb
 - lib/scout_apm/tracked_request.rb
 - lib/scout_apm/transaction.rb
+- lib/scout_apm/transaction_time_consumed.rb
 - lib/scout_apm/utils/active_record_metric_name.rb
 - lib/scout_apm/utils/backtrace_parser.rb
 - lib/scout_apm/utils/gzip_helper.rb
@@ -363,6 +364,7 @@ files:
 - test/unit/tracer_test.rb
 - test/unit/tracked_request_test.rb
 - test/unit/transaction_test.rb
+- test/unit/transaction_time_consumed_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb
@@ -388,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.5.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
@@ -431,7 +433,9 @@ test_files:
 - test/unit/tracer_test.rb
 - test/unit/tracked_request_test.rb
 - test/unit/transaction_test.rb
+- test/unit/transaction_time_consumed_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb
 - test/unit/utils/scm.rb
+has_rdoc: