scout_apm 2.6.10 → 3.0.0.pre0

data/lib/scout_apm/utils/fake_stacks.rb

@@ -0,0 +1,87 @@
+# A fake implementation of the allocations native extension, for systems that don't support it.
+module ScoutApm
+  module Instruments
+    class Stacks
+      ENABLED = false
+
+      class << self
+        def install(*args)
+          # noop
+        end
+
+        def uninstall(*args)
+          # noop
+        end
+
+        def start(*args)
+          # noop
+        end
+
+        def add_profiled_thread(*args)
+          # noop
+        end
+
+        def remove_profiled_thread(*args)
+          # noop
+        end
+
+        def profile_frames(*args)
+          [] # frames that were profiled (none)
+        end
+
+        def start_sampling(*args)
+          # noop
+        end
+
+        def stop_sampling(*args)
+          # noop
+        end
+
+        def update_indexes(*args)
+          # noop
+          true
+        end
+
+        def current_trace_index(*args)
+          :opaque_value
+        end
+
+        def current_frame_index(*args)
+          :opaque_value
+        end
+
+        def frame_klass(*args)
+          nil
+        end
+
+        def frame_method(*args)
+          nil
+        end
+
+        def frame_file(*args)
+          nil
+        end
+
+        def frame_lineno(*args)
+          nil
+        end
+
+        def skipped_in_gc(*args)
+          0
+        end
+
+        def skipped_in_handler(*args)
+          0
+        end
+
+        def skipped_in_job_registered(*args)
+          0
+        end
+
+        def skipped_in_not_running(*args)
+          0
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/utils/installed_gems.rb

@@ -1,14 +1,10 @@
 module ScoutApm
   module Utils
     class InstalledGems
-      attr_reader :context
+      attr_reader :logger
 
-      def initialize(context)
-        @context = context
-      end
-
-      def logger
-        context.logger
+      def initialize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
       end
 
       def run

data/lib/scout_apm/utils/klass_helper.rb

@@ -5,12 +5,6 @@ module ScoutApm
       # KlassHelper.defined?("ActiveRecord::Base")   #=> true / false
 
       def self.defined?(*names)
-        lookup(*names) != :missing_class
-      end
-
-      # KlassHelper.lookup("ActiveRecord::Base") => ActiveRecord::Base
-      # KlassHelper.lookup("ActiveRecord::SomethingThatDoesNotExist") => :missing_class
-      def self.lookup(*names)
         if names.length == 1
           names = names[0].split("::")
         end
@@ -21,11 +15,11 @@ module ScoutApm
           begin
             obj = obj.const_get(name)
           rescue NameError
-            return :missing_class
+            return false
           end
         end
 
-        obj
+        true
       end
     end
   end

data/lib/scout_apm/utils/null_logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module ScoutApm
+  module Utils
+    class NullLogger < Logger
+      def initialize(*args)
+      end
+
+      def add(*args, &block)
+      end
+    end
+  end
+end

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -16,7 +16,7 @@ module ScoutApm
 
       def initialize(sql)
         @raw_sql = sql
-        @database_engine = ScoutApm::Agent.instance.context.environment.database_engine
+        @database_engine = ScoutApm::Environment.instance.database_engine
         @sanitized = false # only sanitize once.
       end
 
@@ -34,24 +34,15 @@ module ScoutApm
         when :postgres then to_s_postgres
         when :mysql    then to_s_mysql
         when :sqlite   then to_s_sqlite
-        when :sqlserver then to_s_sqlserver
         end
       end
 
       private
 
-      def to_s_sqlserver
-        sql.gsub!(SQLSERVER_EXECUTESQL, '\1')
-        sql.gsub!(SQLSERVER_REMOVE_INTEGERS, '?')
-        sql.gsub!(SQLSERVER_IN_CLAUSE, 'IN (?)')
-        sql
-      end
-
       def to_s_postgres
         sql.gsub!(PSQL_PLACEHOLDER, '?')
         sql.gsub!(PSQL_VAR_INTERPOLATION, '')
-        sql.gsub!(PSQL_AFTER_WHERE) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
-        sql.gsub!(PSQL_AFTER_SET) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
+        sql.gsub!(PSQL_REMOVE_STRINGS, '?')
         sql.gsub!(PSQL_REMOVE_INTEGERS, '?')
         sql.gsub!(PSQL_IN_CLAUSE, 'IN (?)')
         sql.gsub!(MULTIPLE_SPACES, ' ')
@@ -83,19 +74,17 @@ module ScoutApm
         encodings.all?{|enc| Encoding.find(enc) rescue false}
       end
 
-      MAX_SQL_LENGTH = 16384
-
       def scrubbed(str)
-        return '' if !str.is_a?(String) || str.length > MAX_SQL_LENGTH # safeguard - don't sanitize or scrub large SQL statements
+        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.context.logger.debug "Scrubbing invalid sql encoding."
+        ScoutApm::Agent.instance.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.context.logger.debug "Unable to scrub invalid sql encoding."
+        ScoutApm::Agent.instance.logger.debug "Unable to scrub invalid sql encoding."
         ''
       end
 

data/lib/scout_apm/utils/sql_sanitizer_regex.rb

@@ -10,8 +10,6 @@ module ScoutApm
       PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
       PSQL_PLACEHOLDER = /\$\d+/.freeze
       PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|$)/i.freeze
-      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|$)/i.freeze
 
       MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
@@ -22,11 +20,6 @@ module ScoutApm
       SQLITE_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
       SQLITE_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
-
-      # => "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE (age > 50)  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
-      SQLSERVER_EXECUTESQL = /EXEC sp_executesql N'(.*?)'.*/
-      SQLSERVER_REMOVE_INTEGERS = /(?<!LIMIT )\b(?<!@)\d+\b/.freeze
-      SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
     end
   end
 end

data/lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb

@@ -10,8 +10,6 @@ module ScoutApm
       PSQL_REMOVE_INTEGERS = /\b\d+\b/.freeze
       PSQL_PLACEHOLDER = /\$\d+/.freeze
       PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|$)/i.freeze
-      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|$)/i.freeze
 
       MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       MYSQL_REMOVE_INTEGERS = /\b\d+\b/.freeze
@@ -23,10 +21,6 @@ module ScoutApm
       SQLITE_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
       SQLITE_REMOVE_INTEGERS = /\b\d+\b/.freeze
 
-      # This is not officially supported, but will do its best.
-      SQLSERVER_EXECUTESQL = /EXEC sp_executesql N'(.*?)'.*/
-      SQLSERVER_REMOVE_INTEGERS = /\b\d+\b/.freeze
-      SQLSERVER_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
     end
   end
 end

data/lib/scout_apm/utils/unique_id.rb

@@ -11,32 +11,5 @@ module ScoutApm
         s
       end
     end
-
-    # Represents a random ID that we can use to track a certain transaction.
-    # The `trans` prefix is only for ease of reading logs - it should not be
-    # interpreted to convey any sort of meaning.
-    class TransactionId
-      def initialize
-        @random = SecureRandom.hex(16)
-      end
-
-      def to_s
-        "trans-#{@random}"
-      end
-    end
-
-    # Represents a random ID that we can use to track a certain span. The
-    # `span` prefix is only for ease of reading logs - it should not be
-    # interpreted to convey any sort of meaning.
-    class SpanId
-      def initialize
-        @random = SecureRandom.hex(16)
-      end
-
-      def to_s
-        "span-#{@random}"
-      end
-    end
-
   end
 end

data/lib/scout_apm/version.rb

@@ -1,3 +1,4 @@
 module ScoutApm
-  VERSION = "2.6.10"
+  VERSION = "3.0.0.pre0"
 end
+

data/lib/scout_apm.rb

@@ -6,7 +6,6 @@ end
 #####################################
 require 'cgi'
 require 'logger'
-require 'monitor'
 require 'net/http'
 require 'openssl'
 require 'pp'
@@ -15,7 +14,7 @@ require 'socket'
 require 'thread'
 require 'time'
 require 'yaml'
-require 'securerandom'
+require 'rbconfig'
 
 #####################################
 # Gem Requires
@@ -27,11 +26,8 @@ require 'rusage'
 #####################################
 require 'scout_apm/version'
 
-require 'scout_apm/debug'
 require 'scout_apm/tracked_request'
 require 'scout_apm/layer'
-require 'scout_apm/limited_layer'
-require 'scout_apm/layer_children_set'
 require 'scout_apm/request_manager'
 require 'scout_apm/call_set'
 
@@ -41,13 +37,9 @@ require 'scout_apm/layer_converters/error_converter'
 require 'scout_apm/layer_converters/job_converter'
 require 'scout_apm/layer_converters/slow_job_converter'
 require 'scout_apm/layer_converters/metric_converter'
-require 'scout_apm/layer_converters/database_converter'
 require 'scout_apm/layer_converters/slow_request_converter'
 require 'scout_apm/layer_converters/request_queue_time_converter'
 require 'scout_apm/layer_converters/allocation_metric_converter'
-require 'scout_apm/layer_converters/trace_converter'
-require 'scout_apm/layer_converters/histograms'
-require 'scout_apm/layer_converters/find_layer_by_type'
 
 require 'scout_apm/server_integrations/passenger'
 require 'scout_apm/server_integrations/puma'
@@ -59,11 +51,6 @@ require 'scout_apm/server_integrations/null'
 
 require 'scout_apm/background_job_integrations/sidekiq'
 require 'scout_apm/background_job_integrations/delayed_job'
-require 'scout_apm/background_job_integrations/resque'
-require 'scout_apm/background_job_integrations/shoryuken'
-require 'scout_apm/background_job_integrations/sneakers'
-require 'scout_apm/background_job_integrations/que'
-require 'scout_apm/background_job_integrations/legacy_sneakers'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'
@@ -76,29 +63,35 @@ require 'scout_apm/platform_integrations/server'
 
 require 'scout_apm/histogram'
 
+require 'scout_apm/deploy_integrations/capistrano_3'
+# require 'scout_apm/deploy_integrations/capistrano_2'
+
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
-require 'scout_apm/instruments/memcached'
 require 'scout_apm/instruments/redis'
 require 'scout_apm/instruments/influxdb'
 require 'scout_apm/instruments/elasticsearch'
+require 'scout_apm/instruments/delayed_job'
 require 'scout_apm/instruments/active_record'
 require 'scout_apm/instruments/action_controller_rails_2'
 require 'scout_apm/instruments/action_controller_rails_3_rails4'
-require 'scout_apm/instruments/action_view'
 require 'scout_apm/instruments/middleware_summary'
-require 'scout_apm/instruments/middleware_detailed' # Disabled by default, see the file for more details
+# require 'scout_apm/instruments/middleware_detailed' # Currently disabled functionality, see the file for details.
 require 'scout_apm/instruments/rails_router'
 require 'scout_apm/instruments/grape'
 require 'scout_apm/instruments/sinatra'
-require 'allocations'
-
 require 'scout_apm/instruments/process/process_cpu'
 require 'scout_apm/instruments/process/process_memory'
 require 'scout_apm/instruments/percentile_sampler'
-require 'scout_apm/instruments/samplers'
+require 'allocations'
+
+begin
+  require 'stacks'
+rescue LoadError
+  require 'scout_apm/utils/fake_stacks'
+end
 
 require 'scout_apm/app_server_load'
 
@@ -107,19 +100,16 @@ require 'scout_apm/utils/active_record_metric_name'
 require 'scout_apm/utils/backtrace_parser'
 require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/klass_helper'
-require 'scout_apm/utils/scm'
+require 'scout_apm/utils/null_logger'
 require 'scout_apm/utils/sql_sanitizer'
 require 'scout_apm/utils/time'
 require 'scout_apm/utils/unique_id'
-require 'scout_apm/utils/numbers'
-require 'scout_apm/utils/gzip_helper'
-require 'scout_apm/utils/marshal_logging'
 
 require 'scout_apm/config'
 require 'scout_apm/environment'
 require 'scout_apm/agent'
-require 'scout_apm/logger'
-require 'scout_apm/reporting'
+require 'scout_apm/agent/logging'
+require 'scout_apm/agent/reporting'
 require 'scout_apm/layaway'
 require 'scout_apm/layaway_file'
 require 'scout_apm/reporter'
@@ -127,75 +117,39 @@ require 'scout_apm/background_worker'
 require 'scout_apm/bucket_name_splitter'
 require 'scout_apm/stack_item'
 require 'scout_apm/metric_set'
-require 'scout_apm/db_query_metric_set'
 require 'scout_apm/store'
 require 'scout_apm/fake_store'
 require 'scout_apm/tracer'
-require 'scout_apm/transaction'
 require 'scout_apm/context'
 require 'scout_apm/instant_reporting'
-require 'scout_apm/background_recorder'
-require 'scout_apm/synchronous_recorder'
+require 'scout_apm/trace_compactor'
 
 require 'scout_apm/metric_meta'
 require 'scout_apm/metric_stats'
-require 'scout_apm/db_query_metric_stats'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/slow_job_record'
-require 'scout_apm/detailed_trace'
 require 'scout_apm/scored_item_set'
 require 'scout_apm/slow_request_policy'
 require 'scout_apm/slow_job_policy'
 require 'scout_apm/job_record'
 require 'scout_apm/request_histograms'
-require 'scout_apm/transaction_time_consumed'
 
+require 'scout_apm/capacity'
 require 'scout_apm/attribute_arranger'
-require 'scout_apm/git_revision'
 
 require 'scout_apm/serializers/payload_serializer'
 require 'scout_apm/serializers/payload_serializer_to_json'
 require 'scout_apm/serializers/jobs_serializer_to_json'
 require 'scout_apm/serializers/slow_jobs_serializer_to_json'
 require 'scout_apm/serializers/metrics_to_json_serializer'
-require 'scout_apm/serializers/histograms_serializer_to_json'
-require 'scout_apm/serializers/db_query_serializer_to_json'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
+require 'scout_apm/serializers/deploy_serializer'
 
 require 'scout_apm/middleware'
 
 require 'scout_apm/instant/middleware'
 
-require 'scout_apm/rack'
-
-require 'scout_apm/remote/server'
-require 'scout_apm/remote/router'
-require 'scout_apm/remote/message'
-require 'scout_apm/remote/recorder'
-require 'scout_apm/instruments/resque'
-
-require 'scout_apm/agent_context'
-require 'scout_apm/instrument_manager'
-require 'scout_apm/periodic_work'
-require 'scout_apm/agent/preconditions'
-require 'scout_apm/agent/exit_handler'
-require 'scout_apm/tasks/doctor'
-require 'scout_apm/tasks/support'
-
-require 'scout_apm/extensions/config'
-require 'scout_apm/extensions/transaction_callback_payload'
-
-require 'scout_apm/error_service'
-require 'scout_apm/error_service/middleware'
-require 'scout_apm/error_service/notifier'
-require 'scout_apm/error_service/sidekiq'
-require 'scout_apm/error_service/ignored_exceptions'
-require 'scout_apm/error_service/error_buffer'
-require 'scout_apm/error_service/error_record'
-require 'scout_apm/error_service/periodic_work'
-require 'scout_apm/error_service/payload'
-
 if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3 && defined?(Rails::Railtie)
   module ScoutApm
     class Railtie < Rails::Railtie
@@ -206,32 +160,19 @@ if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR
         app.middleware.use ScoutApm::Middleware
 
         # Attempt to start right away, this will work best for preloading apps, Unicorn & Puma & similar
-        ScoutApm::Agent.instance.install
-
-        if ScoutApm::Agent.instance.context.config.value("auto_instruments")
-          ScoutApm::Agent.instance.context.logger.debug("AutoInstruments is enabled.")
-          require 'scout_apm/auto_instrument'
-        else
-          ScoutApm::Agent.instance.context.logger.debug("AutoInstruments is disabled.")
-        end
-
-        if ScoutApm::Agent.instance.context.config.value("errors_enabled")
-          app.config.middleware.insert_after ActionDispatch::DebugExceptions, ScoutApm::ErrorService::Middleware
-          ScoutApm::ErrorService::Sidekiq.new.install
-        end
-
+        ScoutApm::Agent.instance.start
+      end
+    end
+    class Railtie < Rails::Railtie
+      initializer 'scout_apm.start' do |app|
         # Install the middleware every time in development mode.
         # The middleware is a noop if dev_trace is not enabled in config
         if Rails.env.development?
           app.middleware.use ScoutApm::Instant::Middleware
         end
       end
-
-      rake_tasks do
-        load "tasks/doctor.rake"
-      end
     end
   end
 else
-  ScoutApm::Agent.instance.install
+  ScoutApm::Agent.instance.start
 end

data/scout_apm.gemspec

@@ -19,27 +19,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib","data"]
   s.extensions << 'ext/allocations/extconf.rb'
+  s.extensions << 'ext/stacks/extconf.rb'
   s.extensions << 'ext/rusage/extconf.rb'
 
   s.add_development_dependency "minitest"
-  s.add_development_dependency "mocha"
+  s.add_development_dependency 'mocha'
   s.add_development_dependency "pry"
+  s.add_development_dependency "m"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "rake-compiler"
-  s.add_development_dependency "addressable"
-  s.add_development_dependency "activesupport"
-  s.add_runtime_dependency "parser"
-
-  # These are general development dependencies which are used in instrumentation
-  # tests. Specific versions are pulled in using specific gemfiles, e.g. 
-  # `gems/rails3.gemfile`.
-  s.add_development_dependency "activerecord"
-  s.add_development_dependency "sqlite3"
-
-  if RUBY_VERSION >= "1.9.3"
-    s.add_development_dependency "rubocop"
-    s.add_development_dependency "guard"
-    s.add_development_dependency "guard-minitest"
-    s.add_development_dependency "m"
-  end
 end

data/test/test_helper.rb

@@ -5,12 +5,10 @@ SimpleCov.start
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest/pride'
-require 'mocha/minitest'
+require 'mocha/mini_test'
 require 'pry'
 
 
-require 'active_support/core_ext/string/inflections'
-
 require 'scout_apm'
 
 Kernel.module_eval do
@@ -18,14 +16,6 @@ Kernel.module_eval do
   def self.const_unset(const)
     self.instance_eval { remove_const(const) }
   end
-
-  def silence_warnings(&block)
-    warn_level = $VERBOSE
-    $VERBOSE = nil
-    result = block.call
-    $VERBOSE = warn_level
-    result
-  end
 end
 
 # A test helper class to create a temporary "configuration" we can control entirely purposes
@@ -41,14 +31,6 @@ 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
@@ -68,14 +50,13 @@ end
 # Helpers available to all tests
 class Minitest::Test
   def setup
-    Thread.current[:scout_request] = nil
     reopen_logger
     FileUtils.mkdir_p(DATA_FILE_DIR)
     ENV['SCOUT_DATA_FILE'] = DATA_FILE_PATH
   end
 
   def teardown
-    ScoutApm::Agent.instance.stop_background_worker
+    ScoutApm::Agent.instance.shutdown
     File.delete(DATA_FILE_PATH) if File.exist?(DATA_FILE_PATH)
   end
 
@@ -94,46 +75,11 @@ class Minitest::Test
     FakeEnvironment.new(values)
   end
 
-  # XXX: Make it easy to override context here?
   def make_fake_config(values)
-    ScoutApm::Config.new(agent_context, [FakeConfigOverlay.new(values), ScoutApm::Config::ConfigNull.new] )
-  end
-
-  def agent_context
-    ScoutApm::Agent.instance.context
+    ScoutApm::Config.new(FakeConfigOverlay.new(values))
   end
 
   DATA_FILE_DIR = File.dirname(__FILE__) + '/tmp'
   DATA_FILE_PATH = "#{DATA_FILE_DIR}/scout_apm.db"
 end
 
-class FakeRecorder
-  attr_reader :requests
-
-  def initialize
-    @requests = []
-  end
-
-  def start
-    # nothing to do
-    self
-  end
-
-  def stop
-    # nothing to do
-  end
-
-  def record!(request)
-    @requests << request
-  end
-end
-
-module CustomAsserts
-  def assert_false(thing)
-    assert !thing
-  end
-end
-
-class Minitest::Test
-  include CustomAsserts
-end