scout_apm 3.0.0.pre21 → 3.0.0.pre22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb5a7880c0007cdc98449e7598022481be64b83f
-  data.tar.gz: b195f2ea2a704b97be089d38af6cb84145d96856
+  metadata.gz: f13b4a3f3c661a398f9a56edb12b5eb4d3c4bdd9
+  data.tar.gz: 0804ece9bc0b33ab297e2d6f36bdcd1059b98853
 SHA512:
-  metadata.gz: 3d181d12bf746066430840488485e2e96370a33ebfc6db4b7e6c25d9cb07763d380867bf6aabf3595044451ba1a657a6d03b1d739b567e430da431f2de854a59
-  data.tar.gz: f4149e4757f16f481ca9e9d4a3ababc1ec9ba3cb66718bffe2de207ae12b01f56fa81d0f14cf0d1b3348d7c8cf97d28809a6ec75ad6bdbb1a3af573a2de684bd
+  metadata.gz: a4a861ec81684ff469f17d806c781368411671e098e3ca97c383e55492160c56a9fb7a56a653248f4985fa7ddde4abfed7bdaeed96cebe092655c302761ae466
+  data.tar.gz: 6c3d47bb26bf70e6a1523f9d25ae948278f7ae2e89380a9d404f5b3a11f5e6fbdff518215b707703250802fc0c03e517816553d2ff121258a8ccb5a543c71bde

data/.travis.yml

@@ -7,6 +7,9 @@ rvm:
   - "2.4"
   - "2.5"
 cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler
 jobs:
   include:
     - script: bundle exec rake test

data/CHANGELOG.markdown

@@ -2,6 +2,11 @@
 
 * ScoutProf BETA
 
+# 2.4.10
+
+* Improve ActiveRecord instrumentation across Rails 3.2+, and adding support
+  for the newly released Rails 5.2
+
 # 2.4.9
 
 * ScoutApm::Transaction#rename and #ignore API

data/README.markdown

@@ -2,10 +2,19 @@
 
 [![Build Status](https://travis-ci.org/scoutapp/scout_apm_ruby.svg?branch=master)](https://travis-ci.org/scoutapp/scout_apm_ruby)
 
-A Ruby gem for detailed Rails application performance analysis. Metrics are
+A Ruby gem for detailed Rails application performance monitoring 📈. Metrics and transaction traces are
 reported to [Scout](https://scoutapp.com), a hosted application monitoring
 service.
 
+## What's the special sauce? 🤔
+
+The Scout agent is engineered to do some wonderful things:
+
+* A unique focus on identifying those hard-to-investigate outliers like memory bloat, N+1s, and user-specific problems. [See an example workflow](http://scoutapp.com/newrelic-alternative).
+* [Low-overhead](http://blog.scoutapp.com/articles/2016/02/07/overhead-benchmarks-new-relic-vs-scout)
+* View your performance metrics during development with [DevTrace](http://help.apm.scoutapp.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
+* Production-Safe profiling of custom code via [ScoutProf](http://help.apm.scoutapp.com/#scoutprof) (BETA).
+
 ## Getting Started
 
 Add the gem to your Gemfile

data/lib/scout_apm/instruments/active_record.rb

@@ -112,10 +112,22 @@ module ScoutApm
           end
         end
 
-        if Utils::KlassHelper.defined?("ActiveRecord::FinderMethods")
-          ::ActiveRecord::FinderMethods.module_eval do
-            include ::ScoutApm::Tracer
-            include ::ScoutApm::Instruments::ActiveRecordFinderMethodsInstruments
+        rails_3_2_or_above = defined?(::ActiveRecord::VERSION::MAJOR) &&
+          defined?(::ActiveRecord::VERSION::MINOR) &&
+          (::ActiveRecord::VERSION::MAJOR.to_i > 3 ||
+           (::ActiveRecord::VERSION::MAJOR.to_i == 3 && ::ActiveRecord::VERSION::MINOR.to_i >= 2))
+        if rails_3_2_or_above
+          if Utils::KlassHelper.defined?("ActiveRecord::Relation")
+            ::ActiveRecord::Relation.module_eval do
+              include ::ScoutApm::Instruments::ActiveRecordRelationQueryInstruments
+            end
+          end
+        else
+          if Utils::KlassHelper.defined?("ActiveRecord::FinderMethods")
+            ::ActiveRecord::FinderMethods.module_eval do
+              include ::ScoutApm::Tracer
+              include ::ScoutApm::Instruments::ActiveRecordFinderMethodsInstruments
+            end
           end
         end
 
@@ -207,12 +219,21 @@ module ScoutApm
     ################################################################################
     # Entry-point of instruments.
     #
-    # We instrument both ActiveRecord::Querying#find_by_sql and
-    # ActiveRecord::FinderMethods#find_with_associations.  These are early in
-    # the chain of calls when you're using ActiveRecord.
+    # Instrumentation starts in ActiveRecord::Relation#exec_queries (Rails >=
+    # 3.2.0) or ActiveRecord::FinderMethods#find_with_assocations (previous
+    # Rails versions).
+    #
+    # ActiveRecord::Querying#find_by_sql is instrumented in all Rails versions
+    # even though it is also invoked by #exec_queries/#find_by_associations
+    # because it can be invoked directly from user code (e.g.,
+    # Post.find_by_sql("SELECT * FROM posts")). The layer started by
+    # #exec_queries/#find_by_assocations is marked to ignore children, so it
+    # will not cause duplicate layers in the former case.
     #
-    # Later on, they will call into #log, which we also instrument, at which
-    # point, we can fill in additional data gathered at that point (name, sql)
+    # These methods are early in the chain of calls invoked when executing an
+    # ActiveRecord query, before the cache is consulted. If the query is later
+    # determined to be a cache miss, `#log` will be invoked, which we also
+    # instrument, and more details will be filled in (name, sql).
     #
     # Caveats:
     #   * We don't have a name for the query yet.
@@ -276,6 +297,33 @@ module ScoutApm
       end
     end
 
+    module ActiveRecordRelationQueryInstruments
+      def self.included(instrumented_class)
+        ScoutApm::Agent.instance.context.logger.info "Instrumenting ActiveRecord::Relation#exec_queries - #{instrumented_class.inspect}"
+        instrumented_class.class_eval do
+          unless instrumented_class.method_defined?(:exec_queries_without_scout_instruments)
+            alias_method :exec_queries_without_scout_instruments, :exec_queries
+            alias_method :exec_queries, :exec_queries_with_scout_instruments
+          end
+        end
+      end
+
+      def exec_queries_with_scout_instruments(*args, &block)
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName::DEFAULT_METRIC)
+        layer.annotate_layer(:ignorable => true)
+        layer.desc = SqlList.new
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          exec_queries_without_scout_instruments(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+    end
+
     module ActiveRecordUpdateInstruments
       def save(*args, &block)
         model = self.class.name

data/lib/scout_apm/layaway.rb

@@ -188,7 +188,7 @@ module ScoutApm
     end
 
     def timestamp_from_filename(filename)
-      match = filename.match(%r{scout_(.*)_.*\.data})
+      match = filename.match(%r{scout_(\d+)_\d+\.data\z})
       if match
         match[1]
       else

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "3.0.0.pre21"
+  VERSION = "3.0.0.pre22"
 end

data/test/unit/layaway_test.rb

@@ -46,4 +46,39 @@ class LayawayTest < Minitest::Test
 
     layaway.delete_files_for(:all)
   end
+
+  def test_layaway_stale_regex_pattern
+    data_dir = '/tmp/scout_apm_test/shared/scout_apm'
+    FileUtils.mkdir_p data_dir
+    # Clean out files
+    FileUtils.safe_unlink(Dir.glob("#{data_dir}/scout_*_*.data"))
+
+    config = make_fake_config({'data_file' => data_dir})
+    env = make_fake_environment(:root => '/tmp/scout_apm_test')
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config; c.environment = env }
+    layaway = ScoutApm::Layaway.new(context)
+
+
+    not_stale_time = Time.now
+    not_stale_time_formatted = not_stale_time.strftime(ScoutApm::Layaway::TIME_FORMAT)
+
+    stale_time = not_stale_time - (ScoutApm::Layaway::STALE_AGE + 120) # ScoutApm::Layaway::STALE_AGE is in seconds. Add another 2 minutes to STALE_AGE
+    stale_time_formatted = stale_time.strftime(ScoutApm::Layaway::TIME_FORMAT)
+
+    not_stale_file_names = [File.join(data_dir, "scout_#{not_stale_time_formatted}_1.data"),
+                            File.join(data_dir, "scout_#{not_stale_time_formatted}_20.data")]
+    stale_file_names = [File.join(data_dir, "scout_#{stale_time_formatted}_1.data"),
+                        File.join(data_dir, "scout_#{stale_time_formatted}_20.data")]
+    all_file_names = not_stale_file_names + stale_file_names
+
+    (all_file_names).each do |filename|
+      File.new(filename, 'w').close
+    end
+
+    assert_equal Pathname.new("/tmp/scout_apm_test/shared/scout_apm"), ScoutApm::Layaway.new(context).directory
+    assert_equal all_file_names.sort, Dir.glob("#{data_dir}/*data").sort
+
+    layaway.delete_stale_files(not_stale_time - ScoutApm::Layaway::STALE_AGE)
+    assert_equal not_stale_file_names.sort, Dir.glob("#{data_dir}/*data").sort
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre21
+  version: 3.0.0.pre22
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest