scout_apm 3.0.0.pre13 → 3.0.0.pre14

data/lib/scout_apm/utils/scm.rb

@@ -4,7 +4,7 @@ module ScoutApm
     class Scm
       # Takes an *already relative* path +path+
       # Returns a relative path, prepending the configured +scm_subdirectory+ environment string
-      def self.relative_scm_path(path, scm_subdirectory = ScoutApm::Environment.instance.scm_subdirectory)
+      def self.relative_scm_path(path, scm_subdirectory = ScoutApm::Agent.instance.context.environment.scm_subdirectory)
         @@scm_subdirectory ||= scm_subdirectory.sub(/^\//, '')
         @@scm_subdirectoy_blank ||= @@scm_subdirectory.empty?
         @@scm_subdirectoy_blank ? path : File.join(@@scm_subdirectory, path)

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -16,7 +16,7 @@ module ScoutApm
 
       def initialize(sql)
         @raw_sql = sql
-        @database_engine = ScoutApm::Environment.instance.database_engine
+        @database_engine = ScoutApm::Agent.instance.context.environment.database_engine
         @sanitized = false # only sanitize once.
       end
 
@@ -78,13 +78,13 @@ module ScoutApm
         return '' if !str.is_a?(String) || str.length > 4000 # 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.logger.debug "Scrubbing invalid sql encoding."
+        ScoutApm::Agent.instance.context.logger.debug "Scrubbing invalid sql encoding."
         if str.respond_to?(:scrub) # Prefer to scrub before we have to convert
           return str.scrub('_')
         elsif has_encodings?(['UTF-8', 'binary'])
           return str.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '_')
         end
-        ScoutApm::Agent.instance.logger.debug "Unable to scrub invalid sql encoding."
+        ScoutApm::Agent.instance.context.logger.debug "Unable to scrub invalid sql encoding."
         ''
       end
 

data/lib/scout_apm/version.rb

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

data/lib/tasks/doctor.rake

@@ -0,0 +1,11 @@
+namespace :scout do
+  desc "Prints out details of the detected environment"
+  task :doctor => :environment do
+    ScoutApm::Tasks::Doctor.run!
+  end
+
+  desc "Collect logs, settings and environment to help debug issues"
+  task :support => :environment do
+    ScoutApm::Tasks::Support.run!
+  end
+end

data/scout_apm.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "addressable"
   s.add_development_dependency "guard"
   s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "activesupport"
 end

data/test/test_helper.rb

@@ -9,6 +9,8 @@ require 'mocha/mini_test'
 require 'pry'
 
 
+require 'active_support/core_ext/string/inflections'
+
 require 'scout_apm'
 
 Kernel.module_eval do
@@ -39,6 +41,14 @@ class FakeConfigOverlay
   def has_key?(key)
     @values.has_key?(key)
   end
+
+  def name
+    "agent-test-config-overlay"
+  end
+
+  def any_keys_found?
+    true
+  end
 end
 
 class FakeEnvironment
@@ -64,7 +74,7 @@ class Minitest::Test
   end
 
   def teardown
-    ScoutApm::Agent.instance.shutdown
+    ScoutApm::Agent.instance.stop_background_worker
     File.delete(DATA_FILE_PATH) if File.exist?(DATA_FILE_PATH)
   end
 
@@ -83,8 +93,13 @@ class Minitest::Test
     FakeEnvironment.new(values)
   end
 
+  # XXX: Make it easy to override context here?
   def make_fake_config(values)
-    ScoutApm::Config.new(FakeConfigOverlay.new(values))
+    ScoutApm::Config.new(agent_context, [FakeConfigOverlay.new(values), ScoutApm::Config::ConfigNull.new] )
+  end
+
+  def agent_context
+    ScoutApm::AgentContext.new
   end
 
   DATA_FILE_DIR = File.dirname(__FILE__) + '/tmp'

data/test/unit/agent_test.rb

@@ -1,58 +1,5 @@
 require 'test_helper'
-require 'scout_apm/agent'
-require 'scout_apm/slow_transaction'
-require 'scout_apm/metric_meta'
-require 'scout_apm/metric_stats'
-require 'scout_apm/context'
-require 'scout_apm/store'
 
 class AgentTest < Minitest::Test
-
-  # Safeguard to ensure the main agent thread doesn't have any interaction with the layaway file. Contention on file locks can cause delays.
-  def test_start_with_lock_on_layaway_file
-    # setup the file, putting a lock on it.
-    File.open(DATA_FILE_PATH, "w") {}
-    f = File.open(DATA_FILE_PATH, File::RDWR | File::CREAT)
-    f.flock(File::LOCK_EX)
-
-    agent = ScoutApm::Agent.instance
-
-    no_timeout = true
-    begin
-      Timeout::timeout(3) { agent.start({:monitor => true, :force => true}) }
-    rescue Timeout::Error
-      no_timeout = false
-    ensure
-      f.flock(File::LOCK_UN)
-      f.close
-    end
-    assert no_timeout, "Agent took >= 3s to start. Possible file lock issue."
-  end
-
-  def test_reset_file_with_old_format
-    File.open(DATA_FILE_PATH, 'w') { |file| file.write(Marshal.dump(OLD_FORMAT)) }
-    begin
-      ScoutApm::Agent.instance(:force => true).process_metrics
-    rescue NoMethodError
-      # The agent will raise an exception the first time metrics are processed for scout_apm < 1.2.
-      #
-      #  NoMethodError: undefined method `values' for []:Array
-      # /Users/dlite/projects/scout_apm_ruby/lib/scout_apm/layaway.rb:46:in `periods_ready_for_delivery'
-      # /Users/dlite/projects/scout_apm_ruby/lib/scout_apm/agent/reporting.rb:31:in `report_to_server'
-      # /Users/dlite/projects/scout_apm_ruby/lib/scout_apm/agent/reporting.rb:24:in `process_metrics'
-      # /Users/dlite/projects/scout_apm_ruby/test/unit/layaway_test.rb:27:in `test_reset_file_with_old_format'
-    end
-    # Data will be fine the next go-around
-    no_error = true
-    begin
-      ScoutApm::Agent.instance(:force => true).process_metrics
-    rescue Exception => e
-      no_error = false
-    end
-    assert no_error, "Error trying to process metrics after upgrading from < 1.2 data format: #{e.message if e}"
-  end
-
-  ## TODO - adds tests to ensure other potentially long-running things don't sneak in, like HTTP calls.
-
-  OLD_FORMAT = {1452533280 => {:metrics => {}, :slow_transactions => {}} } # Pre 1.2 agents used a different file format to store data. 
+  # XXX: Write tests around agent startup sequence
 end

data/test/unit/config_test.rb

@@ -3,8 +3,12 @@ require 'test_helper'
 require 'scout_apm/config'
 
 class ConfigTest < Minitest::Test
+  def setup
+    @context = ScoutApm::AgentContext.new
+  end
+
   def test_initalize_without_a_config
-    conf = ScoutApm::Config.without_file
+    conf = ScoutApm::Config.without_file(@context)
 
     # nil for random keys
     assert_nil conf.value('log_file_path')
@@ -21,7 +25,7 @@ class ConfigTest < Minitest::Test
     set_rack_env('production')
 
     conf_file = File.expand_path('../../data/config_test_1.yml', __FILE__)
-    conf = ScoutApm::Config.with_file(conf_file)
+    conf = ScoutApm::Config.with_file(@context, conf_file)
 
     assert_equal 'debug', conf.value('log_level')
     assert_equal 'APM Test Conf (Production)', conf.value('name')
@@ -29,7 +33,7 @@ class ConfigTest < Minitest::Test
 
   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")
+    conf = ScoutApm::Config.with_file(@context, conf_file, environment: "staging")
 
     assert_equal "info", conf.value('log_level') # the default value
     assert_nil nil, conf.value('name')         # the default value
@@ -71,11 +75,11 @@ class ConfigTest < Minitest::Test
   def test_any_keys_found
     ENV.stubs(:has_key?).returns(nil)
 
-    conf = ScoutApm::Config.with_file("a_file_that_doesnt_exist.yml")
+    conf = ScoutApm::Config.with_file(@context, "a_file_that_doesnt_exist.yml")
     assert ! conf.any_keys_found?
 
     ENV.stubs(:has_key?).with("SCOUT_MONITOR").returns("true")
-    conf = ScoutApm::Config.with_file("a_file_that_doesnt_exist.yml")
+    conf = ScoutApm::Config.with_file(@context, "a_file_that_doesnt_exist.yml")
     assert conf.any_keys_found?
   end
 end

data/test/unit/context_test.rb

@@ -4,25 +4,25 @@ require 'scout_apm/context'
 
 class ContextText < Minitest::Test
   def test_ignore_nil_value
-    context = ScoutApm::Context.new
+    context = ScoutApm::Context.new(ScoutApm::AgentContext.new)
     assert hash = context.add(:nil_key => nil, :org => 'org')
     assert_equal ({:org => 'org'}), hash
   end
 
   def test_ignore_nil_key
-    context = ScoutApm::Context.new
+    context = ScoutApm::Context.new(ScoutApm::AgentContext.new)
     assert hash = context.add(nil => nil, :org => 'org')
     assert_equal ({:org => 'org'}), hash
   end
 
   def test_ignore_unsupported_value_type
-    context = ScoutApm::Context.new
+    context = ScoutApm::Context.new(ScoutApm::AgentContext.new)
     assert hash = context.add(:array => [1,2,3,4], :org => 'org')
     assert_equal ({:org => 'org'}), hash
   end
 
   def test_ignore_unsupported_key_type
-    context = ScoutApm::Context.new
+    context = ScoutApm::Context.new(ScoutApm::AgentContext.new)
     assert hash = context.add([1,2,3,4] => 'hey', :org => 'org')
     assert_equal ({:org => 'org'}), hash
   end

data/test/unit/db_query_metric_set_test.rb

@@ -8,7 +8,9 @@ class DbQueryMetricSetTest < Minitest::Test
     config = make_fake_config(
       'database_metric_limit' => 5, # The hard limit on db metrics
       'database_metric_report_limit' => 2,)
-    set = DbQueryMetricSet.new(config)
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set = DbQueryMetricSet.new(context)
+
     set << fake_stat("a", 10)
     set << fake_stat("b", 20)
     set << fake_stat("c", 30)
@@ -23,7 +25,8 @@ class DbQueryMetricSetTest < Minitest::Test
     config = make_fake_config(
       'database_metric_limit' => 50, # much larger max, uninterested in hitting it.
       'database_metric_report_limit' => 2,)
-    set = DbQueryMetricSet.new(config)
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set = DbQueryMetricSet.new(context)
     set << fake_stat("a", 10)
     set << fake_stat("b", 20)
     set << fake_stat("c", 30)
@@ -36,10 +39,14 @@ class DbQueryMetricSetTest < Minitest::Test
   end
 
   def test_combine
-    set1 = DbQueryMetricSet.new
+    config = make_fake_config(
+      'database_metric_limit' => 5, # The hard limit on db metrics
+      'database_metric_report_limit' => 2,)
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set1 = DbQueryMetricSet.new(context)
     set1 << fake_stat("a", 10)
     set1 << fake_stat("b", 20)
-    set2 = DbQueryMetricSet.new
+    set2 = DbQueryMetricSet.new(context)
     set2 << fake_stat("c", 10)
     set2 << fake_stat("d", 20)
 

data/test/unit/fake_store_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class FakeStoreTest < Minitest::Test
   def test_responds_to_same_instance_methods_as_store
     fs = ScoutApm::FakeStore.new
-    s = ScoutApm::Store.new
+    s = ScoutApm::Store.new(ScoutApm::AgentContext.new)
 
     assert_equal [], s.methods - fs.methods
   end

data/test/unit/git_revision_test.rb

@@ -6,10 +6,10 @@ class GitRevisionTest < Minitest::Test
   # TODO - other tests that would be nice:
   # * ensure we only detect once, on initialize.
   # * tests for reading cap files
-  
+
   def test_sha_from_heroku
     ENV['HEROKU_SLUG_COMMIT'] = 'heroku_slug'
-    revision = ScoutApm::GitRevision.new
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
     assert_equal 'heroku_slug', revision.sha
   end
-end
+end

data/test/unit/instruments/net_http_test.rb

@@ -6,7 +6,8 @@ require 'addressable'
 
 class NetHttpTest < Minitest::Test
   def setup
-    ScoutApm::Instruments::NetHttp.new.install
+    @context = ScoutApm::AgentContext.new
+    ScoutApm::Instruments::NetHttp.new(@context).install
   end
 
   def test_request_scout_description_for_uri

data/test/unit/instruments/percentile_sampler_test.rb

@@ -9,13 +9,13 @@ class PercentileSamplerTest < Minitest::Test
   attr_reader :subject
 
   def setup
-    @subject = PercentileSampler.new(logger, histograms)
+    @context = ScoutApm::AgentContext.new
+    @subject = PercentileSampler.new(@context)
   end
 
-
   def test_initialize_with_logger_and_histogram_set
-    assert_equal subject.logger, logger
-    assert_equal subject.histograms, histograms
+    assert_equal subject.logger, @context.logger
+    assert_equal subject.histograms, @context.request_histograms_by_time
   end
 
   def test_implements_instrument_interface
@@ -113,11 +113,7 @@ class PercentileSamplerTest < Minitest::Test
   end
 
   def histograms
-    @histograms ||= begin
-                      @request_histograms_by_time = Hash.new { |hash, key|
-                        hash[key] = ScoutApm::RequestHistograms.new
-                      }
-                    end
+    @context.request_histograms_by_time
   end
 
   def histogram

data/test/unit/layaway_test.rb

@@ -10,27 +10,32 @@ class LayawayTest < Minitest::Test
   def test_directory_uses_DATA_FILE_option
     FileUtils.mkdir_p '/tmp/scout_apm_test/data_file_option'
     config = make_fake_config("data_file" => "/tmp/scout_apm_test/data_file_option")
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    layaway = ScoutApm::Layaway.new(context)
 
-    assert_equal Pathname.new("/tmp/scout_apm_test/data_file_option"), ScoutApm::Layaway.new(config, ScoutApm::Agent.instance.environment).directory
+    assert_equal Pathname.new("/tmp/scout_apm_test/data_file_option"), layaway.directory
   end
 
   def test_directory_looks_for_root_slash_tmp
     FileUtils.mkdir_p '/tmp/scout_apm_test/tmp'
     config = make_fake_config({})
     env = make_fake_environment(:root => "/tmp/scout_apm_test")
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config; c.environment = env }
 
-    assert_equal Pathname.new("/tmp/scout_apm_test/tmp"), ScoutApm::Layaway.new(config, env).directory
+    assert_equal Pathname.new("/tmp/scout_apm_test/tmp"), ScoutApm::Layaway.new(context).directory
   end
 
   def test_layaway_file_limit_prevents_new_writes
     FileUtils.mkdir_p '/tmp/scout_apm_test/layaway_limit'
     config = make_fake_config("data_file" => "/tmp/scout_apm_test/layaway_limit")
-    layaway = ScoutApm::Layaway.new(config, ScoutApm::Agent.instance.environment)
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    layaway = ScoutApm::Layaway.new(context)
     layaway.delete_files_for(:all)
 
+    context = ScoutApm::AgentContext.new
     current_time = Time.now.utc
-    current_rp = ScoutApm::StoreReportingPeriod.new(current_time)
-    stale_rp = ScoutApm::StoreReportingPeriod.new(current_time - current_time.sec - 120)
+    current_rp = ScoutApm::StoreReportingPeriod.new(current_time, context)
+    stale_rp = ScoutApm::StoreReportingPeriod.new(current_time - current_time.sec - 120, context)
 
     # layaway.write_reporting_period returns nil on successful write
     # It should probably be changed to return true or the number of bytes written

data/test/unit/layer_converters/metric_converter_test.rb

@@ -7,13 +7,13 @@ class MetricConverterTest < Minitest::Test
   include Stubs
 
   def test_register_adds_hooks
-    mc = MetricConverter.new(faux_request, faux_layer_finder, faux_store)
+    mc = MetricConverter.new(agent_context, faux_request, faux_layer_finder, faux_store)
     faux_walker.expects(:on)
     mc.register_hooks(faux_walker)
   end
 
   def test_record
-    mc = MetricConverter.new(faux_request, faux_layer_finder, faux_store)
+    mc = MetricConverter.new(agent_context, faux_request, faux_layer_finder, faux_store)
     faux_store.expects(:track!)
     mc.record!
   end

data/test/unit/slow_request_policy_test.rb

@@ -17,9 +17,13 @@ class FakeRequest
 end
 
 class SlowRequestPolicyTest < Minitest::Test
+  def setup
+    @context = ScoutApm::AgentContext.new
+  end
+
   def test_stored_records_current_time
     test_start = Time.now
-    policy = ScoutApm::SlowRequestPolicy.new
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
     request = FakeRequest.new("users/index")
 
     policy.stored!(request)
@@ -27,12 +31,12 @@ class SlowRequestPolicyTest < Minitest::Test
   end
 
   def test_score
-    policy = ScoutApm::SlowRequestPolicy.new
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
     request = FakeRequest.new("users/index")
 
     request.set_duration(10) # 10 seconds
     policy.last_seen[request.unique_name] = Time.now - 120 # 2 minutes since last seen
-    ScoutApm::Agent.instance.request_histograms.add(request.unique_name, 1)
+    @context.request_histograms.add(request.unique_name, 1)
 
     # Actual value I have in console is 1.499
     assert policy.score(request) > 1.45

data/test/unit/sql_sanitizer_test.rb

@@ -1,14 +1,8 @@
 require 'test_helper'
 
-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