scout_apm 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89a778c6a185b81e358249aef0f9420bec2d9cbc
-  data.tar.gz: d4f063fd0c52537c5780fab065052e3b1c989848
+SHA256:
+  metadata.gz: c8715d4d303e068a7730e2ec2f788ee44c2bbd6762a3a3bd30cdcc9f167435b9
+  data.tar.gz: 58e17c6491c144b596a61501b01406b15da245b6ce517a7fdbcaddfa896b0929
 SHA512:
-  metadata.gz: 2d46fa2cb57eb83c07c6a4b0552f9565834423b3af09402753524af2af81ff963d60a6b2fee6b19b8c786976baa61d67efc448477421f04f4fa0a84c5d97b3f2
-  data.tar.gz: 6db9909c632798dd5be1976577d74fc099a7587359a4af2736ae0c020240b4640cf8c6bbf2a165c299b7fe22c41d3fc5d2b73866d8c30a71809ced3a33019b78
+  metadata.gz: da8ddf5b4bb2a6d2223b49c1071dad0dd966234f2ed7b2e05747c67a0e3a9368b3831ef0496f5e6b57bd785ef486d12aade25db6815c2bf9a78ce1fce5f2acdf
+  data.tar.gz: 9fc04fcf1fa8350b1c95b00c936612a6dfc575905f22821d86e4fa01474c3cd9eab1343857ece2d7cd7e631b625c4e7e4f2e24dc895068f59f08c7fbe0e777c2

data/.gitignore

@@ -18,3 +18,4 @@ coverage/*
 lib/*.bundle
 lib/*.so
 log/scout_apm.log
+gems/*.lock

data/.travis.yml

@@ -1,25 +1,25 @@
 language: ruby
-
-rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "2.0"
-  - "2.2"
-  - "2.4"
-  - "2.5"
-
 cache: bundler
 
-before_install:
-  # Don't gem update, since it tries to install RubyGems requiring 2.3+.
-  # - gem update --system
-
-  # Lock down the version. Newer versions only support Ruby 2.3+, but we need
-  # to test back further.
-  - gem install bundler -v '1.17.3'
-
-jobs:
+matrix:
   include:
-    - script: bundle exec rake test
-    - script: bundle exec rubocop
-      rvm: "2.5"
+    - rvm: "1.8.7"
+      gemfile: gems/rails3.gemfile
+    - rvm: "1.9.3"
+      gemfile: gems/rails3.gemfile
+    - rvm: 2.0
+      gemfile: gems/rails3.gemfile
+    - rvm: 2.1
+      gemfile: gems/rails3.gemfile
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      gemfile: gems/octoshark.gemfile
+    - rvm: 2.6
+      name: rubocop yo
+      script: bundle exec rubocop
+    - rvm: 2.6
+      gemfile: gems/rails3.gemfile

data/CHANGELOG.markdown

@@ -1,6 +1,12 @@
+# 2.5.2
+
+* Don't process limited layers in detailed traces (#268)
+* Fix OctoShark (and other gems which patch ActiveRecord) interaction (#217)
+* Legacy [Rails 2.3 fix for as_json](https://github.com/scoutapp/scout_apm_ruby/pull/276)
+
 # 2.5.1
 
-* Decrease timeline trace span limit to 1,500 as an attempted workaround for [this bug](https://github.com/scoutapp/scout_apm_ruby/issues/267).
+* Decrease timeline trace span limit to 1,500 to address [this bug](https://github.com/scoutapp/scout_apm_ruby/issues/267).
 
 # 2.5.0
 

data/gems/README.md

@@ -0,0 +1,28 @@
+# 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

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

data/gems/rails3.gemfile

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

data/gems/rails4.gemfile

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

data/gems/rails5.gemfile

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

data/gems/rails6.gemfile

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

data/lib/scout_apm/detailed_trace.rb

@@ -98,7 +98,7 @@ class DetailedTrace
         }
       },
       :tags => tags.as_json,
-      :spans => spans.as_json,
+      :spans => spans.map{|span| span.as_json},
     }
   end
 

data/lib/scout_apm/instruments/active_record.rb

@@ -82,9 +82,14 @@ module ScoutApm
 
         # Install #log tracing
         if Utils::KlassHelper.defined?("ActiveRecord::ConnectionAdapters::AbstractAdapter")
-          ::ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
-            include ::ScoutApm::Instruments::ActiveRecordInstruments
-            include ::ScoutApm::Tracer
+          if Module.respond_to?(:prepend)
+            ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(ActiveRecordInstruments)
+            ::ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Tracer)
+          else
+            ::ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
+              include ::ScoutApm::Instruments::ActiveRecordAliasMethodInstruments
+              include ::ScoutApm::Tracer
+            end
           end
         end
 
@@ -167,7 +172,9 @@ module ScoutApm
     # to the real SQL, and an AR generated "name" for the Query
     #
     ################################################################################
-    module ActiveRecordInstruments
+    #
+    # Note, if you change this instrumentation, you also need to change ActiveRecordInstruments.
+    module ActiveRecordAliasMethodInstruments
       def self.included(instrumented_class)
         ScoutApm::Agent.instance.context.logger.info "Instrumenting #{instrumented_class.inspect}"
         instrumented_class.class_eval do
@@ -225,6 +232,58 @@ module ScoutApm
       end
     end
 
+    module ActiveRecordInstruments
+      def self.prepended(instrumented_class)
+        ScoutApm::Agent.instance.context.logger.info "Instrumenting #{instrumented_class.inspect}"
+      end
+
+      def log(*args, &block)
+        # Extract data from the arguments
+        sql, name = args
+        metric_name = Utils::ActiveRecordMetricName.new(sql, name)
+        desc = SqlList.new(sql)
+
+        # Get current ScoutApm context
+        req = ScoutApm::RequestManager.lookup
+        current_layer = req.current_layer
+
+        # If we call #log, we have a real query to run, and we've already
+        # gotten through the cache gatekeeper. Since we want to only trace real
+        # queries, and not repeated identical queries that just hit cache, we
+        # mark layer as ignorable initially in #find_by_sql, then only when we
+        # know it's a real database call do we mark it back as usable.
+        #
+        # This flag is later used in SlowRequestConverter to skip adding ignorable layers
+        current_layer.annotate_layer(:ignorable => false) if current_layer
+
+        # Either: update the current layer and yield, don't start a new one.
+        if current_layer && current_layer.type == "ActiveRecord"
+          # TODO: Get rid of call .to_s, need to find this without forcing a previous run of the name logic
+          if current_layer.name.to_s == Utils::ActiveRecordMetricName::DEFAULT_METRIC
+            current_layer.name = metric_name
+          end
+
+          if current_layer.desc.nil?
+            current_layer.desc = SqlList.new
+          end
+          current_layer.desc.merge(desc)
+
+          super(*args, &block)
+
+        # OR: Start a new layer, we didn't pick up instrumentation earlier in the stack.
+        else
+          layer = ScoutApm::Layer.new("ActiveRecord", metric_name)
+          layer.desc = desc
+          req.start_layer(layer)
+          begin
+            super(*args, &block)
+          ensure
+            req.stop_layer
+          end
+        end
+      end
+    end
+
     ################################################################################
     # Entry-point of instruments.
     #

data/lib/scout_apm/layer_converters/trace_converter.rb

@@ -117,7 +117,9 @@ module ScoutApm
           tags)
 
         layer.children.each do |child|
-          unless over_span_limit?(result)
+          # Don't create spans from limited layers. These don't have start/stop times and our processing can't
+          # handle these yet.
+          unless over_span_limit?(result) || child.is_a?(LimitedLayer)
             result += create_spans(child, span_id)
           end
         end
@@ -152,10 +154,8 @@ module ScoutApm
       # Limit Handling
       ################################################################################
 
-      # To prevent huge traces from being generated, we should stop collecting
+      # To prevent huge traces from being generated, we stop collecting
       # spans as we go beyond some reasonably large count.
-      # Until the root cause of https://github.com/scoutapp/scout_apm_ruby/issues/267 is addressed,
-      # keep `MAX_SPANS` less than `DEFAULT_UNIQUE_CUTOFF`.
       MAX_SPANS = 1500
 
       def over_span_limit?(spans)

data/lib/scout_apm/tracked_request.rb

@@ -212,8 +212,8 @@ module ScoutApm
     def stop_request
       @stopping = true
 
-      if recorder
-        recorder.record!(self)
+      if @recorder
+        @recorder.record!(self)
       end
     end
 

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "2.5.1"
+  VERSION = "2.5.2"
 end

data/scout_apm.gemspec

@@ -29,6 +29,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency "addressable"
   s.add_development_dependency "activesupport"
 
+  # 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"

data/test/test_helper.rb

@@ -100,7 +100,7 @@ class Minitest::Test
   end
 
   def agent_context
-    ScoutApm::AgentContext.new
+    ScoutApm::Agent.instance.context
   end
 
   DATA_FILE_DIR = File.dirname(__FILE__) + '/tmp'

data/test/unit/instruments/active_record_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'sqlite3'
+require 'active_record'
+
+begin
+  require 'octoshark'
+rescue LoadError
+  # Ignore
+end
+
+class ActiveRecordTest < Minitest::Test
+  def database_path
+    File.expand_path('test.sqlite3', DATA_FILE_DIR)
+  end
+
+  def setup
+    database = SQLite3::Database.new(database_path)
+    database.execute("DROP TABLE IF EXISTS users;")
+    database.execute("CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR(100));")
+
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => database_path)
+  end
+
+  class User < ActiveRecord::Base
+  end
+
+  def test_instrumentation
+    recorder = FakeRecorder.new
+    agent_context.recorder = recorder
+
+    instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
+    instrument.install
+
+    ScoutApm::Tracer.instrument("Controller", "foo/bar") do
+      user = User.create
+    end
+
+    assert 1, recorder.requests.size
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -109,6 +109,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +217,12 @@ files:
 - ext/rusage/README.md
 - ext/rusage/extconf.rb
 - ext/rusage/rusage.c
+- gems/README.md
+- gems/octoshark.gemfile
+- gems/rails3.gemfile
+- gems/rails4.gemfile
+- gems/rails5.gemfile
+- gems/rails6.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
 - lib/scout_apm/agent/exit_handler.rb
@@ -332,6 +366,7 @@ files:
 - scout_apm.gemspec
 - test/data/config_test_1.yml
 - test/test_helper.rb
+- test/tmp/README.md
 - test/unit/agent_test.rb
 - test/unit/background_job_integrations/sidekiq_test.rb
 - test/unit/config_test.rb
@@ -345,7 +380,7 @@ files:
 - test/unit/git_revision_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
-- test/unit/instruments/active_record_instruments_test.rb
+- test/unit/instruments/active_record_test.rb
 - test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
 - test/unit/layaway_test.rb
@@ -394,51 +429,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files:
-- test/data/config_test_1.yml
-- test/test_helper.rb
-- test/unit/agent_test.rb
-- test/unit/background_job_integrations/sidekiq_test.rb
-- test/unit/config_test.rb
-- test/unit/context_test.rb
-- test/unit/db_query_metric_set_test.rb
-- test/unit/db_query_metric_stats_test.rb
-- test/unit/environment_test.rb
-- test/unit/extensions/periodic_callbacks_test.rb
-- test/unit/extensions/transaction_callbacks_test.rb
-- test/unit/fake_store_test.rb
-- test/unit/git_revision_test.rb
-- test/unit/histogram_test.rb
-- test/unit/ignored_uris_test.rb
-- test/unit/instruments/active_record_instruments_test.rb
-- test/unit/instruments/net_http_test.rb
-- test/unit/instruments/percentile_sampler_test.rb
-- test/unit/layaway_test.rb
-- test/unit/layer_children_set_test.rb
-- test/unit/layer_converters/depth_first_walker_test.rb
-- test/unit/layer_converters/metric_converter_test.rb
-- test/unit/layer_converters/stubs.rb
-- test/unit/limited_layer_test.rb
-- test/unit/logger_test.rb
-- test/unit/metric_set_test.rb
-- test/unit/remote/test_message.rb
-- test/unit/remote/test_router.rb
-- test/unit/remote/test_server.rb
-- test/unit/scored_item_set_test.rb
-- test/unit/serializers/payload_serializer_test.rb
-- test/unit/slow_job_policy_test.rb
-- test/unit/slow_request_policy_test.rb
-- test/unit/sql_sanitizer_test.rb
-- test/unit/store_test.rb
-- test/unit/tracer_test.rb
-- test/unit/tracked_request_test.rb
-- test/unit/transaction_test.rb
-- test/unit/transaction_time_consumed_test.rb
-- test/unit/utils/active_record_metric_name_test.rb
-- test/unit/utils/backtrace_parser_test.rb
-- test/unit/utils/numbers_test.rb
-- test/unit/utils/scm.rb
+test_files: []

data/test/unit/instruments/active_record_instruments_test.rb

@@ -1,5 +0,0 @@
-require 'test_helper'
-
-class ActiveRecordInstrumentsTest < Minitest::Test
-end
-