scout_apm 3.0.0.pre23 → 3.0.0.pre25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64d1ac40c6dec93f6e7c59b358f8f696a1f53eee
-  data.tar.gz: 815f98467560d0c0b9c4257eafc1f45a9784246e
+  metadata.gz: 0d2364c7ae5bfc518cc19c5059e90959a15203bc
+  data.tar.gz: 45a2372a9d6a96460b946419ec02c3ceb63a4d2d
 SHA512:
-  metadata.gz: 439b25ab44127e59d906006f34e8c9efd94fa3bbafde58fbcfd1af34be1caf94b80d8ae84c6087af8e4de5e6866b5c03e609d971524e0cbc3a3aa0d2922f500b
-  data.tar.gz: b6c954e72a252f9dbc113ed12b659c69b9f3e19241a58395a01ff68725ad4bd0b96b2e0bb6857cd9950063469aaba76d03ff1d3a2d802ca14d218c7996dcc10c
+  metadata.gz: 607f2bf5f3b6eedab959e49c277972f00c72c03d408782a8cc0466a7fc44a2e5dce11a4279da227f64cb5baeda9d1ad4ed8ead972687906abd19750973e7246b
+  data.tar.gz: 0bb02a39eb5dd459665b9049038e275e08fe3ddd60a1ffcb5b2d6af1f7f31f8291d58eaac2a8cac577527a8a046167f2492058af6e20d7f725691b25e0b1d40f

data/CHANGELOG.markdown

@@ -2,6 +2,14 @@
 
 * ScoutProf BETA
 
+# 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
+
 # 2.4.11
 
 * Adds transaction + periodic reporting callback extension support

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in scout_apm.gemspec
 gemspec

data/lib/scout_apm.rb

@@ -146,6 +146,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/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/background_job_integrations/delayed_job.rb

@@ -53,7 +53,7 @@ module ScoutApm
               req = ScoutApm::RequestManager.lookup
 
               begin
-                latency = Time.now - job.created_at
+                latency = Time.now - [job.created_at, job.run_at].max
                 req.annotate_request(:queue_latency => latency)
               rescue
               end

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

@@ -300,6 +300,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,3 +1,3 @@
 module ScoutApm
-  VERSION = "3.0.0.pre23"
+  VERSION = "3.0.0.pre25"
 end

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: 3.0.0.pre23
+  version: 3.0.0.pre25
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -315,6 +315,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/fake_stacks.rb
@@ -369,6 +370,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
@@ -395,8 +397,52 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.6.12
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files: []
+test_files:
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- test/unit/agent_test.rb
+- test/unit/background_job_integrations/sidekiq_test.rb
+- test/unit/config_test.rb
+- test/unit/context_test.rb
+- test/unit/db_query_metric_set_test.rb
+- test/unit/db_query_metric_stats_test.rb
+- test/unit/environment_test.rb
+- test/unit/extensions/periodic_callbacks_test.rb
+- test/unit/extensions/transaction_callbacks_test.rb
+- test/unit/fake_store_test.rb
+- test/unit/git_revision_test.rb
+- test/unit/histogram_test.rb
+- test/unit/ignored_uris_test.rb
+- test/unit/instruments/active_record_instruments_test.rb
+- test/unit/instruments/net_http_test.rb
+- test/unit/instruments/percentile_sampler_test.rb
+- test/unit/layaway_test.rb
+- test/unit/layer_children_set_test.rb
+- test/unit/layer_converters/depth_first_walker_test.rb
+- test/unit/layer_converters/metric_converter_test.rb
+- test/unit/layer_converters/stubs.rb
+- test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
+- test/unit/metric_set_test.rb
+- test/unit/remote/test_message.rb
+- test/unit/remote/test_router.rb
+- test/unit/remote/test_server.rb
+- test/unit/scored_item_set_test.rb
+- test/unit/serializers/payload_serializer_test.rb
+- test/unit/slow_job_policy_test.rb
+- test/unit/slow_request_policy_test.rb
+- test/unit/sql_sanitizer_test.rb
+- test/unit/store_test.rb
+- 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: