scout_apm 3.0.0.pre14 → 3.0.0.pre15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f476cb8dead66959ed3a2e07a102d4d6ee50c79
-  data.tar.gz: 28266d8577a792a8faec963bf01e260360817e81
+  metadata.gz: 8acb94ef4095b224ee2d08a3d5a25410b104447b
+  data.tar.gz: 7d6493404c2dcd0346d6465d240cb428eb1f23ab
 SHA512:
-  metadata.gz: bd5647c9cd02c2fe3e2d670bd71af12cde9d7df06cca03e16561873ee02beab8dda5b5001ec3c397b9dbb1df9b31dde57ef3e7e1ef0ecfdd2755e4ecfae92f69
-  data.tar.gz: 031e7b683fc6ab6cd3c56a52e03a81a3e1a059c1ffbea594e0cc5ca0d3a67120ca7b35a31726becc0acaf39e54f9bd77d09488c3ed4c89bd524d56d07dcf959e
+  metadata.gz: e3f6cd0b3fb6413bc36a18b69a7e24ed6cb65d7f32f0b0d9ce5bef7b71b41640e80a34c8255540b9d8171312bca630bf35d79568ad7976bb6d0e83f7fe8f4253
+  data.tar.gz: 885869be52cb6836df31063bcb2818433511e6001115490e926256de2c70d924452a1feed70ad4a8501155388520ae8efff12a77584f653e6499ae269c2212e5

data/CHANGELOG.markdown

@@ -2,6 +2,26 @@
 
 * ScoutProf BETA
 
+# 2.4.0
+
+* Rework agent startup sequence
+
+# 2.3.4
+
+* Capture 300 characters of a url from net/http and httpclient instruments (up from 100).
+
+# 2.3.3
+
+* Capture ActiveRecord calls that generate more complex queries
+* More aggressively determine names of complex queries (to determine "User/find", "Account/create" and similar)
+* Increases the maximum size of SQL queries that are sanitized to 16KB from 4 KB
+* Captures all SQL individual queries generated in a given AR call (previous only a single query was captured)
+
+# 2.3.2
+
+* More robust startup sequence when using `rails server` vs. directly launching an app server
+* Avoid incompatibility with 3rd party gems that aggressively obtain database connections
+
 # 2.3.1
 
 * Fix DevTrace bug

data/lib/scout_apm/config.rb

@@ -66,6 +66,7 @@ module ScoutApm
         'report_format',
         'scm_subdirectory',
         'uri_reporting',
+        'instrument_http_url_length',
     ]
 
     ################################################################################
@@ -153,6 +154,7 @@ module ScoutApm
       "monitor"                => BooleanCoercion.new,
       'database_metric_limit'  => IntegerCoercion.new,
       'database_metric_report_limit' => IntegerCoercion.new,
+      'instrument_http_url_length' => IntegerCoercion.new,
     }
 
 
@@ -256,6 +258,7 @@ module ScoutApm
         'remote_agent_port'      => 7721, # picked at random
         'database_metric_limit'  => 5000, # The hard limit on db metrics
         'database_metric_report_limit' => 1000,
+        'instrument_http_url_length' => 300,
       }.freeze
 
       def value(key)

data/lib/scout_apm/instruments/active_record.rb

@@ -1,6 +1,38 @@
 require 'scout_apm/utils/sql_sanitizer'
 
 module ScoutApm
+  class SqlList
+    attr_reader :sqls
+
+    def initialize(sql=nil)
+      @sqls = []
+
+      if !sql.nil?
+        push(sql)
+      end
+    end
+
+    def <<(sql)
+      push(sql)
+    end
+
+    def push(sql)
+      if !(Utils::SqlSanitizer === sql)
+        sql = Utils::SqlSanitizer.new(sql)
+      end
+      @sqls << sql
+    end
+
+    # All of this one, then all of the other.
+    def merge(other)
+      @sqls += other.sqls
+    end
+
+    def to_s
+      @sqls.map{|s| s.to_s }.join(";\n")
+    end
+  end
+
   module Instruments
     class ActiveRecord
       attr_reader :context
@@ -129,13 +161,12 @@ module ScoutApm
         # Extract data from the arguments
         sql, name = args
         metric_name = Utils::ActiveRecordMetricName.new(sql, name)
-        desc = Utils::SqlSanitizer.new(sql)
+        desc = SqlList.new(sql)
 
         # Get current ScoutApm context
         req = ScoutApm::RequestManager.lookup
         current_layer = req.current_layer
 
-
         # If we call #log, we have a real query to run, and we've already
         # gotten through the cache gatekeeper. Since we want to only trace real
         # queries, and not repeated identical queries that just hit cache, we
@@ -150,9 +181,13 @@ module ScoutApm
           # TODO: Get rid of call .to_s, need to find this without forcing a previous run of the name logic
           if current_layer.name.to_s == Utils::ActiveRecordMetricName::DEFAULT_METRIC
             current_layer.name = metric_name
-            current_layer.desc = desc
           end
 
+          if current_layer.desc.nil?
+            current_layer.desc = SqlList.new
+          end
+          current_layer.desc.merge(desc)
+
           log_without_scout_instruments(*args, &block)
 
         # OR: Start a new layer, we didn't pick up instrumentation earlier in the stack.
@@ -229,6 +264,7 @@ module ScoutApm
         req = ScoutApm::RequestManager.lookup
         layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName::DEFAULT_METRIC)
         layer.annotate_layer(:ignorable => true)
+        layer.desc = SqlList.new
         req.start_layer(layer)
         req.ignore_children!
         begin
@@ -247,6 +283,7 @@ module ScoutApm
 
         req = ScoutApm::RequestManager.lookup
         layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} #{operation}"))
+        layer.desc = SqlList.new
         req.start_layer(layer)
         req.ignore_children!
         begin

data/lib/scout_apm/instruments/http_client.rb

@@ -26,9 +26,12 @@ module ScoutApm
             include ScoutApm::Tracer
 
             def request_with_scout_instruments(*args, &block)
+
               method = args[0].to_s
               url = args[1]
-              url = url && url.to_s[0..99]
+
+              max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+              url = url && url.to_s[0..(max_length - 1)]
 
               self.class.instrument("HTTP", method, :desc => url) do
                 request_without_scout_instruments(*args, &block)

data/lib/scout_apm/instruments/net_http.rb

@@ -34,7 +34,9 @@ module ScoutApm
             def request_scout_description(req)
               path = req.path
               path = path.path if path.respond_to?(:path)
-              (@address + path.split('?').first)[0..99]
+
+              max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+              (@address + path.split('?').first)[0..(max_length - 1)]
             end
 
             alias request_without_scout_instruments request

data/lib/scout_apm/layer_converters/converter_base.rb

@@ -145,7 +145,7 @@ module ScoutApm
         end
       end
 
-      def make_meta_options_desc_hash(layer, max_desc_length=1000)
+      def make_meta_options_desc_hash(layer, max_desc_length=32768)
         if layer.desc
           desc_s = layer.desc.to_s
           trimmed_desc = desc_s[0 .. max_desc_length]

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -74,8 +74,10 @@ module ScoutApm
         encodings.all?{|enc| Encoding.find(enc) rescue false}
       end
 
+      MAX_SQL_LENGTH = 16384
+
       def scrubbed(str)
-        return '' if !str.is_a?(String) || str.length > 4000 # safeguard - don't sanitize or scrub large SQL statements
+        return '' if !str.is_a?(String) || str.length > MAX_SQL_LENGTH # safeguard - don't sanitize or scrub large SQL statements
         return str if !str.respond_to?(:encode) # Ruby <= 1.8 doesn't have string encoding
         return str if str.valid_encoding? # Whatever encoding it is, it is valid and we can operate on it
         ScoutApm::Agent.instance.context.logger.debug "Scrubbing invalid sql encoding."

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "3.0.0.pre14"
+  VERSION = "3.0.0.pre15"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre14
+  version: 3.0.0.pre15
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -372,7 +372,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring