scout_apm 3.0.0.pre28 → 4.0.4

data/lib/scout_apm/utils/sql_sanitizer_regex.rb

@@ -5,11 +5,13 @@ module ScoutApm
       MULTIPLE_SPACES    = %r|\s+|.freeze
       MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
 
-      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*\z|.freeze
       PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
       PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
       PSQL_PLACEHOLDER = /\$\d+/.freeze
       PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
+      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|\z)/im.freeze
+      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|\z)/im.freeze
 
       MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
@@ -20,6 +22,11 @@ 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,6 +10,8 @@ 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
@@ -21,6 +23,10 @@ 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,5 +11,32 @@ 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,3 @@
 module ScoutApm
-  VERSION = "3.0.0.pre28"
+  VERSION = "4.0.4"
 end

data/scout_apm.gemspec

@@ -19,9 +19,10 @@ 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.required_ruby_version = '>= 2.1'
+
   s.add_development_dependency "minitest"
   s.add_development_dependency "mocha"
   s.add_development_dependency "pry"
@@ -29,11 +30,16 @@ Gem::Specification.new do |s|
   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
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "m"
 end

data/test/test_helper.rb

@@ -5,7 +5,7 @@ SimpleCov.start
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest/pride'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'pry'
 
 
@@ -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/agent_context_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+require "scout_apm/agent_context"
+
+class AgentContextTest < Minitest::Test
+  def test_has_error_service_ignored_exceptions
+    context = ScoutApm::AgentContext.new
+    assert ScoutApm::ErrorService::IgnoredExceptions, context.ignored_exceptions.class
+  end
+
+  def test_has_error_buffer
+    context = ScoutApm::AgentContext.new
+    assert ScoutApm::ErrorService::ErrorBuffer, context.error_buffer.class
+  end
+
+
+  class TestPolicy
+    def call(req); 1; end
+    def stored!(req); end
+  end
+
+  def test_customize_slow_request_policy
+    context = ScoutApm::AgentContext.new
+    assert 4, context.slow_request_policy.policies
+
+    context.slow_request_policy.add(TestPolicy.new)
+    assert 5, context.slow_request_policy.policies
+  end
+end

data/test/unit/auto_instrument/assignments-instrumented.rb

@@ -0,0 +1,31 @@
+
+class Assignments
+  def test_op_asgn
+    foo.bar += ::ScoutApm::AutoInstrument("User.size",["ROOT/test/unit/auto_instrument/assignments.rb:4:in `test_op_asgn'"]){User.size}
+    foo.bar -= ::ScoutApm::AutoInstrument("User.size",["ROOT/test/unit/auto_instrument/assignments.rb:5:in `test_op_asgn'"]){User.size}
+  end
+
+  def nested_assignment
+    @email ||= if (email = ::ScoutApm::AutoInstrument("session[\"email\"]",["ROOT/test/unit/auto_instrument/assignments.rb:9:in `nested_assignment'"]){session["email"]}).present?
+        ::ScoutApm::AutoInstrument("User.where(email: email).first",["ROOT/test/unit/auto_instrument/assignments.rb:10:in `nested_assignment'"]){User.where(email: email).first}
+      else
+        nil
+      end
+  end
+
+  def paginate_collection(coll)
+    page = (::ScoutApm::AutoInstrument("params[:page].present?",["ROOT/test/unit/auto_instrument/assignments.rb:17:in `paginate_collection'"]){params[:page].present?} ? ::ScoutApm::AutoInstrument("params[:page].to_i",["ROOT/test/unit/auto_instrument/assignments.rb:17:in `paginate_collection'"]){params[:page].to_i} : 1)
+    per_page = (::ScoutApm::AutoInstrument("params[:per_page].present?",["ROOT/test/unit/auto_instrument/assignments.rb:18:in `paginate_collection'"]){params[:per_page].present?} ? ::ScoutApm::AutoInstrument("params[:per_page].to_i",["ROOT/test/unit/auto_instrument/assignments.rb:18:in `paginate_collection'"]){params[:per_page].to_i} : 20)
+    pagination, self.collection = ::ScoutApm::AutoInstrument("pagy(...",["ROOT/test/unit/auto_instrument/assignments.rb:19:in `paginate_collection'"]){pagy(
+      coll,
+      items: per_page,
+      page: page
+    )}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:24:in `paginate_collection'"]){headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:25:in `paginate_collection'"]){headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:26:in `paginate_collection'"]){headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:27:in `paginate_collection'"]){headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:28:in `paginate_collection'"]){headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s}
+    ::ScoutApm::AutoInstrument("collection",["ROOT/test/unit/auto_instrument/assignments.rb:29:in `paginate_collection'"]){collection}
+  end
+end

data/test/unit/auto_instrument/assignments.rb

@@ -0,0 +1,31 @@
+
+class Assignments
+  def test_op_asgn
+    foo.bar += User.size
+    foo.bar -= User.size
+  end
+
+  def nested_assignment
+    @email ||= if (email = session["email"]).present?
+        User.where(email: email).first
+      else
+        nil
+      end
+  end
+
+  def paginate_collection(coll)
+    page = (params[:page].present? ? params[:page].to_i : 1)
+    per_page = (params[:per_page].present? ? params[:per_page].to_i : 20)
+    pagination, self.collection = pagy(
+      coll,
+      items: per_page,
+      page: page
+    )
+    headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s
+    headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s
+    headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s
+    headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s
+    headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s
+    collection
+  end
+end

data/test/unit/auto_instrument/controller-ast.txt

@@ -0,0 +1,57 @@
+s(:class,
+  s(:const, nil, :ClientsController),
+  s(:const, nil, :ApplicationController),
+  s(:begin,
+    s(:send, nil, :before_action,
+      s(:sym, :check_authorization)),
+    s(:def, :index,
+      s(:args),
+      s(:if,
+        s(:send,
+          s(:send,
+            s(:send, nil, :params), :[],
+            s(:sym, :status)), :==,
+          s(:str, "activated")),
+        s(:ivasgn, :@clients,
+          s(:send,
+            s(:const, nil, :Client), :activated)),
+        s(:ivasgn, :@clients,
+          s(:send,
+            s(:const, nil, :Client), :inactivated)))),
+    s(:def, :create,
+      s(:args),
+      s(:begin,
+        s(:ivasgn, :@client,
+          s(:send,
+            s(:const, nil, :Client), :new,
+            s(:send,
+              s(:send, nil, :params), :[],
+              s(:sym, :client)))),
+        s(:if,
+          s(:send,
+            s(:ivar, :@client), :save),
+          s(:send, nil, :redirect_to,
+            s(:ivar, :@client)),
+          s(:send, nil, :render,
+            s(:str, "new"))))),
+    s(:def, :edit,
+      s(:args),
+      s(:begin,
+        s(:ivasgn, :@client,
+          s(:send,
+            s(:const, nil, :Client), :new,
+            s(:send,
+              s(:send, nil, :params), :[],
+              s(:sym, :client)))),
+        s(:if,
+          s(:send,
+            s(:send, nil, :request), :post?),
+          s(:block,
+            s(:send,
+              s(:ivar, :@client), :transaction),
+            s(:args),
+            s(:send,
+              s(:ivar, :@client), :update_attributes,
+              s(:send,
+                s(:send, nil, :params), :[],
+                s(:sym, :client)))), nil)))))

data/test/unit/auto_instrument/controller-instrumented.rb

@@ -0,0 +1,49 @@
+
+class ClientsController < ApplicationController
+  before_action :check_authorization
+
+  def index
+    if ::ScoutApm::AutoInstrument("params[:status] == \"activated\"",["ROOT/test/unit/auto_instrument/controller.rb:6:in `index'"]){params[:status] == "activated"}
+      @clients = ::ScoutApm::AutoInstrument("Client.activated",["ROOT/test/unit/auto_instrument/controller.rb:7:in `index'"]){Client.activated}
+    else
+      @clients = ::ScoutApm::AutoInstrument("Client.inactivated",["ROOT/test/unit/auto_instrument/controller.rb:9:in `index'"]){Client.inactivated}
+    end
+  end
+
+  def create
+    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["ROOT/test/unit/auto_instrument/controller.rb:14:in `create'"]){Client.new(params[:client])}
+    if ::ScoutApm::AutoInstrument("@client.save",["ROOT/test/unit/auto_instrument/controller.rb:15:in `create'"]){@client.save}
+      ::ScoutApm::AutoInstrument("redirect_to @client",["ROOT/test/unit/auto_instrument/controller.rb:16:in `create'"]){redirect_to @client}
+    else
+      # This line overrides the default rendering behavior, which
+      # would have been to render the "create" view.
+      ::ScoutApm::AutoInstrument("render \"new\"",["ROOT/test/unit/auto_instrument/controller.rb:20:in `create'"]){render "new"}
+    end
+  end
+
+  def edit
+    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["ROOT/test/unit/auto_instrument/controller.rb:25:in `edit'"]){Client.new(params[:client])}
+
+    if ::ScoutApm::AutoInstrument("request.post?",["ROOT/test/unit/auto_instrument/controller.rb:27:in `edit'"]){request.post?}
+      ::ScoutApm::AutoInstrument("@client.transaction do...",["ROOT/test/unit/auto_instrument/controller.rb:28:in `edit'"]){@client.transaction do
+        @client.update_attributes(params[:client])
+      end}
+    end
+  end
+
+  def data
+    @clients = ::ScoutApm::AutoInstrument("Client.all",["ROOT/test/unit/auto_instrument/controller.rb:35:in `data'"]){Client.all}
+
+    formatter = ::ScoutApm::AutoInstrument("proc do |row|...",["ROOT/test/unit/auto_instrument/controller.rb:37:in `data'"]){proc do |row|
+      row.to_json
+    end}
+
+    ::ScoutApm::AutoInstrument("respond_with @clients.each(&formatter).join(\"\\n\"), :content_type => 'application/json; boundary=NL'",["ROOT/test/unit/auto_instrument/controller.rb:41:in `data'"]){respond_with @clients.each(&formatter).join("\n"), :content_type => 'application/json; boundary=NL'}
+  end
+  
+  def things
+    x = {}
+    x[:this] ||= 'foo'
+    x[:that] &&= ::ScoutApm::AutoInstrument("'foo'.size",["ROOT/test/unit/auto_instrument/controller.rb:47:in `things'"]){'foo'.size}
+  end
+end

data/test/unit/auto_instrument/controller.rb

@@ -0,0 +1,49 @@
+
+class ClientsController < ApplicationController
+  before_action :check_authorization
+
+  def index
+    if params[:status] == "activated"
+      @clients = Client.activated
+    else
+      @clients = Client.inactivated
+    end
+  end
+
+  def create
+    @client = Client.new(params[:client])
+    if @client.save
+      redirect_to @client
+    else
+      # This line overrides the default rendering behavior, which
+      # would have been to render the "create" view.
+      render "new"
+    end
+  end
+
+  def edit
+    @client = Client.new(params[:client])
+
+    if request.post?
+      @client.transaction do
+        @client.update_attributes(params[:client])
+      end
+    end
+  end
+
+  def data
+    @clients = Client.all
+
+    formatter = proc do |row|
+      row.to_json
+    end
+
+    respond_with @clients.each(&formatter).join("\n"), :content_type => 'application/json; boundary=NL'
+  end
+  
+  def things
+    x = {}
+    x[:this] ||= 'foo'
+    x[:that] &&= 'foo'.size
+  end
+end

data/test/unit/auto_instrument/rescue_from-instrumented.rb

@@ -0,0 +1,13 @@
+
+class BrokenController < ApplicationController
+  rescue_from Exception do |e|
+    if e.is_a? Pundit::NotAuthorizedError
+      unauthorized_error
+    elsif e.is_a? ActionController::ParameterMissing
+      error(status: 422, message: e.message)
+    else
+      log_error(e)
+      error message: 'Internal error', exception: e
+    end
+  end
+end

data/test/unit/auto_instrument/rescue_from.rb

@@ -0,0 +1,13 @@
+
+class BrokenController < ApplicationController
+  rescue_from Exception do |e|
+    if e.is_a? Pundit::NotAuthorizedError
+      unauthorized_error
+    elsif e.is_a? ActionController::ParameterMissing
+      error(status: 422, message: e.message)
+    else
+      log_error(e)
+      error message: 'Internal error', exception: e
+    end
+  end
+end

data/test/unit/auto_instrument_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+require 'scout_apm/auto_instrument'
+
+class AutoInstrumentTest < Minitest::Test
+  ROOT = File.expand_path("../../", __dir__)
+  
+  def source_path(name)
+    File.expand_path("auto_instrument/#{name}.rb", __dir__)
+  end
+
+  def instrumented_path(name)
+    File.expand_path("auto_instrument/#{name}-instrumented.rb", __dir__)
+  end
+
+  def instrumented_source(name)
+    File.read(instrumented_path(name))
+  end
+
+  # Autoinstruments adds a backtrace to each created layer. This is the full path to the
+  # test controller.rb file, which will be different on different environments.
+  # This normalizes backtraces across environments.
+  def normalize_backtrace(string)
+    string.gsub(ROOT, "ROOT")
+  end
+
+  # Use this to automatically update the test fixtures.
+  def update_instrumented_source(name)
+    source = ::ScoutApm::AutoInstrument::Rails.rewrite(source_path(name))
+    source = normalize_backtrace(source)
+    File.write(instrumented_path(name),source)
+  end
+
+  def test_controller_rewrite
+    # update_instrumented_source("controller")
+
+    assert_equal instrumented_source("controller"),
+      normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("controller")))
+  end
+
+  def test_rescue_from_rewrite
+    # update_instrumented_source("rescue_from")
+
+    assert_equal instrumented_source("rescue_from"),
+      normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("rescue_from")))
+  end
+
+  def test_assignments_rewrite
+    # update_instrumented_source("assignments")
+
+    assert_equal instrumented_source("assignments"),
+      normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("assignments")))
+  end
+end if defined? ScoutApm::AutoInstrument