scout_apm 2.6.10 → 3.0.0.pre0

data/gems/README.md

@@ -1,28 +0,0 @@
-# Gems
-
-These gemfiles list specific configurations of gems that we use in travis testing.
-
-## Travis Matrix
-
-```yaml
-matrix:
-  include:
-    - rvm: "1.8.7"
-      gemfile: gems/rails3.gemfile
-```
-
-Using a gemfile controls the specific versions of the gems that are installed, and can be used to reproduce customer configurations for testing.
-
-## Local Testing
-
-To install the gems specified by a specific gemfile:
-
-```
-BUNDLE_GEMFILE=gems/rails5.gemfile bundle install
-```
-
-Then, to run tests using these gems:
-
-```
-BUNDLE_GEMFILE=gems/rails5.gemfile bundle exec rake
-```

data/gems/octoshark.gemfile

@@ -1,4 +0,0 @@
-eval_gemfile("../Gemfile")
-
-# https://github.com/scoutapp/scout_apm_ruby/issues/217
-gem 'octoshark'

data/gems/rails3.gemfile

@@ -1,5 +0,0 @@
-eval_gemfile("../Gemfile")
-
-gem "json", "1.8.6"
-gem "rails", "~> 3.2"
-gem "sqlite3", "~> 1.3.5"

data/gems/rails4.gemfile

@@ -1,4 +0,0 @@
-eval_gemfile("../Gemfile")
-
-gem "rails", "~> 4.2"
-gem "sqlite3", "~> 1.3.6"

data/gems/rails5.gemfile

@@ -1,4 +0,0 @@
-eval_gemfile("../Gemfile")
-
-gem "rails", "~> 5.0"
-gem "sqlite3", "~> 1.3", ">= 1.3.6"

data/gems/rails6.gemfile

@@ -1,4 +0,0 @@
-eval_gemfile("../Gemfile")
-
-gem "rails", "~> 6.0.0rc1"
-gem "sqlite3", "~> 1.4"

data/lib/scout_apm/agent/exit_handler.rb

@@ -1,65 +0,0 @@
-module ScoutApm
-  class Agent
-    class ExitHandler
-      attr_reader :context
-
-      def initialize(context)
-        @context = context
-      end
-
-      def install
-        logger.debug "Shutdown handler not supported" and return unless exit_handler_supported?
-        logger.debug "Installing Shutdown Handler"
-
-        at_exit do
-          logger.info "Shutting down Scout Agent"
-          # MRI 1.9 bug drops exit codes.
-          # http://bugs.ruby-lang.org/issues/5218
-          if environment.ruby_19?
-            status = $!.status if $!.is_a?(SystemExit)
-            shutdown
-            exit status if status
-          else
-            shutdown
-          end
-        end
-      end
-
-      private
-
-      # Called via the at_exit handler, it:
-      # (1) Stops the background worker
-      # (2) Stores metrics locally (forcing current-minute metrics to be written)
-      # It does not attempt to actually report metrics.
-      def shutdown
-        logger.info "Shutting down ScoutApm"
-        return if !context.started?
-        context.shutting_down!
-        ::ScoutApm::Agent.instance.stop_background_worker
-      end
-
-      def exit_handler_supported?
-        if environment.sinatra?
-          logger.debug "Exit handler not supported for Sinatra"
-          false
-        elsif environment.jruby?
-          logger.debug "Exit handler not supported for JRuby"
-          false
-        elsif environment.rubinius?
-          logger.debug "Exit handler not supported for Rubinius"
-          false
-        else
-          true
-        end
-      end
-
-      def logger
-        context.logger
-      end
-
-      def environment
-        context.environment
-      end
-    end
-  end
-end

data/lib/scout_apm/agent/preconditions.rb

@@ -1,81 +0,0 @@
-module ScoutApm
-  class Agent
-    class Preconditions
-      # The preconditions here must be a 2 element hash, with :message and :check.
-      # message: Proc that takes the environment, and returns a string
-      # check: Proc that takes an AgentContext and returns true if precondition was met, if false, we shouldn't start.
-      # severity: Severity of the log message (one of: :debug, :info, :warn, :error or :fatal)
-      PRECONDITIONS = [
-        PRECONDITION_ENABLED = {
-          :message => proc {|environ| "Monitoring isn't enabled for the [#{environ.env}] environment." },
-          :check => proc { |context| context.config.value('monitor') },
-          :severity => :info,
-        },
-
-        PRECONDITION_APP_NAME = {
-          :message => proc {|environ| "An application name could not be determined. Specify the :name value in scout_apm.yml." },
-          :check => proc { |context| context.environment.application_name },
-          :severity => :warn,
-        },
-
-        PRECONDITION_INTERACTIVE = {
-          :message => proc {|environ| "Agent attempting to load in interactive mode." },
-          :check => proc { |context| ! context.environment.interactive? },
-          :severity => :info,
-        },
-
-        PRECONDITION_DETECTED_SERVER = {
-          :message => proc {|environ| "Deferring agent start. Standing by for first request" },
-          :check => proc { |context|
-            app_server_missing = !context.environment.app_server_integration(true).found?
-            background_job_missing = context.environment.background_job_integrations.length == 0
-
-            !app_server_missing && !background_job_missing
-          },
-          :severity => :info,
-        },
-
-        PRECONDITION_ALREADY_STARTED = {
-          :message => proc {|environ| "Already started agent." },
-          :check => proc { |context| !context.started? },
-          :severity => :info,
-        },
-
-        PRECONDITION_OLD_SCOUT_RAILS = {
-          :message => proc {|environ| "ScoutAPM is incompatible with the old Scout Rails plugin. Please remove scout_rails from your Gemfile" },
-          :check => proc { !defined?(::ScoutRails) },
-          :severity => :warn,
-        },
-      ]
-
-      def check?(context)
-        @check_result ||=
-          begin
-            failed_preconditions = PRECONDITIONS.inject(Array.new) { |errors, condition|
-              unless condition[:check].call(context)
-                errors << {
-                  :severity => condition[:severity],
-                  :message => condition[:message].call(context.environment),
-                }
-              end
-
-              errors
-            }
-
-            if failed_preconditions.any?
-              failed_preconditions.each {|error| context.logger.send(error[:severity], error[:message]) }
-              force? # if forced, return true anyway
-            else
-              # No errors, we met preconditions
-              true
-            end
-          end
-      end
-
-      # XXX: Wire up options here and below in the appserver & bg server detections
-      def force?
-        false
-      end
-    end
-  end
-end

data/lib/scout_apm/agent_context.rb

@@ -1,261 +0,0 @@
-module ScoutApm
-  class AgentContext
-
-    attr_accessor :extensions
-
-    # Initially start up without attempting to load a configuration file. We
-    # need to be able to lookup configuration options like "application_root"
-    # which would then in turn influence where the yaml configuration file is
-    # located
-    #
-    # Later in initialization, we set config= to include the file.
-    def initialize()
-      @logger = LoggerFactory.build_minimal_logger
-      @process_start_time = Time.now
-      @extensions = ScoutApm::Extensions::Config.new(self)
-    end
-
-    def marshal_dump
-      []
-    end
-
-    def marshal_load(*args)
-      @logger = LoggerFactory.build_minimal_logger
-      @process_start_time = Time.now
-    end
-
-    #####################################
-    #  Lifecycle: Remote Server/Client
-    #
-    #  This allows short lived forked processes to communicate back to the parent process.
-    #  Used in the Resque instrumentation
-    #
-    #  Parent Pre-fork: start_remote_server! once
-    #  Child Post-fork: become_remote_client! after each fork
-    #
-    #  TODO: Figure out where to extract this to
-    #####################################
-
-    def start_remote_server!(bind, port)
-      return if @remote_server && @remote_server.running?
-
-      logger.info("Starting Remote Agent Server")
-
-      # Start the listening web server only in parent process.
-      @remote_server = ScoutApm::Remote::Server.new(
-        bind,
-        port,
-        ScoutApm::Remote::Router.new(ScoutApm::SynchronousRecorder.new(self), logger),
-        logger
-      )
-
-      @remote_server.start
-    end
-
-    # Execute this in the child process of a remote agent. The parent is
-    # expected to have its accepting webserver up and running
-    def become_remote_client!(host, port)
-      logger.debug("Becoming Remote Agent (reporting to: #{host}:#{port})")
-      @recorder = ScoutApm::Remote::Recorder.new(host, port, logger)
-      @store = ScoutApm::FakeStore.new
-    end
-
-
-    ###############
-    #  Accessors  #
-    ###############
-
-    attr_reader :process_start_time
-
-    def config
-      @config ||= ScoutApm::Config.without_file(self)
-    end
-
-    def environment
-      @environment ||= ScoutApm::Environment.instance
-    end
-
-    def started?
-      @started
-    end
-
-    def shutting_down?
-      @shutting_down
-    end
-
-    def installed?
-      @installed
-    end
-
-    def logger
-      @logger ||= LoggerFactory.build(config, environment)
-    end
-
-    def ignored_uris
-      @ignored_uris ||= ScoutApm::IgnoredUris.new(config.value('ignore'))
-    end
-
-    def slow_request_policy
-      @slow_request_policy ||= ScoutApm::SlowRequestPolicy.new(self)
-    end
-
-    def slow_job_policy
-      @slow_job_policy ||= ScoutApm::SlowJobPolicy.new(self)
-    end
-
-    # Maintains a Histogram of insignificant/significant autoinstrument layers.
-    # significant = 1
-    # insignificant = 0
-    def auto_instruments_layer_histograms
-      @auto_instruments_layer_histograms ||= ScoutApm::RequestHistograms.new
-    end
-
-    # Histogram of the cumulative requests since the start of the process
-    def request_histograms
-      @request_histograms ||= ScoutApm::RequestHistograms.new
-    end
-
-    # Histogram of the requests, distinct by reporting period (minute)
-    # { StoreReportingPeriodTimestamp => RequestHistograms }
-    def request_histograms_by_time
-      @request_histograms_by_time ||= Hash.new { |h, k| h[k] = ScoutApm::RequestHistograms.new }
-    end
-
-    def transaction_time_consumed
-      @transaction_time_consumed ||= ScoutApm::TransactionTimeConsumed.new
-    end
-
-    def store
-      return @store if @store
-      self.store = ScoutApm::Store.new(self)
-    end
-
-    def layaway
-      @layaway ||= ScoutApm::Layaway.new(self)
-    end
-
-    def recorder
-      @recorder ||= RecorderFactory.build(self)
-    end
-
-    def dev_trace_enabled?
-      config.value('dev_trace') && environment.env == "development"
-    end
-
-    ###################
-    #  Error Service  #
-    ###################
-
-    def error_buffer
-      @error_buffer ||= ScoutApm::ErrorService::ErrorBuffer.new(self)
-    end
-
-    def ignored_exceptions
-      @ignored_exceptions ||= ScoutApm::ErrorService::IgnoredExceptions.new(self, config.value('errors_ignored_exceptions'))
-    end
-
-    #############
-    #  Setters  #
-    #############
-
-    # When we set the config for any reason, there are some values we must
-    # reinitialize, since the config could have changed their settings, so nil
-    # them out here, then let them get lazily reset as needed
-    #
-    # Don't use this in initializer, since it'll attempt to log immediately
-    def config=(config)
-      @config = config
-
-      @logger = nil
-
-      log_configuration_settings
-
-      @ignored_uris = nil
-      @slow_request_policy = nil
-      @slow_job_policy = nil
-      @request_histograms = nil
-      @request_histograms_by_time = nil
-      @store = nil
-      @layaway = nil
-      @recorder = nil
-    end
-
-    def installed!
-      @installed = true
-    end
-
-    def started!
-      @started = true
-    end
-
-    def shutting_down!
-      @shutting_down = true
-    end
-
-    def store=(store)
-      @store = store
-
-      # Installs the default samplers
-      # Don't install samplers on nil stores
-      if store
-        ScoutApm::Instruments::Samplers::DEFAULT_SAMPLERS.each { |s| store.add_sampler(s) }
-      end
-    end
-
-    def recorder=(recorder)
-      @recorder = recorder
-    end
-
-    # I believe this is only useful for testing?
-    def environment=(env)
-      @environment = env
-    end
-
-    #########################
-    #  Callbacks & helpers  #
-    #
-    #  Should find ways to remove these into external spots
-    #########################
-
-    # Called after config is reset and loaded from file
-    def log_configuration_settings
-      @config.log_settings(logger)
-
-      if !@config.any_keys_found?
-        logger.info("No configuration file loaded, and no configuration found in ENV. " +
-                    "For assistance configuring Scout, visit " +
-                    "https://docs.scoutapm.com/#ruby-configuration-options")
-      end
-    end
-  end
-
-  class RecorderFactory
-    def self.build(context)
-      if context.config.value("async_recording")
-        context.logger.debug("Using asynchronous recording")
-        ScoutApm::BackgroundRecorder.new(context).start
-      else
-        context.logger.debug("Using synchronous recording")
-        ScoutApm::SynchronousRecorder.new(context).start
-      end
-    end
-  end
-
-  class LoggerFactory
-    def self.build(config, environment)
-      ScoutApm::Logger.new(environment.root,
-        {
-          :log_level     => config.value('log_level'),
-          :log_file_path => config.value('log_file_path'),
-          :stdout        => config.value('log_stdout') || environment.platform_integration.log_to_stdout?,
-          :stderr        => config.value('log_stderr'),
-          :logger_class  => config.value('log_class'),
-        }
-      )
-    end
-
-    def self.build_minimal_logger
-      ScoutApm::Logger.new(nil, :stdout => true)
-    end
-  end
-end

data/lib/scout_apm/auto_instrument/instruction_sequence.rb

@@ -1,31 +0,0 @@
-
-require 'scout_apm/auto_instrument/rails'
-
-module ScoutApm
-  module AutoInstrument
-    module InstructionSequence
-      def load_iseq(path)
-        if Rails.controller_path?(path) & !Rails.ignore?(path)
-          begin
-            new_code = Rails.rewrite(path)
-            return self.compile(new_code, path, path)
-          rescue
-            warn "Failed to apply auto-instrumentation to #{path}: #{$!}"
-          end
-        elsif Rails.ignore?(path)
-          warn "AutoInstruments are ignored for path=#{path}."
-        end
-
-        return self.compile_file(path)
-      end
-    end
-
-    # This should work (https://bugs.ruby-lang.org/issues/15572), but it doesn't.
-    # RubyVM::InstructionSequence.extend(InstructionSequence)
-
-    # So we do this instead:
-    class << ::RubyVM::InstructionSequence
-      prepend InstructionSequence
-    end
-  end
-end

data/lib/scout_apm/auto_instrument/layer.rb

@@ -1,23 +0,0 @@
-
-module ScoutApm
-  def self.AutoInstrument(name, backtrace)
-    request = ScoutApm::RequestManager.lookup
-
-    file_name, _ = backtrace.first.split(":", 2)
-
-    begin
-      layer = ScoutApm::Layer.new('AutoInstrument', name)
-      layer.backtrace = backtrace
-      layer.file_name = file_name
-
-      request.start_layer(layer)
-      started_layer = true
-
-      result = yield
-    ensure
-      request.stop_layer if started_layer
-    end
-
-    return result
-  end
-end

data/lib/scout_apm/auto_instrument/parser.rb

@@ -1,27 +0,0 @@
-
-require 'parser/current'
-raise LoadError, "Parser::TreeRewriter was not defined" unless defined?(Parser::TreeRewriter)
-
-module ScoutApm
-  module AutoInstrument
-    class Cache
-      def initialize
-        @local_assignments = {}
-      end
-      
-      def local_assignments?(node)
-        unless @local_assignments.key?(node)
-          if node.type == :lvasgn
-            @local_assignments[node] = true
-          elsif node.children.find{|child| child.is_a?(Parser::AST::Node) && self.local_assignments?(child)}
-            @local_assignments[node] = true
-          else
-            @local_assignments[node] = false
-          end
-        end
-        
-        return @local_assignments[node]
-      end
-    end
-  end
-end