scout_apm 3.0.0.pre20 → 3.0.0.pre21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f047a3fde038ff766a4257bd06039aaa57bc5eda
-  data.tar.gz: 2e3aecc744bff0176bb449f0bade29a43ff2810d
+  metadata.gz: eb5a7880c0007cdc98449e7598022481be64b83f
+  data.tar.gz: b195f2ea2a704b97be089d38af6cb84145d96856
 SHA512:
-  metadata.gz: 57f0e123ba394164ea2263195a204f77787e254e8396bb5a0ca346523470f4e447e53b456005a082949e6f7f6a9154ac55b71cf701b19a7e8517f709591761fd
-  data.tar.gz: 555e23d6f39fd9c1ea919ab15f7fa28b868fef854c7f0dec610db7bc9ea20438de8d30a1c6c932e7d389cd5bd40f2a3b58af53b29e9fe44e965c8ff8b7ca2d8a
+  metadata.gz: 3d181d12bf746066430840488485e2e96370a33ebfc6db4b7e6c25d9cb07763d380867bf6aabf3595044451ba1a657a6d03b1d739b567e430da431f2de854a59
+  data.tar.gz: f4149e4757f16f481ca9e9d4a3ababc1ec9ba3cb66718bffe2de207ae12b01f56fa81d0f14cf0d1b3348d7c8cf97d28809a6ec75ad6bdbb1a3af573a2de684bd

data/.rubocop.yml

@@ -1,8 +1,13 @@
+# Disable all cops by default
+AllCops:
+  DisabledByDefault: true
+
 # 80 is stifling, especially with a few levels of nesting before we even start.
 # So bump it to 100 to keep really long lines from creeping in.
 Metrics/LineLength:
+  Enabled: false
   Max: 100
 
-Style/UseHashRocketsWithSymbolValues: false
-
-
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: hash_rockets

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0"
+  - "2.2"
+  - "2.4"
+  - "2.5"
+cache: bundler
+jobs:
+  include:
+    - script: bundle exec rake test
+    - script: bundle exec rubocop
+      rvm: "2.5"

data/CHANGELOG.markdown

@@ -2,6 +2,18 @@
 
 * ScoutProf BETA
 
+# 2.4.9
+
+* ScoutApm::Transaction#rename and #ignore API
+* Explicit custom instrumentation with ScoutApm::Tracer#instrument blocks,
+  without needing to include a module
+* Quieter logging in normal startup cases
+* Upgraded testing infrastructure
+
+# 2.4.8
+
+* Fix issue with detailed middleware instrumentation
+
 # 2.4.7
 
 * Fix issue recording backtraces

data/Gemfile

@@ -2,3 +2,11 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in scout_apm.gemspec
 gemspec
+
+# Pin development dependencies more conservatively for Ruby 1.8.7
+if RUBY_VERSION <= "1.8.7"
+  gem "activesupport", "~> 3.2"
+  gem "i18n", "~> 0.6.11"
+  gem "pry", "~> 0.9.12"
+  gem "rake", "~> 10.5"
+end

data/README.markdown

@@ -1,5 +1,7 @@
 # ScoutApm Ruby Agent
 
+[![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
 reported to [Scout](https://scoutapp.com), a hosted application monitoring
 service.

data/lib/scout_apm.rb

@@ -129,6 +129,7 @@ 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/trace_compactor'

data/lib/scout_apm/agent/preconditions.rb

@@ -4,20 +4,24 @@ module ScoutApm
       # 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 = {
@@ -28,16 +32,19 @@ module ScoutApm
 
             !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,
         },
       ]
 
@@ -45,13 +52,18 @@ module ScoutApm
         @check_result ||=
           begin
             failed_preconditions = PRECONDITIONS.inject(Array.new) { |errors, condition|
-              met = condition[:check].call(context)
-              errors << condition[:message].call(context.environment) unless met
+              unless condition[:check].call(context)
+                errors << {
+                  :severity => condition[:severity],
+                  :message => condition[:message].call(context.environment),
+                }
+              end
+
               errors
             }
 
             if failed_preconditions.any?
-              failed_preconditions.each {|msg| context.logger.warn(msg) }
+              failed_preconditions.each {|error| context.logger.send(error[:severity], error[:message]) }
               force? # if forced, return true anyway
             else
               # No errors, we met preconditions

data/lib/scout_apm/instruments/middleware_detailed.rb

@@ -30,7 +30,7 @@ module ScoutApm
 
           ActionDispatch::MiddlewareStack::Middleware.class_eval do
             def build(app)
-              logger.info("Building Middleware #{klass.name}")
+              ScoutApm::Agent.instance.context.logger.info("Instrumenting Middleware #{klass.name}")
               new_mw = klass.new(app, *args, &block)
               MiddlewareWrapper.new(new_mw, klass.name)
             end

data/lib/scout_apm/tracer.rb

@@ -12,31 +12,36 @@ module ScoutApm
       klass.extend ClassMethods
     end
 
+    # Type: the Layer type - "View" or similar
+    # Name: specific name - "users/_gravatar". The object must respond to "#to_s". This allows us to be more efficient - in most cases, the metric name isn't needed unless we are processing a slow transaction.
+    # A Block: The code to be instrumented
+    #
+    # Options:
+    # * :ignore_children - will not instrument any method calls beneath this call. Example use case: InfluxDB uses Net::HTTP, which is instrumented. However, we can provide more specific data if we know we're doing an influx call, so we'd rather just instrument the Influx call and ignore Net::HTTP.
+    #   when rendering the transaction tree in the UI.
+    # * :desc - Additional capture, SQL, or HTTP url or similar
+    # * :scope - set to true if you want to make this layer a subscope
+    def self.instrument(type, name, options={}) # Takes a block
+      layer = ScoutApm::Layer.new(type, name)
+      layer.desc = options[:desc] if options[:desc]
+      layer.subscopable!          if options[:scope]
+
+      req = ScoutApm::RequestManager.lookup
+      req.start_layer(layer)
+      req.ignore_children! if options[:ignore_children]
+
+      begin
+        yield
+      ensure
+        req.acknowledge_children! if options[:ignore_children]
+        req.stop_layer
+      end
+    end
+
     module ClassMethods
-      # Type: the Layer type - "View" or similar
-      # Name: specific name - "users/_gravatar". The object must respond to "#to_s". This allows us to be more efficient - in most cases, the metric name isn't needed unless we are processing a slow transaction.
-      # A Block: The code to be instrumented
-      #
-      # Options:
-      # * :ignore_children - will not instrument any method calls beneath this call. Example use case: InfluxDB uses Net::HTTP, which is instrumented. However, we can provide more specific data if we know we're doing an influx call, so we'd rather just instrument the Influx call and ignore Net::HTTP.
-      #   when rendering the transaction tree in the UI.
-      # * :desc - Additional capture, SQL, or HTTP url or similar
-      # * :scope - set to true if you want to make this layer a subscope
-      def instrument(type, name, options={}) # Takes a block
-        layer = ScoutApm::Layer.new(type, name)
-        layer.desc = options[:desc] if options[:desc]
-        layer.subscopable!          if options[:scope]
-
-        req = ScoutApm::RequestManager.lookup
-        req.start_layer(layer)
-        req.ignore_children! if options[:ignore_children]
-
-        begin
-          yield
-        ensure
-          req.acknowledge_children! if options[:ignore_children]
-          req.stop_layer
-        end
+      # See ScoutApm::Tracer.instrument
+      def instrument(type, name, options={}, &block)
+        ScoutApm::Tracer.instrument(type, name, options, &block)
       end
 
       # Wraps a method in a call to #instrument via aggressive monkey patching.
@@ -85,7 +90,6 @@ module ScoutApm
       end
 
       def _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, options={})
-        klass = (self === Module) ? "self" : "self.class"
         method_str = <<-EOF
         def #{instrumented_name}(*args, &block)
           name = begin
@@ -95,7 +99,7 @@ module ScoutApm
                    "Unknown"
                  end
 
-          #{klass}.instrument( "#{type}",
+          ::ScoutApm::Tracer.instrument( "#{type}",
                                name,
                                {:scope => #{options[:scope] || false}}
                              ) do

data/lib/scout_apm/tracked_request.rb

@@ -38,6 +38,10 @@ module ScoutApm
     # An object that responds to `record!(TrackedRequest)` to store this tracked request
     attr_reader :recorder
 
+    # If specified, an override for the name of the request. If unspecified,
+    # the name is determined from the name of the Controller or Job layer.
+    attr_accessor :name_override
+
     # When we see these layers, it means a real request is going through the
     # system. We toggle a flag to turn on some slightly more expensive
     # instrumentation (backtrace collection and the like) that would be too
@@ -294,6 +298,8 @@ module ScoutApm
       # Bail out early if the user asked us to ignore this uri
       return if @agent_context.ignored_uris.ignore?(annotations[:uri])
 
+      apply_name_override
+
       converters = [
         LayerConverters::Histograms,
         LayerConverters::MetricConverter,
@@ -491,5 +497,16 @@ module ScoutApm
       @recorder = @agent_context.recorder
       @store = @agent_context.store
     end
+
+    private
+
+    def apply_name_override
+      return unless name_override
+
+      scope_layer = layer_finder.scope
+      if scope_layer
+        scope_layer.name = name_override
+      end
+    end
   end
 end

data/lib/scout_apm/transaction.rb

@@ -0,0 +1,13 @@
+module ScoutApm
+  module Transaction
+    # Ignores the current request
+    def self.ignore!
+      ::ScoutApm::RequestManager.lookup.ignore_request!
+    end
+
+    # Renames the last Controller or Job layer
+    def self.rename(name)
+      ::ScoutApm::RequestManager.lookup.name_override = name
+    end
+  end
+end

data/lib/scout_apm/version.rb

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

data/scout_apm.gemspec

@@ -23,13 +23,17 @@ Gem::Specification.new do |s|
   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 "guard"
-  s.add_development_dependency "guard-minitest"
   s.add_development_dependency "activesupport"
+
+  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

@@ -68,6 +68,7 @@ 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
@@ -106,6 +107,26 @@ class Minitest::Test
   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)

data/test/unit/config_test.rb

@@ -33,7 +33,7 @@ class ConfigTest < Minitest::Test
 
   def test_loading_file_without_env_in_file
     conf_file = File.expand_path("../../data/config_test_1.yml", __FILE__)
-    conf = ScoutApm::Config.with_file(@context, conf_file, environment: "staging")
+    conf = ScoutApm::Config.with_file(@context, conf_file, :environment => "staging")
 
     assert_equal "info", conf.value('log_level') # the default value
     assert_nil nil, conf.value('name')         # the default value

data/test/unit/db_query_metric_set_test.rb

@@ -7,7 +7,8 @@ class DbQueryMetricSetTest < Minitest::Test
   def test_hard_limit
     config = make_fake_config(
       'database_metric_limit' => 5, # The hard limit on db metrics
-      'database_metric_report_limit' => 2,)
+      'database_metric_report_limit' => 2
+    )
     context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
     set = DbQueryMetricSet.new(context)
 
@@ -24,7 +25,8 @@ class DbQueryMetricSetTest < Minitest::Test
   def test_report_limit
     config = make_fake_config(
       'database_metric_limit' => 50, # much larger max, uninterested in hitting it.
-      'database_metric_report_limit' => 2,)
+      'database_metric_report_limit' => 2
+    )
     context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
     set = DbQueryMetricSet.new(context)
     set << fake_stat("a", 10)
@@ -41,7 +43,8 @@ class DbQueryMetricSetTest < Minitest::Test
   def test_combine
     config = make_fake_config(
       'database_metric_limit' => 5, # The hard limit on db metrics
-      'database_metric_report_limit' => 2,)
+      'database_metric_report_limit' => 2
+    )
     context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
     set1 = DbQueryMetricSet.new(context)
     set1 << fake_stat("a", 10)
@@ -51,13 +54,14 @@ class DbQueryMetricSetTest < Minitest::Test
     set2 << fake_stat("d", 20)
 
     combined = set1.combine!(set2)
-    assert_equal ["a", "b", "c", "d"], combined.metrics.map{|_k, m| m.key}
+    assert_equal ["a", "b", "c", "d"], combined.metrics.map{|_k, m| m.key}.sort
   end
 
   def fake_stat(key, call_time)
     OpenStruct.new(
-      key: key,
-      call_time: call_time)
+      :key => key,
+      :call_time => call_time
+    )
   end
 end
 end

data/test/unit/db_query_metric_stats_test.rb

@@ -8,20 +8,20 @@ class DbQueryMetricStatsTest < Minitest::Test
     stat = build("table", "op", "Controller/public/index", 1, 10, 20)
 
     assert_equal({
-      model_name: "table",
-      operation: "op",
-      call_count: 1,
-      transaction_count: 0,
-      scope: "Controller/public/index",
-      histogram: [[10.0, 1]],
-
-      max_call_time: 10.0,
-      min_call_time: 10.0,
-      call_time: 10.0,
-
-      max_rows_returned: 20,
-      min_rows_returned: 20,
-      rows_returned: 20,
+      :model_name => "table",
+      :operation => "op",
+      :call_count => 1,
+      :transaction_count => 0,
+      :scope => "Controller/public/index",
+      :histogram => [[10.0, 1]],
+
+      :max_call_time => 10.0,
+      :min_call_time => 10.0,
+      :call_time => 10.0,
+
+      :max_rows_returned => 20,
+      :min_rows_returned => 20,
+      :rows_returned => 20,
     }, stat.as_json)
   end
 
@@ -90,9 +90,9 @@ class DbQueryMetricStatsTest < Minitest::Test
   #  Helpers  #
   #############
   DEFAULTS = {
-    call_count: 1,
-    call_time: 10.0,
-    rows_returned: 20,
+    :call_count => 1,
+    :call_time => 10.0,
+    :rows_returned => 20,
   }
 
   def build(model_name="User",

data/test/unit/histogram_test.rb

@@ -35,8 +35,8 @@ class HistogramTest < Minitest::Test
       end
     }
 
-    assert_equal 1.5, hist.quantile(0).round(1)
-    assert_equal 9.5, hist.quantile(100).round(1)
+    assert_equal 1.5, round(hist.quantile(0), 1)
+    assert_equal 9.5, round(hist.quantile(100), 1)
   end
 
   def test_combine
@@ -55,8 +55,8 @@ class HistogramTest < Minitest::Test
     }
 
     combined = hist1.combine!(hist2)
-    assert_equal 1.5, combined.quantile(0).round(1)
-    assert_equal 9.5, combined.quantile(100).round(1)
+    assert_equal 1.5, round(combined.quantile(0), 1)
+    assert_equal 9.5, round(combined.quantile(100), 1)
     assert_equal 200, combined.total
   end
 
@@ -103,5 +103,12 @@ class HistogramTest < Minitest::Test
 
     assert_equal 5.5, hist.mean
   end
+
+  private
+
+  # Ruby 1.8 compatible round with precision
+  def round(number, precision)
+    ((number * 10**precision).round.to_f) / (10**precision)
+  end
 end
 

data/test/unit/ignored_uris_test.rb

@@ -1,4 +1,4 @@
-require_relative '../test_helper'
+require 'test_helper'
 
 require 'scout_apm/ignored_uris'
 

data/test/unit/instruments/net_http_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 require 'scout_apm/instruments/net_http'
 
-require 'addressable'
+require 'addressable/uri'
 
 class NetHttpTest < Minitest::Test
   def setup
@@ -11,7 +11,12 @@ class NetHttpTest < Minitest::Test
   end
 
   def test_request_scout_description_for_uri
-    req = Net::HTTP::Get.new(URI('http://example.org/here'))
+    if RUBY_VERSION <= '1.9.3'
+      req = Net::HTTP::Get.new('/here')
+    else
+      req = Net::HTTP::Get.new(URI('http://example.org/here'))
+    end
+
     assert_equal '/here', Net::HTTP.new('').request_scout_description(req)
   end
 

data/test/unit/layer_converters/depth_first_walker_test.rb

@@ -25,6 +25,10 @@ class DepthFirstWalkerTest < Minitest::Test
   # / \
   # F  G
   def test_walk_interesting_tree
+    # The test could be rewritten to support 1.8.7, but it would likely be much
+    # harder to read.
+    skip "Lack of set ordering in Ruby 1.8.7 prevents this test from running correctly" if RUBY_VERSION.start_with?("1.8.")
+
     calls = []
     a = Layer.new("A", "x")
     b = Layer.new("B", "x")

data/test/unit/layer_converters/metric_converter_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-require_relative 'stubs'
+require File.join(File.dirname(__FILE__), 'stubs')
 
 module ScoutApm
 module LayerConverters

data/test/unit/layer_converters/stubs.rb

@@ -4,7 +4,7 @@
 module ScoutApm
   module LayerConverters
     module Stubs
-      def faux_walker(subscope_stubs: true)
+      def faux_walker(subscope_stubs = true)
         @w ||= stub
 
         if subscope_stubs && !@w_set_subscope_stubs
@@ -21,7 +21,7 @@ module ScoutApm
 
       def faux_layer_finder
         @layer_finder ||= stub
-        @layer_finder.stubs(scope: stub)
+        @layer_finder.stubs(:scope => stub)
         @layer_finder
       end
 

data/test/unit/limited_layer_test.rb

@@ -47,7 +47,7 @@ class LimitedLayerTest < Minitest::Test
       :total_call_time => tct,
       :total_exclusive_time => tet,
       :total_allocations => a_tct,
-      :total_exclusive_allocations => a_tet,
+      :total_exclusive_allocations => a_tet
     )
   end
 end

data/test/unit/logger_test.rb

@@ -5,7 +5,7 @@ require 'scout_apm/logger'
 
 class LoggerTest < Minitest::Test
   def setup
-    @env_root = Pathname.new(File.dirname(__FILE__)) + "../../"
+    @env_root = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), "..", "..")))
     FileUtils.mkdir_p(@env_root + "log")
   end
 

data/test/unit/serializers/payload_serializer_test.rb

@@ -46,7 +46,7 @@ class PayloadSerializerTest < Minitest::Test
         stats.min_call_time = 0.034881757
         stats.sum_of_squares = 0.007382350213180609
         stats.total_call_time = 0.113403176
-        stats.total_exclusive_time = 0.07813208899999999
+        stats.total_exclusive_time = 0.078132088
       }
     }
     payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {}, [], [], [], {})
@@ -83,11 +83,12 @@ class PayloadSerializerTest < Minitest::Test
         "max_call_time" => 0.078521419,
         "min_call_time" => 0.034881757,
         "total_call_time" => 0.113403176,
-        "total_exclusive_time" => 0.07813208899999999,
+        "total_exclusive_time" => 0.078132088,
         "traces" => []
       }
     ]
-    assert_equal formatted_metrics, JSON.parse(payload)["metrics"]
+    assert_equal formatted_metrics,
+      JSON.parse(payload)["metrics"].sort_by { |m| m["key"]["bucket"] }
   end
 
   def test_escapes_json_quotes

data/test/unit/sql_sanitizer_test.rb

@@ -10,6 +10,8 @@ module ScoutApm
       end
 
       def test_postgres_simple_select_of_first
+        skip "Broken on Ruby 1.8.7 because regular expressions do not support look-behinds" if RUBY_VERSION.start_with?("1.8.")
+
         sql = %q|SELECT  "users".* FROM "users"  ORDER BY "users"."id" ASC LIMIT 1|
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
         assert_equal %q|SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT 1|, ss.to_s
@@ -55,6 +57,8 @@ module ScoutApm
       end
 
       def test_mysql_limit
+        skip "Broken on Ruby 1.8.7 because regular expressions do not support look-behinds" if RUBY_VERSION.start_with?("1.8.")
+
         sql = %q|SELECT  `blogs`.* FROM `blogs`  ORDER BY `blogs`.`id` ASC LIMIT 1|
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
         assert_equal %q|SELECT  `blogs`.* FROM `blogs`  ORDER BY `blogs`.`id` ASC LIMIT 1|, ss.to_s
@@ -86,6 +90,8 @@ module ScoutApm
       end
 
       def test_scrubs_invalid_encoding
+        skip "Ruby 1.8.7 has no concept of encoding" if RUBY_VERSION.start_with?("1.8.")
+
         sql = "SELECT `blogs`.* FROM `blogs` WHERE (title = 'a\255c')".force_encoding('UTF-8')
         assert_equal false, sql.valid_encoding?
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }

data/test/unit/tracer_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+class TracerTest < Minitest::Test
+  def test_instrument
+    recorder = FakeRecorder.new
+    ScoutApm::Agent.instance.context.recorder = recorder
+
+    invoked = false
+    ScoutApm::Tracer.instrument("Test", "name") do
+      invoked = true
+    end
+
+    assert invoked, "instrumented code was not invoked"
+    assert_recorded(recorder, "Test", "name")
+  end
+
+  def test_instrument_included
+    recorder = FakeRecorder.new
+    ScoutApm::Agent.instance.context.recorder = recorder
+
+    klass = Class.new { include ScoutApm::Tracer }
+
+    invoked = false
+    klass.instrument("Test", "name") do
+      invoked = true
+    end
+
+    assert invoked, "instrumented code was not invoked"
+    assert_recorded(recorder, "Test", "name")
+  end
+
+  def test_instrument_inside_method
+    recorder = FakeRecorder.new
+    ScoutApm::Agent.instance.context.recorder = recorder
+
+    klass = Class.new { include ScoutApm::Tracer }
+    klass.class_eval %q{
+    attr_reader :invoked
+    def work
+      ScoutApm::Tracer.instrument("Test", "name") do
+        @invoked = true
+      end
+    end
+    }
+    klass_instance = klass.new
+    klass_instance.work
+
+    assert klass_instance.invoked, "instrumented code was not invoked"
+    assert_recorded(recorder, "Test", "name")
+  end
+
+  def test_instrument_method
+    recorder = FakeRecorder.new
+    ScoutApm::Agent.instance.context.recorder = recorder
+
+    klass = Class.new { include ScoutApm::Tracer }
+
+    invoked = false
+    klass.send(:define_method, :work) { invoked = true }
+    klass.instrument_method(:work, :type => "Test", :name => "name")
+
+    klass.new.work
+
+    assert invoked, "instrumented code was not invoked"
+    assert_recorded(recorder, "Test", "name")
+  end
+
+  private
+
+  def assert_recorded(recorder, type, name)
+    req = recorder.requests.first
+    assert req, "recorder recorded no layers"
+    assert_equal type, req.root_layer.type
+    assert_equal name, req.root_layer.name
+  end
+end

data/test/unit/{test_tracked_request.rb → tracked_request_test.rb}

@@ -10,19 +10,6 @@ class TrackedRequestDumpAndLoadTest < Minitest::Test
     loaded = Marshal.load(dumped)
     assert_false loaded.nil?
   end
-
-  def test_restore_store
-    faux_store = ScoutApm::FakeStore.new
-    context = ScoutApm::AgentContext.new
-    tr = ScoutApm::TrackedRequest.new(context, faux_store)
-    assert_equal faux_store, tr.instance_variable_get("@store")
-
-    tr.prepare_to_dump!
-    assert_nil tr.instance_variable_get("@store")
-
-    tr.restore_store
-    assert_equal context.store, tr.instance_variable_get("@store")
-  end
 end
 
 class TrackedRequestLayerManipulationTest < Minitest::Test
@@ -48,4 +35,37 @@ class TrackedRequestLayerManipulationTest < Minitest::Test
 
     assert_equal "Controller", tr.current_layer.type
   end
+
+  def test_name_override_controller
+    # layers are Middleware -> Controller
+    middleware_layer = ScoutApm::Layer.new("Middleware", "foo")
+    controller_layer = ScoutApm::Layer.new("Controller", "users/index")
+
+    tr = ScoutApm::TrackedRequest.new(ScoutApm::AgentContext.new, ScoutApm::FakeStore.new)
+    tr.start_layer(middleware_layer)
+    tr.name_override = "override"
+    tr.start_layer(controller_layer)
+    tr.stop_layer
+    tr.stop_layer
+
+    assert_equal "override", controller_layer.name
+  end
+
+  def test_name_override_job
+    # layers are Middleware -> Queue -> Job
+    middleware_layer = ScoutApm::Layer.new("Middleware", "foo")
+    queue_layer = ScoutApm::Layer.new("Queue", "bar")
+    job_layer = ScoutApm::Layer.new("Job", "FooJob")
+
+    tr = ScoutApm::TrackedRequest.new(ScoutApm::AgentContext.new, ScoutApm::FakeStore.new)
+    tr.start_layer(middleware_layer)
+    tr.name_override = "override"
+    tr.start_layer(queue_layer)
+    tr.start_layer(job_layer)
+    tr.stop_layer
+    tr.stop_layer
+    tr.stop_layer
+
+    assert_equal "override", job_layer.name
+  end
 end

data/test/unit/transaction_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TransactionTest < Minitest::Test
+  def test_ignore
+    recorder = FakeRecorder.new
+    ScoutApm::Agent.instance.context.recorder = recorder
+
+    ScoutApm::Tracer.instrument("Controller", "foo/bar") do
+      ScoutApm::Transaction.ignore!
+    end
+
+    assert_equal 0, recorder.requests.length
+  end
+end

data/test/unit/utils/backtrace_parser_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_helper'
+require 'test_helper'
 require 'scout_apm/utils/backtrace_parser'
 
 class BacktraceParserTest < Minitest::Test

data/test/unit/utils/numbers_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_helper'
+require 'test_helper'
 require 'scout_apm/utils/numbers'
 
 class NumbersTest < Minitest::Test

data/test/unit/utils/scm.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_helper'
+require 'test_helper'
 require 'scout_apm/utils/scm'
 
 class ScmTest < Minitest::Test
@@ -14,4 +14,4 @@ class ScmTest < Minitest::Test
   def test_relative_scm_path_not_blank_with_slashes
     assert_equal 'src/app/models/person.rb', ScoutApm::Utils::Scm.relative_scm_path('app/models/person.rb', '/src/')
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre20
+  version: 3.0.0.pre21
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: m
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: activesupport
+  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
     requirements:
     - - ">="
@@ -138,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -163,6 +177,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.markdown
 - Gemfile
 - Guardfile
@@ -297,6 +312,7 @@ files:
 - lib/scout_apm/trace_compactor.rb
 - lib/scout_apm/tracer.rb
 - lib/scout_apm/tracked_request.rb
+- lib/scout_apm/transaction.rb
 - lib/scout_apm/utils/active_record_metric_name.rb
 - lib/scout_apm/utils/backtrace_parser.rb
 - lib/scout_apm/utils/fake_stacks.rb
@@ -346,7 +362,9 @@ files:
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/store_test.rb
-- test/unit/test_tracked_request.rb
+- test/unit/tracer_test.rb
+- test/unit/tracked_request_test.rb
+- test/unit/transaction_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb
@@ -411,7 +429,9 @@ test_files:
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/store_test.rb
-- test/unit/test_tracked_request.rb
+- test/unit/tracer_test.rb
+- test/unit/tracked_request_test.rb
+- test/unit/transaction_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb