scout_apm 1.5.5 → 1.6.0

data/lib/scout_apm/store.rb

@@ -6,9 +6,13 @@ module ScoutApm
     # A hash of reporting periods. { StoreReportingPeriodTimestamp => StoreReportingPeriod }
     attr_reader :reporting_periods
 
+    # Used to pull metrics into each reporting period, as that reporting period is finished.
+    attr_reader :samplers
+
     def initialize
       @mutex = Mutex.new
       @reporting_periods = Hash.new { |h,k| h[k] = StoreReportingPeriod.new(k) }
+      @samplers = []
     end
 
     def current_timestamp
@@ -66,12 +70,32 @@ module ScoutApm
       @mutex.synchronize {
         reporting_periods.select { |time, rp| force || time.timestamp < current_timestamp.timestamp}.
                           each   { |time, rp|
+                                   collect_samplers(rp)
                                    layaway.add_reporting_period(time, rp)
                                    reporting_periods.delete(time)
                                  }
       }
       ScoutApm::Agent.instance.logger.debug("Finished writing to layaway")
     end
+
+    ######################################
+    # Sampler support
+    def add_sampler(sampler)
+      @samplers << sampler
+    end
+
+    def collect_samplers(rp)
+      @samplers.each do |sampler|
+        begin
+          metrics = sampler.metrics(rp.timestamp)
+          rp.absorb_metrics!(metrics)
+        rescue => e
+          ScoutApm::Agent.instance.logger.info "Error reading #{sampler.human_name} for period: #{rp}"
+          ScoutApm::Agent.instance.logger.debug e.message
+          ScoutApm::Agent.instance.logger.debug e.backtrace.join("\n")
+        end
+      end
+    end
   end
 
   # A timestamp, normalized to the beginning of a minute. Used as a hash key to
@@ -107,11 +131,12 @@ module ScoutApm
 
   # One period of Storage. Typically 1 minute
   class StoreReportingPeriod
-    # A SlowItemSet to store slow transactions in
-    attr_reader :slow_transactions
 
-    # A SlowItemSet to store slow jobs in
-    attr_reader :slow_jobs
+    # A ScoredItemSet holding the "best" traces for the period
+    attr_reader :request_traces
+
+    # A ScoredItemSet holding the "best" traces for the period
+    attr_reader :job_traces
 
     # A StoreReportingPeriodTimestamp representing the time that this
     # collection of metrics is for
@@ -122,19 +147,21 @@ module ScoutApm
     def initialize(timestamp)
       @timestamp = timestamp
 
-      @slow_transactions = SlowItemSet.new
-      @slow_jobs = SlowItemSet.new
+      @request_traces = ScoredItemSet.new
+      @job_traces = ScoredItemSet.new
 
       @metric_set = MetricSet.new
       @jobs = Hash.new
     end
 
     # Merges another StoreReportingPeriod into this one
-    def merge(new_val)
+    def merge(other)
       self.
-        merge_metrics!(new_val.metric_set).
-        merge_slow_transactions!(new_val.slow_transactions).
-        merge_jobs!(new_val.jobs)
+        merge_metrics!(other.metric_set).
+        merge_slow_transactions!(other.slow_transactions_payload).
+        merge_jobs!(other.jobs).
+        merge_slow_jobs!(other.slow_jobs_payload)
+      self
     end
 
     #################################
@@ -148,6 +175,7 @@ module ScoutApm
     end
 
     # For merging when you have another metric_set object
+    # Makes sure that you don't duplicate error count records
     def merge_metrics!(other_metric_set)
       metric_set.combine!(other_metric_set)
       self
@@ -155,14 +183,14 @@ module ScoutApm
 
     def merge_slow_transactions!(new_transactions)
       Array(new_transactions).each do |one_transaction|
-        slow_transactions << one_transaction
+        request_traces << one_transaction
       end
 
       self
     end
 
     def merge_jobs!(jobs)
-      jobs.each do |job|
+      Array(jobs).each do |job|
         if @jobs.has_key?(job)
           @jobs[job].combine!(job)
         else
@@ -175,8 +203,10 @@ module ScoutApm
 
     def merge_slow_jobs!(new_jobs)
       Array(new_jobs).each do |job|
-        slow_jobs << job
+        job_traces << job
       end
+
+      self
     end
 
     #################################
@@ -187,7 +217,7 @@ module ScoutApm
     end
 
     def slow_transactions_payload
-      slow_transactions.to_a
+      request_traces.to_a
     end
 
     def jobs
@@ -195,7 +225,7 @@ module ScoutApm
     end
 
     def slow_jobs_payload
-      slow_jobs.to_a
+      job_traces.to_a
     end
 
     #################################

data/lib/scout_apm/tracked_request.rb

@@ -186,24 +186,47 @@ module ScoutApm
     def record!
       @recorded = true
 
+      # Update immediate and long-term histograms for both job and web requests
+      if unique_name != :unknown
+        ScoutApm::Agent.instance.request_histograms.add(unique_name, root_layer.total_call_time)
+        ScoutApm::Agent.instance.request_histograms_by_time[ScoutApm::Agent.instance.store.current_timestamp].
+          add(unique_name, root_layer.total_call_time)
+      end
+
       metrics = LayerConverters::MetricConverter.new(self).call
       ScoutApm::Agent.instance.store.track!(metrics)
 
-      slow, slow_metrics = LayerConverters::SlowRequestConverter.new(self).call
-      ScoutApm::Agent.instance.store.track_slow_transaction!(slow)
-      ScoutApm::Agent.instance.store.track!(slow_metrics)
-
       error_metrics = LayerConverters::ErrorConverter.new(self).call
       ScoutApm::Agent.instance.store.track!(error_metrics)
 
-      queue_time_metrics = LayerConverters::RequestQueueTimeConverter.new(self).call
-      ScoutApm::Agent.instance.store.track!(queue_time_metrics)
+      if web?
+        # Don't #call this - that's the job of the ScoredItemSet later.
+        slow_converter = LayerConverters::SlowRequestConverter.new(self)
+        ScoutApm::Agent.instance.store.track_slow_transaction!(slow_converter)
+
+        queue_time_metrics = LayerConverters::RequestQueueTimeConverter.new(self).call
+        ScoutApm::Agent.instance.store.track!(queue_time_metrics)
+      end
+
+      if job?
+        job_metrics = LayerConverters::JobConverter.new(self).call
+        ScoutApm::Agent.instance.store.track_job!(job_metrics)
 
-      job = LayerConverters::JobConverter.new(self).call
-      ScoutApm::Agent.instance.store.track_job!(job)
+        job_converter = LayerConverters::SlowJobConverter.new(self)
+        ScoutApm::Agent.instance.store.track_slow_job!(job_converter)
+      end
+    end
 
-      slow_job = LayerConverters::SlowJobConverter.new(self).call
-      ScoutApm::Agent.instance.store.track_slow_job!(slow_job)
+    # Only call this after the request is complete
+    def unique_name
+      @unique_name ||= begin
+                         scope_layer = LayerConverters::ConverterBase.new(self).scope_layer
+                         if scope_layer
+                           scope_layer.legacy_metric_name
+                         else
+                           :unknown
+                         end
+                       end
     end
 
     # Have we already persisted this request?

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.5.5"
+  VERSION = "1.6.0"
 end
 

data/test/test_helper.rb

@@ -1,11 +1,12 @@
+# Load & Start simplecov before loading scout_apm
+require 'simplecov'
+SimpleCov.start
+
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest/pride'
 require 'pry'
 
-# Load & Start simplecov before loading scout_apm
-require 'simplecov'
-SimpleCov.start
 
 require 'scout_apm'
 

data/test/unit/layaway_test.rb

@@ -18,15 +18,12 @@ class LayawayTest < Minitest::Test
 
   def test_merge_reporting_period
     File.open(DATA_FILE_PATH, 'w') { |file| file.write(Marshal.dump(NEW_FORMAT)) }
-    ScoutApm::Agent.instance.start
-
-    data = ScoutApm::Layaway.new
-    t = ScoutApm::StoreReportingPeriodTimestamp.new
-    data.add_reporting_period(TIMESTAMP,ScoutApm::StoreReportingPeriod.new(TIMESTAMP))
-    assert_equal [TIMESTAMP], Marshal.load(File.read(DATA_FILE_PATH)).keys
-    # TODO - add tests to verify metrics+slow transactions are merged
+    layaway = ScoutApm::Layaway.new
+    layaway.add_reporting_period(TIMESTAMP, ScoutApm::StoreReportingPeriod.new(TIMESTAMP))
+    unmarshalled = Marshal.load(File.read(DATA_FILE_PATH))
+    assert_equal [TIMESTAMP], unmarshalled.keys
   end
 
   TIMESTAMP = ScoutApm::StoreReportingPeriodTimestamp.new(Time.parse("2015-01-01"))
   NEW_FORMAT = {TIMESTAMP => ScoutApm::StoreReportingPeriod.new(TIMESTAMP)} # Format for 1.2+ agents
-end
+end

data/test/unit/scored_item_set_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+require 'scout_apm/scored_item_set'
+
+class FakeScoredItem
+  def initialize(name, score)
+    @name = name
+    @score = score
+  end
+  def name; @name; end
+  def score; @score; end
+  def call; "called_#{@score}_#{@name}"; end
+end
+
+class ScoredItemSetTest < Minitest::Test
+  def test_empty_set_always_adds_item
+    set = ScoutApm::ScoredItemSet.new
+    set << FakeScoredItem.new("users/index", 10)
+
+    assert_equal set.to_a.first, "called_10_users/index"
+    assert_equal set.count, 1
+  end
+
+  def test_repeated_additions_chooses_most_expensive
+    set = ScoutApm::ScoredItemSet.new
+
+    [ FakeScoredItem.new("users/index", 10),
+      FakeScoredItem.new("users/index", 11),
+      FakeScoredItem.new("users/index", 12)
+    ].shuffle.each { |fsi| set << fsi }
+
+    assert_equal set.to_a.first, "called_12_users/index"
+    assert_equal set.count, 1
+  end
+
+  def test_multiple_items_occupy_different_buckets
+    set = ScoutApm::ScoredItemSet.new
+
+    [ FakeScoredItem.new("users/index", 10),
+      FakeScoredItem.new("users/index", 11),
+      FakeScoredItem.new("users/show", 12),
+      FakeScoredItem.new("users/show", 10)
+    ].shuffle.each { |fsi| set << fsi }
+
+    assert_equal set.count, 2
+    assert set.to_a.include?("called_11_users/index")
+    assert set.to_a.include?("called_12_users/show")
+  end
+
+  def test_evicts_at_capacity
+    set = ScoutApm::ScoredItemSet.new(3) # Force max_size to 3
+
+    [ FakeScoredItem.new("users/index", 10),
+      FakeScoredItem.new("users/show", 11),
+      FakeScoredItem.new("posts/index", 12),
+      FakeScoredItem.new("posts/move", 13)
+    ].shuffle.each { |fsi| set << fsi }
+
+    assert_equal set.count, 3
+    assert !set.to_a.include?("called_10_users/index"), "Did not Expect to see users/index in #{set.to_a.inspect}"
+    assert set.to_a.include?("called_11_users/show"),   "Expected to see users/show in #{set.to_a.inspect}"
+    assert set.to_a.include?("called_12_posts/index"),  "Expected to see posts/index in #{set.to_a.inspect}"
+    assert set.to_a.include?("called_13_posts/move"),   "Expected to see posts/move in #{set.to_a.inspect}"
+  end
+end

data/test/unit/serializers/payload_serializer_test.rb

@@ -145,7 +145,7 @@ class PayloadSerializerTest < Minitest::Test
     context = ScoutApm::Context.new
     context.add({"this" => "that"})
     context.add_user({"hello" => "goodbye"})
-    slow_t = ScoutApm::SlowTransaction.new("http://example.com/blabla", "Buckethead/something/else", 1.23, slow_transaction_metrics, context, Time.at(1448198788), [])
+    slow_t = ScoutApm::SlowTransaction.new("http://example.com/blabla", "Buckethead/something/else", 1.23, slow_transaction_metrics, context, Time.at(1448198788), [], 10)
     payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, {}, [slow_t], [], [])
     formatted_slow_transactions = [
       {
@@ -158,6 +158,7 @@ class PayloadSerializerTest < Minitest::Test
         "uri" => "http://example.com/blabla",
         "context" => {"this"=>"that", "user"=>{"hello"=>"goodbye"}},
         "prof" => [],
+        "score" => 10,
         "metrics" => [
           {
             "key" => {

data/test/unit/slow_item_set_test.rb

@@ -88,6 +88,7 @@ class SlowItemSetTest < Minitest::Test
       {}, # metrics
       {}, # context
       Time.now, # end time
-      []) # stackprof
+      [], # stackprof
+      0)
   end
 end

data/test/unit/slow_request_policy_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+require 'scout_apm/slow_request_policy'
+require 'scout_apm/layer'
+
+class FakeRequest
+  def initialize(name)
+    @name = name
+    @root_layer = ScoutApm::Layer.new("Controller", name)
+    @root_layer.instance_variable_set("@stop_time", Time.now)
+  end
+  def unique_name; "Controller/foo/bar"; end
+  def root_layer; @root_layer; end
+  def set_duration(seconds)
+    @root_layer.instance_variable_set("@start_time", Time.now - seconds)
+  end
+end
+
+class SlowRequestPolicyTest < Minitest::Test
+  def test_stored_records_current_time
+    test_start = Time.now
+    policy = ScoutApm::SlowRequestPolicy.new
+    request = FakeRequest.new("users/index")
+
+    policy.stored!(request)
+    assert policy.last_seen[request.unique_name] > test_start
+  end
+
+  def test_score
+    policy = ScoutApm::SlowRequestPolicy.new
+    request = FakeRequest.new("users/index")
+
+    request.set_duration(10) # 10 seconds
+    policy.last_seen[request.unique_name] = Time.now - 120 # 2 minutes since last seen
+    agent.request_histograms.add(request.unique_name, 1)
+
+    # Actual value I have in console is 1.599
+    assert policy.score(request) > 1.5
+    assert policy.score(request) < 2.0
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -117,6 +117,7 @@ files:
 - lib/scout_apm/instruments/mongoid.rb
 - lib/scout_apm/instruments/moped.rb
 - lib/scout_apm/instruments/net_http.rb
+- lib/scout_apm/instruments/percentile_sampler.rb
 - lib/scout_apm/instruments/process/process_cpu.rb
 - lib/scout_apm/instruments/process/process_memory.rb
 - lib/scout_apm/instruments/rails_router.rb
@@ -142,7 +143,9 @@ files:
 - lib/scout_apm/platform_integrations/heroku.rb
 - lib/scout_apm/platform_integrations/server.rb
 - lib/scout_apm/reporter.rb
+- lib/scout_apm/request_histograms.rb
 - lib/scout_apm/request_manager.rb
+- lib/scout_apm/scored_item_set.rb
 - lib/scout_apm/serializers/app_server_load_serializer.rb
 - lib/scout_apm/serializers/deploy_serializer.rb
 - lib/scout_apm/serializers/directive_serializer.rb
@@ -189,9 +192,11 @@ files:
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
+- test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_item_set_test.rb
 - test/unit/slow_job_policy_test.rb
+- test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
@@ -228,9 +233,11 @@ test_files:
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
+- test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_item_set_test.rb
 - test/unit/slow_job_policy_test.rb
+- test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 has_rdoc: