scout_apm 3.0.0.pre23 → 4.0.0

data/test/unit/slow_request_policy_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 require 'scout_apm/slow_request_policy'
+require 'scout_apm/slow_policy/policy'
 require 'scout_apm/layer'
 
 class FakeRequest
@@ -16,30 +17,62 @@ class FakeRequest
   end
 end
 
+class FixedPolicy < ScoutApm::SlowPolicy::Policy
+  attr_reader :stored
+
+  def initialize(x)
+    @x = x
+  end
+
+  def call(req)
+    @x
+  end
+
+  def stored!(req)
+    @stored = true
+  end
+end
+
 class SlowRequestPolicyTest < Minitest::Test
   def setup
     @context = ScoutApm::AgentContext.new
   end
 
-  def test_stored_records_current_time
+  def test_age_policy_stored_records_current_time
     test_start = Time.now
-    policy = ScoutApm::SlowRequestPolicy.new(@context)
+    policy = ScoutApm::SlowPolicy::AgePolicy.new(@context)
     request = FakeRequest.new("users/index")
 
     policy.stored!(request)
     assert policy.last_seen[request.unique_name] > test_start
   end
 
-  def test_score
+  def test_sums_up_score
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
+    request = FakeRequest.new("users/index")
+
+    policy.add(FixedPolicy.new(1))
+    policy.add(FixedPolicy.new(2))
+
+    assert_equal 3, policy.score(request)
+  end
+
+  def test_calls_store_on_policies
     policy = ScoutApm::SlowRequestPolicy.new(@context)
     request = FakeRequest.new("users/index")
 
-    request.set_duration(10) # 10 seconds
-    policy.last_seen[request.unique_name] = Time.now - 120 # 2 minutes since last seen
-    @context.request_histograms.add(request.unique_name, 1)
+    policy.add(fp1 = FixedPolicy.new(1))
+    policy.add(fp2 = FixedPolicy.new(2))
+    policy.stored!(request)
+
+    assert_equal true, fp1.stored
+    assert_equal true, fp2.stored
+  end
+
+  def test_checks_new_policy_api
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
 
-    # Actual value I have in console is 1.499
-    assert policy.score(request) > 1.45
-    assert policy.score(request) < 1.55
+    assert_raises { policy.add(Object.new) }
+    assert_raises { policy.add(->(req){1}) } # only implements call
   end
 end

data/test/unit/sql_sanitizer_test.rb

@@ -28,7 +28,23 @@ module ScoutApm
         sql = %q|SELECT "users".* FROM "users" INNER JOIN "blogs" ON "blogs"."user_id" = "users"."id" WHERE (blogs.title = 'hello world')|
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
         assert_equal %q|SELECT "users".* FROM "users" INNER JOIN "blogs" ON "blogs"."user_id" = "users"."id" WHERE (blogs.title = ?)|, ss.to_s
+      end
+
+      def test_postgres_strips_after_where
+        raw_sql = %q|SELECT DISTINCT ON (flagged_traces.metric_name) flagged_traces.metric_name, "flagged_traces"."trace_id", "flagged_traces"."trace_type", "flagged_traces"."trace_occurred_at", flagged_traces.details ->> 'uri' as uri, (flagged_traces.details ->> 'n_sum_millis')::float as potential_savings, (flagged_traces.details ->> 'n_count')::float as num_queries FROM "flagged_traces" WHERE "flagged_traces"."app_id" = 5 AND "flagged_traces"."trace_type" = 'Request' AND ("flagged_traces"."trace_occurred_at" BETWEEN '2019-04-17 12:28:00.000000' AND '2019-04-18 12:28:00.000000') AND "flagged_traces"."flag_type" = 'nplusone' ORDER BY "flagged_traces"."metric_name" ASC, potential_savings DESC|
+        sanitized_sql = SqlSanitizer.new(raw_sql).tap { |it| it.database_engine = :postgres}
+        expected_sql = %q|SELECT DISTINCT ON (flagged_traces.metric_name) flagged_traces.metric_name, "flagged_traces"."trace_id", "flagged_traces"."trace_type", "flagged_traces"."trace_occurred_at", flagged_traces.details ->> 'uri' as uri, (flagged_traces.details ->> 'n_sum_millis')::float as potential_savings, (flagged_traces.details ->> 'n_count')::float as num_queries FROM "flagged_traces" WHERE "flagged_traces"."app_id" = ? AND "flagged_traces"."trace_type" = ? AND ("flagged_traces"."trace_occurred_at" BETWEEN ? AND ?) AND "flagged_traces"."flag_type" = ? ORDER BY "flagged_traces"."metric_name" ASC, potential_savings DESC|
+        assert_equal expected_sql, sanitized_sql.to_s
+      end
+
+      def test_postgres_strips_subquery_strings
+        raw_sql = %q|"SELECT 'orgs'.* FROM "orgs" WHERE  "orgs"."name" = 'Scout' AND "orgs"."created_by_user_id" IN (SELECT 'users'.'id' FROM "users" WHERE (id > AVG(id)) AND "type" = 'USER' AND "created_at" BETWEEN '2019-04-17 12:28:00.000000' AND '2019-04-18 12:28:00.000000')"|
+        sanitized_sql = SqlSanitizer.new(raw_sql).tap { |it| it.database_engine = :postgres}
+        expected_sql = %q|"SELECT 'orgs'.* FROM "orgs" WHERE "orgs"."name" = ? AND "orgs"."created_by_user_id" IN (SELECT 'users'.'id' FROM "users" WHERE (id > AVG(id)) AND "type" = ? AND "created_at" BETWEEN ? AND ?)"|
+        assert_equal expected_sql, sanitized_sql.to_s
+      end
 
+      def test_postgres_strips_integers
         # Strip integers
         sql = %q|SELECT "blogs".* FROM "blogs" WHERE (view_count > 10)|
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
@@ -89,6 +105,30 @@ module ScoutApm
         assert_equal %q|INSERT INTO `users` VALUES (?, ?)|, ss.to_s
       end
 
+      def test_sqlserver_integers
+        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
+
+        sql = "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"
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
+        assert_equal %q|SELECT  [users].* FROM [users] WHERE (age > ?)  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY|, ss.to_s
+      end
+
+      def test_sqlserver_strings
+        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
+
+        sql = "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE [users].[email] = @0  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @1 ROWS ONLY', N'@0 nvarchar(4000), @1 int', @0 = N'foo', @1 = 10"
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
+        assert_equal %q|SELECT  [users].* FROM [users] WHERE [users].[email] = @0  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @1 ROWS ONLY|, ss.to_s
+      end
+
+      def test_sqlserver_in_clause
+        skip "SQLServer Support requires Ruby 1.9+ For Regexes"
+
+        sql = "EXEC sp_executesql N'SELECT  [users].* FROM [users] WHERE (id IN (1,2,3))  ORDER BY [users].[id] ASC OFFSET 0 ROWS FETCH NEXT @0 ROWS ONLY', N'@0 int', @0 = 10"
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :sqlserver }
+        assert_equal %q|SELECT  [users].* FROM [users] WHERE (id IN (?))  ORDER BY [users].[id] ASC OFFSET ? ROWS FETCH NEXT @0 ROWS ONLY|, ss.to_s
+      end
+
       def test_scrubs_invalid_encoding
         skip "Ruby 1.8.7 has no concept of encoding" if RUBY_VERSION.start_with?("1.8.")
 
@@ -99,6 +139,13 @@ module ScoutApm
         assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
       end
 
+      def test_set_columns
+        sql = %q|UPDATE "mytable" SET "myfield" = 'fieldcontent', "countofthings" = 10 WHERE "user_id" = 10|
+
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|UPDATE "mytable" SET "myfield" = ?, "countofthings" = ? WHERE "user_id" = ?|, ss.to_s
+      end
+
       def assert_faster_than(target_seconds)
         t1 = ::Time.now
         yield

data/test/unit/transaction_time_consumed_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+require 'scout_apm/transaction_time_consumed'
+
+module ScoutApm
+  class TransactionTimeConsumedTest < Minitest::Test
+    def setup
+      @ttc = ScoutApm::TransactionTimeConsumed.new
+    end
+
+    def test_insert_new_times
+      @ttc.add("Controller/Foo", 1.5)
+      @ttc.add("Controller/Foo", 2.75)
+      assert_equal 4.25, @ttc.total_time_for("Controller/Foo")
+    end
+
+    def test_insert_tracks_endpoints_separately
+      @ttc.add("Controller/Foo", 1.5)
+      @ttc.add("Controller/Foo", 2.75)
+      @ttc.add("Controller/Bar", 5)
+      @ttc.add("Controller/Bar", 5)
+      assert_equal 4.25, @ttc.total_time_for("Controller/Foo")
+      assert_equal 10.0, @ttc.total_time_for("Controller/Bar")
+    end
+
+    def test_calculates_percent_of_total
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Bar", 4)
+      assert_equal 0.2, @ttc.percent_of_total("Controller/Foo")
+      assert_equal 0.8, @ttc.percent_of_total("Controller/Bar")
+    end
+
+    def test_counts_total_call_count
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Foo", 1)
+      @ttc.add("Controller/Bar", 4)
+      assert_equal 3, @ttc.call_count_for("Controller/Foo")
+      assert_equal 1, @ttc.call_count_for("Controller/Bar")
+    end
+
+    def test_percent_of_total_is_0_with_no_data
+      assert_equal 0.0, @ttc.percent_of_total("Controller/Foo")
+    end
+  end
+end

data/test/unit/utils/active_record_metric_name_test.rb

@@ -64,6 +64,16 @@ class ActiveRecordMetricNameTest < Minitest::Test
     assert_equal "User/find", mn.to_s
   end
 
+  def test_begin_statement
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new("BEGIN", nil)
+    assert_equal "SQL/begin", mn.to_s
+  end
+
+  def test_commit
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new("COMMIT", nil)
+    assert_equal "SQL/commit", mn.to_s
+  end
+
 
   # Regex test cases, pass these in w/ "SQL" as the AR provided name field
   [
@@ -89,8 +99,6 @@ class ActiveRecordMetricNameTest < Minitest::Test
     # Stuff we don't care about in SQL
     ["SQL/other", 'SET SESSION statement_timeout = ?'],
     ["SQL/other", 'SHOW TIME ZONE'],
-    ["SQL/other", 'BEGIN'],
-    ["SQL/other", 'COMMIT'],
 
     # Empty strings, or invalid SQL
     ["SQL/other", ''],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre23
+  version: 4.0.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -109,6 +109,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
@@ -171,7 +213,6 @@ email:
 executables: []
 extensions:
 - ext/allocations/extconf.rb
-- ext/stacks/extconf.rb
 - ext/rusage/extconf.rb
 extra_rdoc_files: []
 files:
@@ -190,9 +231,12 @@ files:
 - ext/rusage/README.md
 - ext/rusage/extconf.rb
 - ext/rusage/rusage.c
-- ext/stacks/extconf.rb
-- ext/stacks/scout_atomics.h
-- ext/stacks/stacks.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
@@ -200,9 +244,18 @@ files:
 - lib/scout_apm/agent_context.rb
 - lib/scout_apm/app_server_load.rb
 - lib/scout_apm/attribute_arranger.rb
+- lib/scout_apm/auto_instrument.rb
+- lib/scout_apm/auto_instrument/instruction_sequence.rb
+- lib/scout_apm/auto_instrument/layer.rb
+- lib/scout_apm/auto_instrument/parser.rb
+- lib/scout_apm/auto_instrument/rails.rb
 - lib/scout_apm/background_job_integrations/delayed_job.rb
+- lib/scout_apm/background_job_integrations/legacy_sneakers.rb
+- lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
+- lib/scout_apm/background_job_integrations/shoryuken.rb
 - lib/scout_apm/background_job_integrations/sidekiq.rb
+- lib/scout_apm/background_job_integrations/sneakers.rb
 - lib/scout_apm/background_recorder.rb
 - lib/scout_apm/background_worker.rb
 - lib/scout_apm/bucket_name_splitter.rb
@@ -212,7 +265,19 @@ files:
 - lib/scout_apm/db_query_metric_set.rb
 - lib/scout_apm/db_query_metric_stats.rb
 - lib/scout_apm/debug.rb
+- lib/scout_apm/detailed_trace.rb
 - lib/scout_apm/environment.rb
+- lib/scout_apm/error.rb
+- lib/scout_apm/error_service.rb
+- lib/scout_apm/error_service/error_buffer.rb
+- lib/scout_apm/error_service/error_record.rb
+- lib/scout_apm/error_service/ignored_exceptions.rb
+- lib/scout_apm/error_service/middleware.rb
+- lib/scout_apm/error_service/notifier.rb
+- lib/scout_apm/error_service/payload.rb
+- lib/scout_apm/error_service/periodic_work.rb
+- lib/scout_apm/error_service/railtie.rb
+- lib/scout_apm/error_service/sidekiq.rb
 - lib/scout_apm/extensions/config.rb
 - lib/scout_apm/extensions/transaction_callback_payload.rb
 - lib/scout_apm/fake_store.rb
@@ -227,15 +292,16 @@ files:
 - lib/scout_apm/instant/middleware.rb
 - lib/scout_apm/instant_reporting.rb
 - lib/scout_apm/instrument_manager.rb
-- lib/scout_apm/instruments/.DS_Store
 - lib/scout_apm/instruments/action_controller_rails_2.rb
 - lib/scout_apm/instruments/action_controller_rails_3_rails4.rb
 - lib/scout_apm/instruments/action_view.rb
 - lib/scout_apm/instruments/active_record.rb
 - lib/scout_apm/instruments/elasticsearch.rb
 - lib/scout_apm/instruments/grape.rb
+- lib/scout_apm/instruments/http.rb
 - lib/scout_apm/instruments/http_client.rb
 - lib/scout_apm/instruments/influxdb.rb
+- lib/scout_apm/instruments/memcached.rb
 - lib/scout_apm/instruments/middleware_detailed.rb
 - lib/scout_apm/instruments/middleware_summary.rb
 - lib/scout_apm/instruments/mongoid.rb
@@ -266,6 +332,7 @@ files:
 - lib/scout_apm/layer_converters/request_queue_time_converter.rb
 - lib/scout_apm/layer_converters/slow_job_converter.rb
 - lib/scout_apm/layer_converters/slow_request_converter.rb
+- lib/scout_apm/layer_converters/trace_converter.rb
 - lib/scout_apm/limited_layer.rb
 - lib/scout_apm/logger.rb
 - lib/scout_apm/metric_meta.rb
@@ -302,8 +369,12 @@ files:
 - lib/scout_apm/server_integrations/thin.rb
 - lib/scout_apm/server_integrations/unicorn.rb
 - lib/scout_apm/server_integrations/webrick.rb
-- lib/scout_apm/slow_job_policy.rb
 - lib/scout_apm/slow_job_record.rb
+- lib/scout_apm/slow_policy/age_policy.rb
+- lib/scout_apm/slow_policy/percent_policy.rb
+- lib/scout_apm/slow_policy/percentile_policy.rb
+- lib/scout_apm/slow_policy/policy.rb
+- lib/scout_apm/slow_policy/speed_policy.rb
 - lib/scout_apm/slow_request_policy.rb
 - lib/scout_apm/slow_transaction.rb
 - lib/scout_apm/stack_item.rb
@@ -311,16 +382,16 @@ files:
 - lib/scout_apm/synchronous_recorder.rb
 - lib/scout_apm/tasks/doctor.rb
 - lib/scout_apm/tasks/support.rb
-- 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/transaction_time_consumed.rb
 - lib/scout_apm/utils/active_record_metric_name.rb
 - lib/scout_apm/utils/backtrace_parser.rb
-- lib/scout_apm/utils/fake_stacks.rb
 - lib/scout_apm/utils/gzip_helper.rb
 - lib/scout_apm/utils/installed_gems.rb
 - lib/scout_apm/utils/klass_helper.rb
+- lib/scout_apm/utils/marshal_logging.rb
 - lib/scout_apm/utils/numbers.rb
 - lib/scout_apm/utils/scm.rb
 - lib/scout_apm/utils/sql_sanitizer.rb
@@ -333,20 +404,32 @@ files:
 - scout_apm.gemspec
 - test/data/config_test_1.yml
 - test/test_helper.rb
+- test/tmp/README.md
+- test/unit/agent_context_test.rb
 - test/unit/agent_test.rb
+- test/unit/auto_instrument/assignments-instrumented.rb
+- test/unit/auto_instrument/assignments.rb
+- test/unit/auto_instrument/controller-ast.txt
+- test/unit/auto_instrument/controller-instrumented.rb
+- test/unit/auto_instrument/controller.rb
+- test/unit/auto_instrument/rescue_from-instrumented.rb
+- test/unit/auto_instrument/rescue_from.rb
+- test/unit/auto_instrument_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/error_service/error_buffer_test.rb
+- test/unit/error_service/ignored_exceptions_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/active_record_test.rb
 - test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
 - test/unit/layaway_test.rb
@@ -360,20 +443,20 @@ files:
 - test/unit/remote/test_message.rb
 - test/unit/remote/test_router.rb
 - test/unit/remote/test_server.rb
+- test/unit/request_histograms_test.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
-- tester.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - Proprietary (See LICENSE.md)
@@ -385,17 +468,16 @@ require_paths:
 - data
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: scout_apm
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring