scout_apm 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27f05793dcadc7719efffe143482e56f78c869f4
-  data.tar.gz: c1edab9ff98a8a78076eaeb42d77bf63c5e970ca
+  metadata.gz: 0494dfededbaa29426c0b087bb80e97f865ed237
+  data.tar.gz: dcbbf372d00781f4aa349d4a343650558599fb3c
 SHA512:
-  metadata.gz: 83b0652fd7a20995670d3a2d2670d3945fcd7a122bbcd31f617509c977904f8f4d60e31c3a554aa3b56ccc71cfeb965869e7ddb080e8035c4676c47c569b6dc4
-  data.tar.gz: be85c7d2de39976a10940a89839c242b9f8866d13b0991e3cf787a6d863ec050dd2ea12213540b6336ca2a5b1ccc079365ccd79ea40e5bffd88bc3c6ac13f04f
+  metadata.gz: 11b61029f1561d2ed7806224f219e8c177cc38f9cce5165a1f91eed25786f50edfae50545ab77c974b92c71386a614ed4f4f2658ee2d190f356aedf6ab0d7bac
+  data.tar.gz: 1c4ff4b60d1c27ec6f4df40435fa0f96feb60c18e633e6be1cbfb6c90d09e480e954d4a2c39935ea02373d939dfdd20aeccf31c582c0321ce8114a208d4fb77b

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 1.5.4
+
+* Fix issue where error counts were being misreported
+* Politely ignore cases when `request.remote_ip` raises exceptions.
+
 # 1.5.3
 
 * Fix another minor bug related to iso8601 timestamps

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -61,7 +61,10 @@ module ScoutApm
         req = ScoutApm::RequestManager.lookup
         path = ScoutApm::Agent.instance.config.value("uri_reporting") == 'path' ? request.path : request.fullpath
         req.annotate_request(:uri => path)
-        req.context.add_user(:ip => request.remote_ip)
+
+        # IP Spoofing Protection can throw an exception, just move on w/o remote ip
+        req.context.add_user(:ip => request.remote_ip) rescue nil
+
         req.set_headers(request.headers)
         req.web!
 

data/lib/scout_apm/layaway.rb

@@ -18,10 +18,7 @@ module ScoutApm
           new_req = new_val.request_count
           ScoutApm::Agent.instance.logger.debug("Merging Two reporting periods (#{old_val.timestamp.to_s}, #{new_val.timestamp.to_s}): old req #{old_req}, new req #{new_req}")
 
-          old_val.
-            merge_metrics!(new_val.metrics_payload).
-            merge_slow_transactions!(new_val.slow_transactions).
-            merge_jobs!(new_val.jobs)
+          old_val.merge(new_val)
         }
 
         ScoutApm::Agent.instance.logger.debug("AddReportingPeriod: AfterMerge Timestamps: #{existing_data.keys.map(&:to_s).inspect}")

data/lib/scout_apm/metric_set.rb

@@ -23,11 +23,15 @@ module ScoutApm
         @metrics[meta].combine!(stat)
 
       elsif meta.type == "Errors" # Sadly special cased, we want both raw and aggregate values
-        @metrics[meta] ||= MetricStats.new
-        @metrics[meta].combine!(stat)
-        agg_meta = MetricMeta.new("Errors/Request", :scope => meta.scope)
-        @metrics[agg_meta] ||= MetricStats.new
-        @metrics[agg_meta].combine!(stat)
+        # When combining MetricSets between different 
+          @metrics[meta] ||= MetricStats.new
+          @metrics[meta].combine!(stat)
+
+        if !@combine_in_progress
+          agg_meta = MetricMeta.new("Errors/Request", :scope => meta.scope)
+          @metrics[agg_meta] ||= MetricStats.new
+          @metrics[agg_meta].combine!(stat)
+        end
 
       else # Combine down to a single /all key
         agg_meta = MetricMeta.new("#{meta.type}/all", :scope => meta.scope)
@@ -36,8 +40,13 @@ module ScoutApm
       end
     end
 
+    # Sets a combine_in_progress flag to prevent double-counting Error metrics.
+    # Without it, the Errors/Request number would be increasingly off as
+    # metric_sets get merged in.
     def combine!(other)
+      @combine_in_progress = true
       absorb_all(other.metrics)
+      @combine_in_progress = false
       self
     end
   end

data/lib/scout_apm/store.rb

@@ -22,7 +22,7 @@ module ScoutApm
     # Save newly collected metrics
     def track!(metrics, options={})
       @mutex.synchronize {
-        current_period.merge_metrics!(metrics)
+        current_period.absorb_metrics!(metrics)
       }
     end
 
@@ -129,14 +129,30 @@ module ScoutApm
       @jobs = Hash.new
     end
 
+    # Merges another StoreReportingPeriod into this one
+    def merge(new_val)
+      self.
+        merge_metrics!(new_val.metric_set).
+        merge_slow_transactions!(new_val.slow_transactions).
+        merge_jobs!(new_val.jobs)
+    end
+
     #################################
     # Add metrics as they are recorded
     #################################
-    def merge_metrics!(metrics)
+
+    # For absorbing an array of metric {Meta => Stat} records
+    def absorb_metrics!(metrics)
       metric_set.absorb_all(metrics)
       self
     end
 
+    # For merging when you have another metric_set object
+    def merge_metrics!(other_metric_set)
+      metric_set.combine!(other_metric_set)
+      self
+    end
+
     def merge_slow_transactions!(new_transactions)
       Array(new_transactions).each do |one_transaction|
         slow_transactions << one_transaction

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.5.3"
+  VERSION = "1.5.4"
 end
 

data/test/unit/metric_set_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+require 'scout_apm/metric_set'
+
+module ScoutApm
+  class MetricSetTest < Minitest::Test
+    def setup
+      @metric_set = ScoutApm::MetricSet.new
+    end
+
+    def test_absorb_one_passthrough_metric
+      @metric_set.absorb(make_fake_stat("Controller/Foo", 1))
+
+      assert_equal 1, @metric_set.metrics.length
+      assert_equal "Controller/Foo", @metric_set.metrics.first.first.metric_name
+    end
+
+    def test_absorb_one_aggregate_metric
+      @metric_set.absorb(make_fake_stat("ActiveRecord/Foo", 1))
+
+      assert_equal 1, @metric_set.metrics.length
+      assert_equal "ActiveRecord/all", @metric_set.metrics.first.first.metric_name
+    end
+
+    def test_absorb_many_aggregate_metric
+      @metric_set.absorb(make_fake_stat("ActiveRecord/Foo", 1))
+      @metric_set.absorb(make_fake_stat("ActiveRecord/Bar", 1))
+      @metric_set.absorb(make_fake_stat("ActiveRecord/Baz", 1))
+      @metric_set.absorb(make_fake_stat("HTTP/Get", 1))
+      @metric_set.absorb(make_fake_stat("HTTP/Post", 1))
+
+      metrics = @metric_set.metrics.to_a.sort_by { |m| m.first.metric_name }
+      assert_equal 2, metrics.length
+      assert_equal "ActiveRecord/all", metrics[0][0].metric_name
+      assert_equal "HTTP/all", metrics[1][0].metric_name
+      assert_equal 3, metrics[0][1].call_count
+      assert_equal 2, metrics[1][1].call_count
+    end
+
+    def test_absorb_one_error
+      @metric_set.absorb(make_fake_stat("Errors/Controller/public/index", 1))
+
+      metrics = @metric_set.metrics.to_a.sort_by { |m| m.first.metric_name }
+      assert_equal 2, metrics.length
+      assert_equal "Errors/Controller/public/index", metrics[0].first.metric_name
+      assert_equal "Errors/Request",  metrics[1].first.metric_name
+    end
+
+    def test_absorb_many_metrics
+      @metric_set.absorb_all([
+        make_fake_stat("ActiveRecord/Foo", 1),
+        make_fake_stat("Controller/Bar", 1)
+      ])
+
+      metrics = @metric_set.metrics.to_a.sort_by { |m| m.first.metric_name }
+      assert_equal 2, metrics.length
+      assert_equal "ActiveRecord/all", metrics[0].first.metric_name
+      assert_equal "Controller/Bar",  metrics[1].first.metric_name
+    end
+
+    def test_combine
+      @other_set = ScoutApm::MetricSet.new
+
+      @metric_set.absorb_all([
+        make_fake_stat("ActiveRecord/Foo", 1),
+        make_fake_stat("Controller/Bar", 1),
+        make_fake_stat("Errors/Controller/public/index", 1),
+      ])
+
+      @other_set.absorb_all([
+        make_fake_stat("ActiveRecord/Foo", 1),
+        make_fake_stat("Controller/Bar", 1),
+        make_fake_stat("Errors/Controller/public/index", 1),
+      ])
+
+      @metric_set.combine!(@other_set)
+
+      metrics = @metric_set.metrics.to_a.sort_by { |m| m.first.metric_name }
+      assert_equal 4, metrics.length
+      assert_equal "ActiveRecord/all", metrics[0][0].metric_name
+      assert_equal "Controller/Bar",  metrics[1][0].metric_name
+      assert_equal "Errors/Controller/public/index", metrics[2][0].metric_name
+      assert_equal "Errors/Request",  metrics[3][0].metric_name
+
+      assert_equal 2, metrics[0][1].call_count
+      assert_equal 2, metrics[1][1].call_count
+      assert_equal 2, metrics[2][1].call_count
+      assert_equal 2, metrics[3][1].call_count
+    end
+
+    ############################################################
+    # Test helper functions
+    ############################################################
+    def make_fake_stat(name, count)
+      meta = MetricMeta.new(name)
+      stat = MetricStats.new
+      stat.update!(count)
+      [meta, stat]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -188,6 +188,7 @@ files:
 - test/unit/histogram_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
+- test/unit/metric_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_item_set_test.rb
 - test/unit/slow_job_policy_test.rb
@@ -226,6 +227,7 @@ test_files:
 - test/unit/histogram_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
+- test/unit/metric_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_item_set_test.rb
 - test/unit/slow_job_policy_test.rb