scout_apm 2.3.4 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3550603f596bb60e23a74f36dccd159a6b48caa
-  data.tar.gz: 08d21a32a9882ddd33d5b622d185223a5dcb02dd
+  metadata.gz: 7f02661ce9cf968ffd2fc3efdd96f81a82b49f05
+  data.tar.gz: 2f47f1ddebab08773b82679dad0f81a29442c7f3
 SHA512:
-  metadata.gz: 5d10e144e4332e959eb5296d6f5420cb3c85a96e0e3520612bf8a8d42e7268939f79c0922ead5b0540917fe04bcde4b982ec3e87e2f59aeb9f1f8cdf3d1faf82
-  data.tar.gz: baaebcba71a090815eaa1780d3fbff465be893252c94ac88e2f765780f5dca6b9115bf6e5c92b3677d7fb8b0b681d0ce52c12dad9ba8c8f761a5805ccb093479
+  metadata.gz: 52a809924c15851078d2f8e3ec820021b6ec018f767d08240d1481975a18747e27442c2742bc72be51692d5c35cf9a0d47188be6d386832bbd8d4bdb473a34d4
+  data.tar.gz: 9d4359d4285532afef1e043412459360430e7ec95392f9fa4a705e3b428d8bddcab953425d1cf23335a8cdd9e9ec39d1e4ce79ef1406208b6d62246b975d43d4

data/CHANGELOG.markdown

@@ -1,3 +1,10 @@
+# 2.3.5
+
+* More robust recovery from stale layaway files
+* Quiet logging when hitting unusual layaway file limits
+* Better naming for Sidekiq delayed method jobs
+* Webrick is only required if actually needed
+
 # 2.3.4
 
 * Capture 300 characters of a url from net/http and httpclient instruments (up from 100).

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -92,10 +92,16 @@ module ScoutApm
           end
         elsif job_class == DELAYED_WRAPPER_KLASS
           begin
+            # Extract the info out of the wrapper
             yml = msg['args'].first
             deserialized_args = YAML.load(yml)
             klass, method, *rest = deserialized_args
-            job_class = [klass,method].map(&:to_s).join(".")
+
+            # If this is an instance of a class, get the class itself
+            # Prevents instances from coming through named like "#<Foo:0x007ffd7a9dd8a0>"
+            klass = klass.class unless klass.is_a? Module
+
+            job_class = [klass, method].map(&:to_s).join(".")
           rescue
             DELAYED_WRAPPER_KLASS
           end

data/lib/scout_apm/layaway.rb

@@ -50,7 +50,8 @@ module ScoutApm
 
     def write_reporting_period(reporting_period, files_limit = MAX_FILES_LIMIT)
       if at_layaway_file_limit?(files_limit)
-        ScoutApm::Agent.instance.logger.error("Hit layaway file limit. Not writing to layaway file")
+        # This will happen constantly once we hit this case, so only log the first time
+        @wrote_layaway_limit_error_message ||= ScoutApm::Agent.instance.logger.error("Hit layaway file limit. Not writing to layaway file")
         return false
       end
       filename = file_for(reporting_period.timestamp)
@@ -58,9 +59,22 @@ module ScoutApm
       layaway_file.write(reporting_period)
     end
 
-    # Claims a given timestamp (getting a lock on a particular filename),
-    # then yields ReportingPeriods collected up from all the files.
-    # If the yield returns truthy, delete the layaway files that made it up.
+    # Claims a given timestamp by getting an exclusive lock on a timestamped
+    # coordinator file. The coordinator file never contains data, it's just a
+    # syncronization mechanism.
+    #
+    # Once the 'claim' is obtained:
+    #   * load and yield each ReportingPeriod from the layaway files.
+    #   * if there are reporting periods:
+    #     * yields any ReportingPeriods collected up from all the files.
+    #     * deletes all of the layaway files (including the coordinator) for the timestamp
+    #   * if not
+    #     * delete the coordinator
+    #   * remove any stale layaway files that may be hanging around.
+    #   * Finally unlock and ensure the coordinator file is cleared.
+    #
+    # If a claim file can't be obtained, return false without doing any work
+    # Another process is handling the reporting.
     def with_claim(timestamp)
       coordinator_file = glob_pattern(timestamp, :coordinator)
 
@@ -85,14 +99,14 @@ module ScoutApm
 
               ScoutApm::Agent.instance.logger.debug("Deleting the now-reported layaway files for #{timestamp.to_s}")
               delete_files_for(timestamp) # also removes the coodinator_file
-
-              ScoutApm::Agent.instance.logger.debug("Checking for any Stale layaway files")
-              delete_stale_files(timestamp.to_time - STALE_AGE)
             else
               File.unlink(coordinator_file)
               ScoutApm::Agent.instance.logger.debug("No layaway files to report")
             end
 
+            ScoutApm::Agent.instance.logger.debug("Checking for any Stale layaway files")
+            delete_stale_files(timestamp.to_time - STALE_AGE)
+
             true
           rescue Exception => e
             ScoutApm::Agent.instance.logger.debug("Caught an exception in with_claim, with the coordination file locked: #{e.message}, #{e.backtrace.inspect}")

data/lib/scout_apm/remote/server.rb

@@ -17,6 +17,8 @@ module ScoutApm
       end
 
       def start
+        require 'webrick'
+
         @server = WEBrick::HTTPServer.new(
           :BindAddress => bind,
           :Port => port,

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.3.4"
+  VERSION = "2.3.5"
 end
 

data/lib/scout_apm.rb

@@ -14,7 +14,6 @@ require 'socket'
 require 'thread'
 require 'time'
 require 'yaml'
-require 'webrick'
 
 #####################################
 # Gem Requires

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest