scout_apm 3.0.0.pre26 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d464aa5c996bd02a57ce41e4fe6891ea7cac1c27
-  data.tar.gz: ac8778e12b752200d391e0dd8a5e9e56e19ac5e7
+SHA256:
+  metadata.gz: 984d05544e5a2ce1b325c8a27f619f9b7ee54e8d98f614bebd41049c2c162105
+  data.tar.gz: f10c260c2cab2d1f00d6f6267eb643b860f872352edc9fa8ba8bedd0ac392023
 SHA512:
-  metadata.gz: a3554af6cc62a696af7fcfc31b027bd54294f80159b19cc5727fd2946c00cc53d04e1cdaf82c72bf956e011bb21f7ccc3da31a7a510aa021ef7fda74ec9d0667
-  data.tar.gz: 421dbf05b82468f80a40e4b7fa95d45e890bc1a68e401476603c54728b3f50f9282d304bf57044a60c0750d1fc51b0ae0ccc4d2fc60f6ccdfcebe77068b95711
+  metadata.gz: ec9bc8174b44664990ffd3ab52fa0b3232f8c000dd69b50cab3d69b467acd74138aaec8d7494ecb1ae4cd50c3a70709db11abe232a9636cb76bb497bbc70341a
+  data.tar.gz: 114715176bcfb080ad8db4cce5fc38d6e3de345e19899352e754dee042bbf6267c983fd8e0dba8a87cb9d6efd4e29af9a047d123c429cac7a86854125e961dc5

data/.github/workflows/test.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+      - run: bundle exec rubocop
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 2.1
+            gemfile: gems/rails3.gemfile
+          - ruby: 2.2
+          - ruby: 2.3
+          - ruby: 2.4
+          - ruby: 2.5
+          - ruby: 2.6
+          - ruby: 2.6
+            gemfile: gems/octoshark.gemfile
+          - ruby: 2.6
+            gemfile: gems/rails3.gemfile
+            bundler: 1.17.3
+          - ruby: 2.7
+          - ruby: 3.0
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          bundler: ${{matrix.bundler}}
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake

data/.gitignore

@@ -17,5 +17,5 @@ test/tmp/*coverage/*
 coverage/*
 lib/*.bundle
 lib/*.so
-**/.RUBYARCHDIR.time
 log/scout_apm.log
+gems/*.lock

data/.rubocop.yml

@@ -1,13 +1,13 @@
 # Disable all cops by default
 AllCops:
   DisabledByDefault: true
+  Exclude:
+    - 'test/unit/auto_instrument/*'
+    - vendor/bundle/**/*
+  SuggestExtensions: false
 
 # 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:
+Layout/LineLength:
   Enabled: false
   Max: 100
-
-Style/HashSyntax:
-  Enabled: true
-  EnforcedStyle: hash_rockets

data/.travis.yml

@@ -1,17 +1,22 @@
 language: ruby
-rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "2.0"
-  - "2.2"
-  - "2.4"
-  - "2.5"
+dist: xenial
 cache: bundler
-before_install:
-  - gem update --system
-  - gem install bundler
-jobs:
+
+matrix:
   include:
-    - script: bundle exec rake test
-    - script: bundle exec rubocop
-      rvm: "2.5"
+    - rvm: 2.1
+      gemfile: gems/rails3.gemfile
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.7
+    - rvm: 3.0
+    - 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,145 @@
-# 3.0.0
+# 4.0.2
 
-* ScoutProf BETA
+* Add Typhoeus instrumentation (#376)
+
+# 4.0.1
+
+* Add support for Ruby 3.0 (#374)
+* Use Github Actions for CI (#370)
+* Fix edge case in sanitization of Postgres SQL (#368)
+
+# 4.0.0
+
+* Require Ruby >= 2.1 (#270)
+* ErrorService reporting. Enable with `errors_enabled` config setting. (#347)
+* Modular SlowRequestPolicy (#364)
+* Fix deprecation warnings (#354)
+
+# 2.6.10
+
+* Fix an edge case in JSON serialization (#360)
+
+# 2.6.9
+
+* Add `ssl_cert_file` config option (#352)
+* Improve sanitization of Postgres UPDATE SQL (#351)
+* Allow custom URL sanitization (#341)
+
+# 2.6.8
+
+* Lock rake version for 1.8.7 to older version (#329)
+* Delete unneeded .DS_Store file that snuck in (#334)
+* Fix typo in "queue_time_ms"
+* Fix Rails 6 deprecation warning at boot time (#337)
+* Fix partial naming on Rails 6.0 (#339)
+* Support Sidekiq 6.1 instrumentation (#340)
+
+# 2.6.7
+
+* Remove accidental call to `as_json`
+
+# 2.6.6
+
+* Add basic support for parsing Microsoft SQLServer queries (#317)
+* Refine Postgresql Sanitization with subqueries and JSON operations (#262)
+
+# 2.6.5
+
+* Add a tag to any requests that reach maximum number of spans (#316)
+* Update testing library Mocha (#315)
+* Fix case sensitivity mismatch in Job renaming (#314)
+* Add support for Sneakers 2.5 (#313)
+* Fix edge case with Resque instrumentation (#312)
+* Fix missing source code when used with BugSnag (#308)
+
+# 2.6.4
+
+* Add defensive check against a nil @address in Net/HTTP instruments (#306)
+
+# 2.6.3
+
+* Standardize Metadata with other language agents (#302)
+* Add Mongoid 7.x support (#295)
+* Add HTTP::Client support (#260)
+
+# 2.6.2
+
+* Fix Autoinstruments logging when running without ActiveSupport (#290)
+* Fix edge-case Autoinstruments syntax error (#287)
+* Fix invalid syntax for running on Ruby 1.8.7
+
+# 2.6.1
+
+* Logging total autoinstrumented spans and the ratio of significant to total spans (#283).
+* Added `autoinstruments_ignore` option (also #283).
+
+# 2.6.0
+
+* Autoinstruments (#247). Disabled by default. Set `auto_instruments: true` to enable.
+
+# 2.5.3
+
+* Add Que support (#265)
+* Add Memcached support (#279)
+
+# 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 to address [this bug](https://github.com/scoutapp/scout_apm_ruby/issues/267).
+
+# 2.5.0
+
+* Added timeline traces and an associated `timeline_traces: true` config option.
+* Increased timeline traces span limit to 2,500 from 500.
+
+# 2.4.24
+
+* Fix for prepending view instruments in the case of templates that lack a `virtual_path` (#257).
+
+# 2.4.23
+
+* Extend #251 to use prepend on all view instruments (#255)
+
+# 2.4.22
+
+* Support Rails 6.0 View Instruments (#251)
+* Update documentation URLs (#236)
+
+# 2.4.21
+
+* App & Background Integrations only install when needed (#228)
+* New Setting `collect_remote_ip`, to optionally disable automated capture of
+  end-user IP Address. No change to default behavior.
+* Allow setting `compress_payload` option from ENV var (#234)
+
+# 2.4.20
+
+* `start_resque_server_instrument` option to allow disabling the WEBrick server
+   component in custom installation scenarios
+* Allow setting `revision_sha` setting in YAML
+
+# 2.4.19
+
+* Fix disabled_instruments (#220)
+
+# 2.4.18
+
+* Add Shoryuken Support (#215)
+* Add Sneakers Support (#216)
+
+# 2.4.17
+
+* Renames SQL `BEGIN` and `COMMIT` statements from `SQL#other` to `SQL#begin` and `SQL#commit`, respectively.
+* Makes naming between transaction and database metrics consistent. Previously, database metrics lacking a provided ActiveRecord label were named `SQL#other`.
+
+# 2.4.16
+
+* Fix synchronization bug in Store (#205, PR #210)
 
 # 2.4.15
 
@@ -187,7 +326,6 @@ reusing that version number to avoid confusion.
 
 * Max layaway file threshold limit
 
-
 # 2.1.17
 
 * Additional logging around file system usage
@@ -231,6 +369,7 @@ reusing that version number to avoid confusion.
 * Initial Delayed Job support
 * Limit max metric size of a trace to 500.
 
+
 # 2.1.8
 
 * Adds Git revision detection, which is reported on app load and associated with transaction traces
@@ -616,7 +755,7 @@ Big set of features getting merged in for this release.
 
 # 0.1.3
 
-* Adds capacity calculation via "Instance/Capacity" metric. 
+* Adds capacity calculation via "Instance/Capacity" metric.
 * Tweaks tracing to still count a transaction if it results in a 500 error and includes it in accumulated time.
 * Adds per-transaction error tracking (ex: Errors/Controller/widgets/index)
 

data/Gemfile

@@ -3,10 +3,4 @@ source "https://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
+gem "rake", ">= 12.3.3"

data/README.markdown

@@ -12,8 +12,8 @@ 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).
+* View your performance metrics during development with [DevTrace](https://docs.scoutapm.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
+* Production-Safe profiling of custom code via [ScoutProf](https://docs.scoutapm.com/#scoutprof) (BETA).
 
 ## Getting Started
 
@@ -25,7 +25,7 @@ Update your Gemfile
 
     bundle install
 
-Signup for a [Scout](https://apm.scoutapp.com) account and put the provided
+Signup for a [Scout](https://scoutapm.com) account and put the provided
 config file at `RAILS_ROOT/config/scout_apm.yml`.
 
 Your config file should look like:
@@ -35,6 +35,9 @@ Your config file should look like:
       key: YOUR_APPLICATION_KEY
       monitor: true
 
+    test:
+      monitor: false
+
     production:
       <<: *defaults
 
@@ -55,10 +58,16 @@ gem 'scout_apm'
 SCOUT_DEV_TRACE=true rails server
 ```
 
+## How to test gem locally
+
+* Point your gemfile at your local checkout: `gem 'scout_apm', path: '/path/to/scout_apm_ruby`
+* Compile native code: `cd /path/to/scout_apm_ruby && bundle exec rake compile`
+
+
 ## Docs
 
 For the complete list of supported frameworks, Rubies, configuration options
-and more, see our [help site](http://help.apm.scoutapp.com/).
+and more, see our [help site](https://docs.scoutapm.com/).
 
 ## Help
 

data/Rakefile

@@ -21,5 +21,5 @@ end
 # Rake Compiler
 require 'rake/extensiontask'
 Rake::ExtensionTask.new('allocations')
-Rake::ExtensionTask.new('stacks')
 Rake::ExtensionTask.new('rusage')
+

data/ext/allocations/allocations.c

@@ -56,6 +56,7 @@ void Init_allocations()
     mInstruments = rb_define_module_under(mScoutApm, "Instruments");
     cAllocations = rb_define_class_under(mInstruments, "Allocations", rb_cObject);
     rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
+    rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
     rb_define_const(cAllocations, "ENABLED", Qtrue);
     Init_hooks(mScoutApm);
 }
@@ -78,6 +79,7 @@ void Init_allocations()
     mInstruments = rb_define_module_under(mScoutApm, "Instruments");
     cAllocations = rb_define_class_under(mInstruments, "Allocations", rb_cObject);
     rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
+    rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
     rb_define_const(cAllocations, "ENABLED", Qfalse);
     Init_hooks(mScoutApm);
 }

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,5 @@
+eval_gemfile("../Gemfile")
+
+gem "json", "1.8.6"
+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"
+gem "sqlite3", "~> 1.4"

data/lib/scout_apm.rb

@@ -6,6 +6,7 @@ end
 #####################################
 require 'cgi'
 require 'logger'
+require 'monitor'
 require 'net/http'
 require 'openssl'
 require 'pp'
@@ -14,7 +15,7 @@ require 'socket'
 require 'thread'
 require 'time'
 require 'yaml'
-require 'rbconfig'
+require 'securerandom'
 
 #####################################
 # Gem Requires
@@ -44,6 +45,7 @@ require 'scout_apm/layer_converters/database_converter'
 require 'scout_apm/layer_converters/slow_request_converter'
 require 'scout_apm/layer_converters/request_queue_time_converter'
 require 'scout_apm/layer_converters/allocation_metric_converter'
+require 'scout_apm/layer_converters/trace_converter'
 require 'scout_apm/layer_converters/histograms'
 require 'scout_apm/layer_converters/find_layer_by_type'
 
@@ -58,6 +60,10 @@ require 'scout_apm/server_integrations/null'
 require 'scout_apm/background_job_integrations/sidekiq'
 require 'scout_apm/background_job_integrations/delayed_job'
 require 'scout_apm/background_job_integrations/resque'
+require 'scout_apm/background_job_integrations/shoryuken'
+require 'scout_apm/background_job_integrations/sneakers'
+require 'scout_apm/background_job_integrations/que'
+require 'scout_apm/background_job_integrations/legacy_sneakers'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'
@@ -72,8 +78,10 @@ require 'scout_apm/histogram'
 
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
+require 'scout_apm/instruments/typhoeus'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
+require 'scout_apm/instruments/memcached'
 require 'scout_apm/instruments/redis'
 require 'scout_apm/instruments/influxdb'
 require 'scout_apm/instruments/elasticsearch'
@@ -93,12 +101,6 @@ require 'scout_apm/instruments/process/process_memory'
 require 'scout_apm/instruments/percentile_sampler'
 require 'scout_apm/instruments/samplers'
 
-begin
-  require 'stacks'
-rescue LoadError
-  require 'scout_apm/utils/fake_stacks'
-end
-
 require 'scout_apm/app_server_load'
 
 require 'scout_apm/ignored_uris.rb'
@@ -112,6 +114,7 @@ require 'scout_apm/utils/time'
 require 'scout_apm/utils/unique_id'
 require 'scout_apm/utils/numbers'
 require 'scout_apm/utils/gzip_helper'
+require 'scout_apm/utils/marshal_logging'
 
 require 'scout_apm/config'
 require 'scout_apm/environment'
@@ -132,7 +135,6 @@ require 'scout_apm/tracer'
 require 'scout_apm/transaction'
 require 'scout_apm/context'
 require 'scout_apm/instant_reporting'
-require 'scout_apm/trace_compactor'
 require 'scout_apm/background_recorder'
 require 'scout_apm/synchronous_recorder'
 
@@ -141,9 +143,15 @@ require 'scout_apm/metric_stats'
 require 'scout_apm/db_query_metric_stats'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/slow_job_record'
+require 'scout_apm/detailed_trace'
 require 'scout_apm/scored_item_set'
+
 require 'scout_apm/slow_request_policy'
-require 'scout_apm/slow_job_policy'
+require 'scout_apm/slow_policy/age_policy'
+require 'scout_apm/slow_policy/speed_policy'
+require 'scout_apm/slow_policy/percent_policy'
+require 'scout_apm/slow_policy/percentile_policy'
+
 require 'scout_apm/job_record'
 require 'scout_apm/request_histograms'
 require 'scout_apm/transaction_time_consumed'
@@ -184,6 +192,16 @@ require 'scout_apm/tasks/support'
 require 'scout_apm/extensions/config'
 require 'scout_apm/extensions/transaction_callback_payload'
 
+require 'scout_apm/error_service'
+require 'scout_apm/error_service/middleware'
+require 'scout_apm/error_service/notifier'
+require 'scout_apm/error_service/sidekiq'
+require 'scout_apm/error_service/ignored_exceptions'
+require 'scout_apm/error_service/error_buffer'
+require 'scout_apm/error_service/error_record'
+require 'scout_apm/error_service/periodic_work'
+require 'scout_apm/error_service/payload'
+
 if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3 && defined?(Rails::Railtie)
   module ScoutApm
     class Railtie < Rails::Railtie
@@ -196,6 +214,18 @@ if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR
         # Attempt to start right away, this will work best for preloading apps, Unicorn & Puma & similar
         ScoutApm::Agent.instance.install
 
+        if ScoutApm::Agent.instance.context.config.value("auto_instruments")
+          ScoutApm::Agent.instance.context.logger.debug("AutoInstruments is enabled.")
+          require 'scout_apm/auto_instrument'
+        else
+          ScoutApm::Agent.instance.context.logger.debug("AutoInstruments is disabled.")
+        end
+
+        if ScoutApm::Agent.instance.context.config.value("errors_enabled")
+          app.config.middleware.insert_after ActionDispatch::DebugExceptions, ScoutApm::ErrorService::Middleware
+          ScoutApm::ErrorService::Sidekiq.new.install
+        end
+
         # Install the middleware every time in development mode.
         # The middleware is a noop if dev_trace is not enabled in config
         if Rails.env.development?