scout_apm 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 951fb125e1266317ef5b4e0ec486ec3b946be418
-  data.tar.gz: 689544330b9f6a8f1b9f648257dc6eee972432b5
+  metadata.gz: ba5c475b02675dc137c1393e629891935ce8b340
+  data.tar.gz: a3b06a62571ee7b152351fee4893f2a9c395f067
 SHA512:
-  metadata.gz: b99fc25a5c4af86e600a3f9b1a2a8cb53505e58d1b84468c075fc54a36ad361b36d3f0a4ca717339dfb30aeca344126487783771cd55ef397c79e28bc4a2a076
-  data.tar.gz: d63b8be55f12a1435f1c4f74edad4062cc6d47b3e1e314f0e0cd91a0afa2d0947dbc8a7bae84258cf6df52c5392d65a8a4bf0d5ed50513ebac33a4561cc3eb71
+  metadata.gz: 046bf02d7bb03cec29d3922d5711353e61a873674ba82ee07bf9012ecd421fbfdcf872a8f88867c18604618b5173ca99352ec5ff66696a0c4a0c5b3bf77f0abc
+  data.tar.gz: dc675677e74bbb7138423b2268c8b3886338f95eed9db8d45f369f25c1149206f9cbf23d44f13e4bb2b5678b342757122c613c0db09710d6979bca1dc88f4226

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 1.2.2
+
+* Collapse middleware recordings to minimize payload size
+* Limit slow transactions recorded in full detail each minute to prevent
+  overloading payload.
+
 # 1.2.1
 
 * Fix a small issue where the middleware that attempts to start the agent could

data/lib/scout_apm.rb

@@ -97,6 +97,7 @@ require 'scout_apm/tracer'
 require 'scout_apm/context'
 require 'scout_apm/stackprof_tree_collapser'
 require 'scout_apm/slow_transaction'
+require 'scout_apm/slow_request_policy'
 require 'scout_apm/capacity'
 require 'scout_apm/attribute_arranger'
 

data/lib/scout_apm/agent.rb

@@ -17,6 +17,7 @@ module ScoutApm
     attr_accessor :log_file # path to the log file
     attr_accessor :options # options passed to the agent when +#start+ is called.
     attr_accessor :metric_lookup # Hash used to lookup metric ids based on their name and scope
+    attr_reader :slow_request_policy
 
     # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process.
     def self.instance(options = {})
@@ -35,6 +36,8 @@ module ScoutApm
       @layaway        = ScoutApm::Layaway.new
       @metric_lookup  = Hash.new
 
+      @slow_request_policy = ScoutApm::SlowRequestPolicy.new
+
       @capacity       = ScoutApm::Capacity.new
       @installed_instruments = []
     end

data/lib/scout_apm/agent/logging.rb

@@ -8,12 +8,12 @@ module ScoutApm
 
       def init_logger
         begin
-          @log_file = wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
+          @log_file ||= wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
         rescue => e
         end
 
         begin
-          @logger = Logger.new(@log_file)
+          @logger ||= Logger.new(@log_file)
           @logger.level = log_level
           apply_log_format
         rescue Exception => e

data/lib/scout_apm/agent/reporting.rb

@@ -44,6 +44,7 @@ module ScoutApm
           :agent_version => ScoutApm::VERSION,
           :agent_time    => reporting_period.timestamp.to_s,
           :agent_pid     => Process.pid,
+          :platform      => "ruby",
         }
 
         log_deliver(metrics, slow_transactions, metadata)

data/lib/scout_apm/layer_converter.rb

@@ -88,22 +88,41 @@ module ScoutApm
 
   # Take a TrackedRequest and turn it into either nil, or a SlowTransaction record
   class LayerSlowTransactionConverter < LayerConverterBase
-    SLOW_REQUEST_TIME_THRESHOLD = 2 # seconds
-
     def call
-      return nil unless should_capture_slow_request?
+      policy = ScoutApm::Agent.instance.slow_request_policy.capture_type(root_layer.total_call_time)
+
+      if policy == ScoutApm::SlowRequestPolicy::CAPTURE_NONE
+        return nil
+      end
+
 
       scope = scope_layer
       return nil unless scope
-
       uri = request.annotations[:uri] || ""
+
+      metrics = case policy
+                when ScoutApm::SlowRequestPolicy::CAPTURE_SUMMARY
+                  {}
+                when ScoutApm::SlowRequestPolicy::CAPTURE_DETAIL
+                  create_metrics
+                end
+
+      stackprof = case policy
+                  when ScoutApm::SlowRequestPolicy::CAPTURE_SUMMARY
+                    []
+                  when ScoutApm::SlowRequestPolicy::CAPTURE_DETAIL
+                    # Disable stackprof output for now
+                    [] # request.stackprof
+                  end
+
       SlowTransaction.new(uri,
                           scope.legacy_metric_name,
                           root_layer.total_call_time,
-                          create_metrics,
+                          metrics,
                           request.context,
                           root_layer.stop_time,
-                          request.stackprof)
+                          stackprof)
+
     end
 
     # Full metrics from this request. These get aggregated in Store for the
@@ -140,14 +159,15 @@ module ScoutApm
                          {:scope => scope_layer.legacy_metric_name}
                        end
 
-
         # Specific Metric
-        meta_options.merge!(:desc => layer.desc) if layer.desc
-        meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
-        meta.extra.merge!(:backtrace => layer.backtrace) if layer.backtrace
-        metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
-        stat = metric_hash[meta]
-        stat.update!(layer.total_call_time, layer.total_exclusive_time)
+        if record_specific_metric?(layer.type)
+          meta_options.merge!(:desc => layer.desc) if layer.desc
+          meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
+          meta.extra.merge!(:backtrace => layer.backtrace) if layer.backtrace
+          metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
+          stat = metric_hash[meta]
+          stat.update!(layer.total_call_time, layer.total_exclusive_time)
+        end
 
         # Merged Metric (no specifics, just sum up by type)
         meta = MetricMeta.new("#{layer.type}/all")
@@ -159,8 +179,11 @@ module ScoutApm
       metric_hash
     end
 
-    def should_capture_slow_request?
-      root_layer.total_call_time > SLOW_REQUEST_TIME_THRESHOLD
+    SKIP_SPECIFICS = ["Middleware"]
+    # For metrics that are known to be of sort duration (Middleware right now), we don't record specifics on each call to eliminate a metric explosion.
+    # There can be many Middlewares in an app.
+    def record_specific_metric?(name)
+      !SKIP_SPECIFICS.include?(name)
     end
   end
 

data/lib/scout_apm/slow_request_policy.rb

@@ -0,0 +1,83 @@
+# Long running class that provides a yes/no answer to see if a transaction counts as a "slow transaction"
+#
+# Rules:
+#   - Runtime must be slower than a threshold
+#   - Log detailed metrics only for the first X
+#   - Stop logging anything after a maximum
+
+module ScoutApm
+  class SlowRequestPolicy
+    CAPTURE_TYPES = [
+      CAPTURE_DETAIL  = "capture_detail",
+      CAPTURE_SUMMARY = "capture_summary",
+      CAPTURE_NONE    = "capture_none",
+    ]
+
+    # It's not slow unless it's at least this slow
+    SLOW_REQUEST_TIME_THRESHOLD = 2.0 # seconds
+
+    # Stop recording detailed metrics after this count.  Still record the fact
+    # a slow request happened though
+    MAX_DETAIL_PER_MINUTE = 10
+
+    # Stop recording anything after this number of slow transactions in a
+    # minute.  Will also log a message once per minute that it is stopping
+    # recording.
+    MAX_PER_MINUTE = 500
+
+    def initialize
+      @minute_count = 0
+      @detailed_count = 0 # How many detailed slow transactions have we captured this minute?
+      @minute = Time.now.min
+      @clipped_recording = false
+    end
+
+    def capture_type(time)
+      reset_counters
+
+      return CAPTURE_NONE unless slow_enough?(time)
+      return CAPTURE_NONE if clip_recording?
+
+      @minute_count += 1
+
+      if @detailed_count < MAX_DETAIL_PER_MINUTE
+        @detailed_count += 1
+        return CAPTURE_DETAIL
+      else
+        return CAPTURE_SUMMARY
+      end
+
+    end
+
+    private
+
+    def reset_counters
+      t = Time.now.min
+      return if t == @minute
+
+      @minute_count = 0
+      @detailed_count = 0
+      @minute = t
+      @clipped_recording = false
+    end
+
+    def slow_enough?(time)
+      time > SLOW_REQUEST_TIME_THRESHOLD
+    end
+
+    # Breaker for rapid-fire excessive slow requests.
+    # If we trip this breaker continually, it will log once per minute that it is broken
+    def clip_recording?
+      if @minute_count > MAX_PER_MINUTE
+        if !@clipped_recording
+          ScoutApm::Agent.instance.logger.info("Skipping future slow requests this minute, reached limit of #{MAX_PER_MINUTE}")
+        end
+
+        @clipped_recording = true
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end
 

data/test/test_helper.rb

@@ -5,6 +5,8 @@ require 'minitest/pride'
 
 require 'pry'
 
+require 'scout_apm'
+
 Kernel.module_eval do
   # Unset a constant without private access.
   def self.const_unset(const)
@@ -12,5 +14,21 @@ Kernel.module_eval do
   end
 end
 
-# require 'scout_apm'
 
+# Helpers available to all tests
+class Minitest::Test
+  def setup
+    reopen_logger
+  end
+
+  def set_rack_env(env)
+    ENV['RACK_ENV'] = "production"
+    ScoutApm::Environment.instance.instance_variable_set("@env", nil)
+  end
+
+  def reopen_logger
+    @log_contents = StringIO.new
+    @logger = Logger.new(@log_contents)
+    ScoutApm::Agent.instance.instance_variable_set("@logger", @logger)
+  end
+end

data/test/unit/config_test.rb

@@ -18,7 +18,8 @@ class ConfigTest < Minitest::Test
   end
 
   def test_loading_a_file
-    ENV['RACK_ENV'] = "production"
+    set_rack_env("production")
+
     conf_file = File.expand_path("../../data/config_test_1.yml", __FILE__)
     conf = ScoutApm::Config.new(conf_file)
 

data/test/unit/instruments/active_record_instruments_test.rb

@@ -1,7 +1,5 @@
 require 'test_helper'
 
-require 'scout_apm/instruments/active_record_instruments'
-
 class ActiveRecordInstrumentsTest < Minitest::Test
 end
 

data/test/unit/serializers/payload_serializer_test.rb

@@ -13,17 +13,17 @@ require 'ostruct'
 require 'json' # to deserialize what has been manually serialized by the production code
 
 # stub the report_format value
-class ScoutApm::Agent
-  module Config
-    def self.value(key)
-      'json'
-    end
-  end
+# class ScoutApm::Agent
+  # module Config
+    # def self.value(key)
+      # 'json'
+    # end
+  # end
 
-  def self.instance
-    OpenStruct.new(:config => Config)
-  end
-end
+  # def self.instance
+    # OpenStruct.new(:config => Config)
+  # end
+# end
 
 class PayloadSerializerTest < Minitest::Test
 
@@ -33,13 +33,14 @@ class PayloadSerializerTest < Minitest::Test
       :unique_id => "unique_idz",
       :agent_version => 123
     }
-    payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, {}, {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {})
 
     # symbol keys turn to strings
     formatted_metadata = {
       "app_root" => "/srv/app/rootz",
       "unique_id" => "unique_idz",
-      "agent_version" => 123
+      "agent_version" => 123,
+      "payload_version" => 2
     }
     assert_equal formatted_metadata, JSON.parse(payload)["metadata"]
   end
@@ -73,7 +74,7 @@ class PayloadSerializerTest < Minitest::Test
         stats.total_exclusive_time = 0.07813208899999999
       }
     }
-    payload = ScoutApm::Serializers::PayloadSerializer.serialize({}, metrics, {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {})
     formatted_metrics = [
       {
         "key" => {
@@ -145,7 +146,7 @@ class PayloadSerializerTest < Minitest::Test
     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), StackProf.new)
-    payload = ScoutApm::Serializers::PayloadSerializer.serialize({}, {}, [slow_t])
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, {}, [slow_t])
     formatted_slow_transactions = [
       {
         "key" => {
@@ -200,12 +201,14 @@ class PayloadSerializerTest < Minitest::Test
   def test_escapes_json_quotes
     metadata = {
       :quotie => "here are some \"quotes\"",
+      :payload_version => 2,
     }
-    payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, {}, {})
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {})
 
     # symbol keys turn to strings
     formatted_metadata = {
-      "quotie" => "here are some \"quotes\""
+      "quotie" => "here are some \"quotes\"",
+      "payload_version" => 2
     }
     assert_equal formatted_metadata, JSON.parse(payload)["metadata"]
   end

data/test/unit/sql_sanitizer_test.rb

@@ -5,6 +5,10 @@ require 'scout_apm/utils/sql_sanitizer'
 module ScoutApm
   module Utils
     class SqlSanitizerTest < Minitest::Test
+      def setup
+        ScoutApm::Agent.instance.init_logger
+      end
+
       # Too long, and we just bail out to prevent long running instrumentation
       def test_long_sql
         sql = " " * 1001
@@ -68,9 +72,7 @@ module ScoutApm
         assert_equal false, sql.valid_encoding?
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
         assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = 'a_c')|, ss.sql
-        assert_nothing_raised do
-          assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
-        end
+        assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-23 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -125,6 +125,7 @@ files:
 - lib/scout_apm/server_integrations/thin.rb
 - lib/scout_apm/server_integrations/unicorn.rb
 - lib/scout_apm/server_integrations/webrick.rb
+- lib/scout_apm/slow_request_policy.rb
 - lib/scout_apm/slow_transaction.rb
 - lib/scout_apm/stack_item.rb
 - lib/scout_apm/stackprof_tree_collapser.rb