scout_apm 3.0.0.pre13 → 3.0.0.pre14

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -42,7 +42,7 @@ module ScoutApm
         ::Sidekiq::Processor.class_eval do
           def initialize_with_scout(boss)
             agent = ::ScoutApm::Agent.instance
-            agent.start_background_worker
+            agent.start
             initialize_without_scout(boss)
           end
 
@@ -63,7 +63,7 @@ module ScoutApm
         queue_layer = ScoutApm::Layer.new('Queue', queue)
         job_layer = ScoutApm::Layer.new('Job', job_class(msg))
 
-        if ScoutApm::Agent.instance.config.value('profile') && SidekiqMiddleware.version_supports_profiling?
+        if ScoutApm::Agent.instance.context.config.value('profile') && SidekiqMiddleware.version_supports_profiling?
           # Capture ScoutProf if we can
           #req.enable_profiled_thread!
           #job_layer.set_root_class(job_class)

data/lib/scout_apm/background_recorder.rb

@@ -4,15 +4,20 @@
 
 module ScoutApm
   class BackgroundRecorder
+    attr_reader :context
+
     attr_reader :queue
     attr_reader :thread
-    attr_reader :logger
 
-    def initialize(logger)
-      @logger = logger
+    def initialize(context)
+      @context = context
       @queue = Queue.new
     end
 
+    def logger
+      context.logger
+    end
+
     def start
       logger.info("Starting BackgroundRecorder")
       @thread = Thread.new(&method(:thread_func))

data/lib/scout_apm/background_worker.rb

@@ -6,17 +6,24 @@ module ScoutApm
 
     attr_reader :period
 
-    def initialize(period=DEFAULT_PERIOD)
+    attr_reader :context
+
+    def initialize(context, period=DEFAULT_PERIOD)
+      @context = context
       @period = period
       @keep_running = true
     end
 
+    def logger
+      context.logger
+    end
+
     def running?
       @keep_running
     end
 
     def stop
-      ScoutApm::Agent.instance.logger.debug "Background Worker: stop requested"
+      logger.debug "Background Worker: stop requested"
       @keep_running = false
     end
 
@@ -29,7 +36,7 @@ module ScoutApm
     def start(&block)
       @task = block
 
-      ScoutApm::Agent.instance.logger.debug "Background Worker: Starting Background Worker, running every #{period} seconds"
+      logger.debug "Background Worker: starting to run every #{period} seconds"
 
       # The first run should be 1 period of time from now
       next_time = Time.now + period
@@ -47,7 +54,7 @@ module ScoutApm
 
           # Bail out if @keep_running is false
           unless @keep_running
-            ScoutApm::Agent.instance.logger.debug "Background Worker: breaking from loop"
+            logger.debug "Background Worker: breaking from loop"
             break
           end
 
@@ -58,9 +65,9 @@ module ScoutApm
             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
+          logger.debug "Background Worker Exception!"
+          logger.debug $!.message
+          logger.debug $!.backtrace
         end
       end
     end

data/lib/scout_apm/config.rb

@@ -52,8 +52,11 @@ module ScoutApm
         'hostname',
         'ignore',
         'key',
+        'log_class',
         'log_file_path',
         'log_level',
+        'log_stderr',
+        'log_stdout',
         'monitor',
         'name',
         'profile',
@@ -159,29 +162,30 @@ module ScoutApm
 
     # Load up a config instance without attempting to load a file.
     # Useful for bootstrapping.
-    def self.without_file
+    def self.without_file(context)
       overlays = [
         ConfigEnvironment.new,
         ConfigDefaults.new,
         ConfigNull.new,
       ]
-      new(overlays)
+      new(context, overlays)
     end
 
     # Load up a config instance, attempting to load a yaml file.  Allows a
     # definite location if requested, or will attempt to load the default
     # configuration file: APP_ROOT/config/scout_apm.yml
-    def self.with_file(file_path=nil, config={})
+    def self.with_file(context, file_path=nil, config={})
       overlays = [
         ConfigEnvironment.new,
-        ConfigFile.new(file_path, config),
+        ConfigFile.new(context, file_path, config),
         ConfigDefaults.new,
         ConfigNull.new,
       ]
-      new(overlays)
+      new(context, overlays)
     end
 
-    def initialize(overlays)
+    def initialize(context, overlays)
+      @context = context
       @overlays = Array(overlays)
     end
 
@@ -192,7 +196,7 @@ module ScoutApm
 
     def value(key)
       if ! KNOWN_CONFIG_OPTIONS.include?(key)
-        ScoutApm::Agent.instance.logger.debug("Requested looking up a unknown configuration key: #{key} (not a problem. Evaluate and add to config.rb)")
+        logger.debug("Requested looking up a unknown configuration key: #{key} (not a problem. Evaluate and add to config.rb)")
       end
 
       o = overlay_for_key(key)
