scout_apm 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e7455372ff88117a2caf4ecac5634b833131c30
-  data.tar.gz: c726bd01b48f93f6bd55f5b06dd36f86ecabfa4b
+  metadata.gz: 3e07d333b6388ad233485d64c3c1f460a0267873
+  data.tar.gz: 2fae8e481a1c38dc02aa99f77fef443bc4e30ec4
 SHA512:
-  metadata.gz: 8d996da034590250b3fcc9b87a412de39ddb01956ee144c4bd4917f4f7b18f6a23650fcbd9b9e2f6f48c2ac8952cc972bd65415b5e5cbbcc733fa26981111796
-  data.tar.gz: ea8f5cfe8e3e9222d138a7c09f40d57b32d19a756f8472b6d764b125f57a34cf54bf3f884668147a661cf1af1d3afd10e18dca9a9d4b110fb9d372c37fbea82a
+  metadata.gz: 119d47bb1e32990a8841e34aca493b614b3ac060a43a77de6779e4bbf7d1b8d6be7f4630bcb5ee2672f9bb0ddb4b7a4f2e83962807d78ca0181e22d923f03a30
+  data.tar.gz: 339f928af02ecfcdbf82b546e2666f86bba4fd7aef9f34e95637992b4d61d3070873ab17dfebbcf6b5a41b06f6179cc1c3ab3b60f33dbe8cc88608d1fa77c271

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp/*
 test/tmp/*coverage/*
 coverage/*
 lib/*.bundle
+lib/*.so

data/CHANGELOG.markdown

@@ -1,5 +1,15 @@
 # master
 
+# 2.1.5
+
+* Be less strict loading Rails environments that don't have a matching
+  scout_apm.yml section. Previously we raised, now we log and continue
+  to load with the ENV settings
+* Fix a memory leak in error recovery code
+* Fix a minor race condition in data coordination between processes.
+  * There was a tiny sliver of a window where a lock wasn't held, and it caused
+    an exception to be raised.
+
 # 2.1.4
 
 * Enhance regular expression that determines if a backtrace line is "inside"

data/lib/scout_apm/background_worker.rb

@@ -25,13 +25,13 @@ module ScoutApm
     def start(&block)
       @task = block
 
-      begin
-        ScoutApm::Agent.instance.logger.debug "Background Worker: Starting Background Worker, running every #{period} seconds"
+      ScoutApm::Agent.instance.logger.debug "Background Worker: Starting Background Worker, running every #{period} seconds"
 
-        # The first run should be 1 period of time from now
-        next_time = Time.now + period
+      # The first run should be 1 period of time from now
+      next_time = Time.now + period
 
-        loop do
+      loop do
+        begin
           # Bail out if @keep_running is false
           unless @keep_running
             ScoutApm::Agent.instance.logger.debug "Background Worker: breaking from loop"
@@ -53,11 +53,11 @@ module ScoutApm
           while next_time <= now
             next_time += period
           end
+        rescue
+          ScoutApm::Agent.instance.logger.debug "Background Worker Exception!"
+          ScoutApm::Agent.instance.logger.debug $!.message
+          ScoutApm::Agent.instance.logger.debug $!.backtrace
         end
-      rescue
-        ScoutApm::Agent.instance.logger.debug "Background Worker Exception!"
-        ScoutApm::Agent.instance.logger.debug $!.message
-        ScoutApm::Agent.instance.logger.debug $!.backtrace
       end
     end
   end

data/lib/scout_apm/config.rb

@@ -22,11 +22,6 @@ require 'scout_apm/environment'
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
 
-
-# Config - Made up of config overlay
-# Default -> File -> Environment Var
-# QUESTION: How to embed arrays or hashes into ENV?
-
 module ScoutApm
   class Config
 
@@ -129,7 +124,7 @@ module ScoutApm
     def self.with_file(file_path=nil, config={})
       overlays = [
         ConfigEnvironment.new,
-        ConfigFile.new(file_path, config[:file]),
+        ConfigFile.new(file_path, config),
         ConfigDefaults.new,
         ConfigNull.new,
       ]
@@ -149,7 +144,7 @@ module ScoutApm
                     nil
                   end
 
-      coercion = SETTING_COERCIONS[key] || NullCoercion.new
+      coercion = SETTING_COERCIONS.fetch(key, NullCoercion.new)
       coercion.coerce(raw_value)
     end
 
@@ -163,7 +158,8 @@ module ScoutApm
         'disabled_instruments'   => [],
         'enable_background_jobs' => true,
         'ignore'                 => [],
-        'dev_trace' => false, # false for now so code can live in main branch
+        'dev_trace'              => false,
+        'profile'                => true # for scoutprof
       }.freeze
 
       def value(key)
@@ -247,15 +243,16 @@ module ScoutApm
           raw_file = File.read(@resolved_file_path)
           erb_file = ERB.new(raw_file).result(binding)
           parsed_yaml = YAML.load(erb_file)
-          @settings = parsed_yaml[app_environment]
+          file_settings = parsed_yaml[app_environment]
 
-          if !@settings.is_a? Hash
-            raise ("Missing environment key for: #{app_environment}. This can happen if the key is missing, or with a malformed configuration file," +
-                   " check that there is a top level #{app_environment} key.")
+          if file_settings.is_a? Hash
+            logger.debug("Loaded Configuration: #{@resolved_file_path}. Using environment: #{app_environment}")
+            @settings = file_settings
+            @file_loaded = true
+          else
+            logger.info("Couldn't find configuration in #{@resolved_file_path} for environment: #{app_environment}. Configuration in ENV will still be applied.")
+            @file_loaded = false
           end
-
-          logger.debug("Loaded Configuration: #{@resolved_file_path}. Using environment: #{app_environment}")
-          @file_loaded = true
         rescue Exception => e # Explicit `Exception` handling to catch SyntaxError and anything else that ERB or YAML may throw
           logger.debug("Failed loading configuration file: #{e.message}. ScoutAPM will continue starting with configuration from ENV and defaults")
           @file_loaded = false

data/lib/scout_apm/layaway.rb

@@ -61,11 +61,15 @@ module ScoutApm
       coordinator_file = glob_pattern(timestamp, :coordinator)
 
 
-      # This file gets deleted only by a process that successfully obtained a lock
-      f = File.open(coordinator_file, File::RDWR | File::CREAT)
       begin
-        # Nonblocking, Exclusive lock.
-        if f.flock(File::LOCK_EX | File::LOCK_NB)
+        # This file gets deleted only by a process that successfully created and obtained the exclusive lock
+        f = File.open(coordinator_file, File::RDWR | File::CREAT | File::EXCL | File::NONBLOCK)
+      rescue Errno::EEXIST
+        false
+      end
+
+      begin
+        if f
 
           ScoutApm::Agent.instance.logger.debug("Obtained Reporting Lock")
 
@@ -87,7 +91,6 @@ module ScoutApm
           true
         else
           # Didn't obtain lock, another process is reporting. Return false from this function, but otherwise no work
-          f.close
           false
         end
       end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.4"
+  VERSION = "2.1.5"
 end
 

data/test/unit/config_test.rb

@@ -26,5 +26,47 @@ class ConfigTest < Minitest::Test
     assert_equal "debug", conf.value('log_level')
     assert_equal "APM Test Conf (Production)", conf.value('name')
   end
+
+  def test_loading_file_without_env_in_file
+    conf_file = File.expand_path("../../data/config_test_1.yml", __FILE__)
+    conf = ScoutApm::Config.with_file(conf_file, environment: "staging")
+
+    assert_equal "info", conf.value('log_level') # the default value
+    assert_equal nil, conf.value('name')         # the default value
+  end
+
+  def test_boolean_coercion
+    coercion = ScoutApm::Config::BooleanCoercion.new
+    assert_equal true, coercion.coerce("true")
+    assert_equal true, coercion.coerce("t")
+    assert_equal false, coercion.coerce("false")
+    assert_equal false, coercion.coerce("f")
+    assert_equal false, coercion.coerce("")
+
+    assert_equal true, coercion.coerce(true)
+    assert_equal false, coercion.coerce(false)
+    assert_equal false, coercion.coerce(nil)
+
+    assert_equal true, coercion.coerce(1)
+    assert_equal true, coercion.coerce(20)
+    assert_equal true, coercion.coerce(-1)
+    assert_equal false, coercion.coerce(0)
+
+    # for any other unknown class, there is no clear answer, so be safe and say false.
+    assert_equal false, coercion.coerce([])
+  end
+
+  def test_json_coersion
+    coercion = ScoutApm::Config::JsonCoercion.new
+    assert_equal [1,2,3], coercion.coerce('[1,2,3]')
+    assert_equal ['foo/bar','baz/quux'], coercion.coerce('["foo/bar", "baz/quux"]')
+
+    assert_equal({"foo" => "bar"}, coercion.coerce('{"foo": "bar"}'))
+
+    assert_equal true, coercion.coerce(true)
+    assert_equal 10, coercion.coerce(10)
+    assert_equal ["a"], coercion.coerce(["a"])
+  end
 end
 
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rusage