@@ -212,12 +216,25 @@ module ScoutApm
       @overlays.any? { |overlay| overlay.any_keys_found? }
     end
 
-    def log_settings
-      messages = KNOWN_CONFIG_OPTIONS.inject([]) do |memo, key|
+    # Returns an array of config keys, values, and source
+    # {key: "monitor", value: "true", source: "environment"}
+    #
+    def all_settings
+      KNOWN_CONFIG_OPTIONS.inject([]) do |memo, key|
         o = overlay_for_key(key)
-        memo << "#{o.name} - #{key}: #{value(key).inspect}"
+        memo << {:key => key, :value => value(key).inspect, :source => o.name}
       end
-      ScoutApm::Agent.instance.logger.debug("Resolved Setting Values:\n" + messages.join("\n"))
+    end
+
+    def log_settings(logger)
+      logger.debug(
+        "Resolved Setting Values:\n" +
+        all_settings.map{|hsh| "#{hsh[:source]} - #{hsh[:key]}: #{hsh[:value]}"}.join("\n")
+      )
+    end
+
+    def logger
+      @context.logger
     end
 
     class ConfigDefaults
@@ -310,7 +327,8 @@ module ScoutApm
     # is not found, inaccessbile, or unparsable, log a message to that effect,
     # and move on.
     class ConfigFile
-      def initialize(file_path=nil, config={})
+      def initialize(context, file_path=nil, config={})
+        @context = context
         @config = config || {}
         @resolved_file_path = file_path || determine_file_path
         load_file(@resolved_file_path)
@@ -341,6 +359,8 @@ module ScoutApm
 
       private
 
+      attr_reader :context
+
       def load_file(file)
         @settings = {}
         if !File.exist?(@resolved_file_path)
@@ -376,26 +396,15 @@ module ScoutApm
       end
 
       def determine_file_path
-        File.join(ScoutApm::Environment.instance.root, "config", "scout_apm.yml")
+        File.join(context.environment.root, "config", "scout_apm.yml")
       end
 
       def app_environment
-        @config[:environment] || ScoutApm::Environment.instance.env
+        @config[:environment] || context.environment.env
       end
 
       def logger
-        if ScoutApm::Agent.instance.logger
-          return ScoutApm::Agent.instance.logger
-        else
-          l = Logger.new(STDOUT)
-          if ENV["SCOUT_LOG_LEVEL"] == "debug"
-            l.level = Logger::DEBUG
-          else
-            l.level = Logger::INFO
-          end
-
-          return l
-        end
+        context.logger
       end
     end
   end

data/lib/scout_apm/context.rb

@@ -5,11 +5,18 @@
 # For misc context, use @Context#add@.
 module ScoutApm
   class Context
-    def initialize
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
       @extra = {}
       @user = {}
     end
 
+    def logger
+      context.logger
+    end
+
     # Generates a hash representation of the Context.
     # Example: {:monthly_spend => 100, :user => {:ip => '127.0.0.1'}}
     def to_hash
@@ -78,7 +85,7 @@ module ScoutApm
       if value.nil?
         false # don't log this ... easy to happen
       elsif !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
-        ScoutApm::Agent.instance.logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
+        logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
         false
       else
         true
@@ -92,12 +99,12 @@ module ScoutApm
         false # don't log this ... easy to happen
       # ensure a string or a symbol
       elsif !valid_type?([String, Symbol],key)
-        ScoutApm::Agent.instance.logger.info "The key [#{key}] is not a valid type [#{key.class}]."
+        logger.info "The key [#{key}] is not a valid type [#{key.class}]."
         return false
       end
       # only alphanumeric, dash, and underscore allowed.
       if key.to_s.match(/[^\w-]/)
-        ScoutApm::Agent.instance.logger.info "They key name [#{key}] is not valid."
+        logger.info "They key name [#{key}] is not valid."
         return false
       end
       true

data/lib/scout_apm/db_query_metric_set.rb

@@ -1,14 +1,25 @@
+# Note, this class must be Marshal Dumpable
 module ScoutApm
   class DbQueryMetricSet
     include Enumerable
 
     attr_reader :metrics # the raw metrics. You probably want #metrics_to_report
-    attr_reader :config # A ScoutApm::Config instance
+    attr_reader :context
+
+    def marshal_dump
+      [ @metrics ]
+    end
+
+    def marshal_load(array)
+      @metrics = array.first
+      @context = ScoutApm::Agent.instance.context
+    end
+
+    def initialize(context)
+      @context = context
 
-    def initialize(config=ScoutApm::Agent.instance.config)
       # A hash of DbQueryMetricStats values, keyed by DbQueryMetricStats.key
       @metrics = Hash.new
-      @config = config
     end
 
     def each
@@ -54,7 +65,7 @@ module ScoutApm
     end
 
     def metrics_to_report
-      report_limit = config.value('database_metric_report_limit')
+      report_limit = context.config.value('database_metric_report_limit')
       if metrics.size > report_limit
         metrics.
           values.
@@ -73,8 +84,9 @@ module ScoutApm
     end
 
     def at_limit?
-      @limit ||= config.value('database_metric_limit')
+      @limit ||= context.config.value('database_metric_limit')
       metrics.size >= @limit
     end
+
   end
 end

data/lib/scout_apm/debug.rb

@@ -31,7 +31,7 @@ module ScoutApm
     end
 
     def logger
-      ScoutApm::Agent.instance.logger
+      ScoutApm::Agent.instance.context.logger
     end
   end
 end

data/lib/scout_apm/environment.rb

@@ -59,7 +59,7 @@ module ScoutApm
     end
 
     def application_name
-      Agent.instance.config.value("name") ||
+      Agent.instance.context.config.value("name") ||
         framework_integration.application_name ||
         "App"
     end
@@ -86,10 +86,10 @@ module ScoutApm
     end
 
     def scm_subdirectory
-      @scm_subdirectory ||= if Agent.instance.config.value('scm_subdirectory').empty?
+      @scm_subdirectory ||= if Agent.instance.context.config.value('scm_subdirectory').empty?
         ''
       else
-        Agent.instance.config.value('scm_subdirectory').sub(/^\//, '') # Trim any leading slash
+        Agent.instance.context.config.value('scm_subdirectory').sub(/^\//, '') # Trim any leading slash
       end
     end
 
@@ -98,7 +98,7 @@ module ScoutApm
     end
 
     def framework_root
-      if override_root = Agent.instance.config.value("application_root")
+      if override_root = Agent.instance.context.config.value("application_root")
         return override_root
       end
       if framework == :rails
@@ -113,11 +113,11 @@ module ScoutApm
     end
 
     def hostname
-      @hostname ||= Agent.instance.config.value("hostname") || platform_integration.hostname
+      @hostname ||= Agent.instance.context.config.value("hostname") || platform_integration.hostname
     end
 
     def git_revision
-      @git_revision ||= ScoutApm::GitRevision.new
+      @git_revision ||= ScoutApm::GitRevision.new(Agent.instance.context)
     end
 
     # Returns the whole integration object
@@ -141,18 +141,14 @@ module ScoutApm
       app_server_integration.forking? || (background_job_integration && background_job_integration.forking?)
     end
 
-    def background_job_integration
-      if Agent.instance.config.value("enable_background_jobs")
-        @background_job_integration ||= BACKGROUND_JOB_INTEGRATIONS.detect {|integration| integration.present?}
+    def background_job_integrations
+      if Agent.instance.context.config.value("enable_background_jobs")
+        @background_job_integrations ||= BACKGROUND_JOB_INTEGRATIONS.select {|integration| integration.present?}
       else
-        nil
+        []
       end
     end
 
-    def background_job_name
-      background_job_integration && background_job_integration.name
-    end
-
     # If both stdin & stdout are interactive and the Rails::Console constant is defined
     def interactive?
       defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty

data/lib/scout_apm/framework_integrations/sinatra.rb

@@ -25,7 +25,7 @@ module ScoutApm
           "Sinatra"
         end
       rescue => e
-        ScoutApm::Agent.instance.logger.debug "Failed getting Sinatra Application Name: #{e.message}\n#{e.backtrace.join("\n\t")}"
+        ScoutApm::Agent.instance.context.logger.debug "Failed getting Sinatra Application Name: #{e.message}\n#{e.backtrace.join("\n\t")}"
         "Sinatra"
       end
 

data/lib/scout_apm/git_revision.rb

@@ -1,11 +1,17 @@
 module ScoutApm
   class GitRevision
-
     attr_accessor :sha
 
-    def initialize
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
       @sha = detect
-      ScoutApm::Agent.instance.logger.debug "Detected Git Revision [#{@sha}]"
+      logger.debug "Detected Git Revision [#{@sha}]"
+    end
+
+    def logger
+      context.logger
     end
 
     private
@@ -30,7 +36,7 @@ module ScoutApm
       # Capistrano 3.0 - 3.1.x
       version || File.open(File.join(app_root, '..', 'revisions.log')).to_a.last.strip.sub(/.*as release ([0-9]+).*/, '\1')
     rescue
-      ScoutApm::Agent.instance.logger.debug "Unable to detect Git Revision from Capistrano: #{$!.message}"
+      logger.debug "Unable to detect Git Revision from Capistrano: #{$!.message}"
       nil
     end
 
@@ -39,13 +45,12 @@ module ScoutApm
         `git rev-parse --short HEAD`.strip 
       end
     rescue
-      ScoutApm::Agent.instance.logger.debug "Unable to detect Git Revision from Git: #{$!.message}"
+      logger.debug "Unable to detect Git Revision from Git: #{$!.message}"
       nil
     end
 
     def app_root
-      ScoutApm::Environment.instance.root
+      context.environment.root
     end
-
   end
-end
+end