scout_apm 2.2.0.pre3 → 2.3.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4fa1f78b691cca73f89e5f79902cdc097633773
-  data.tar.gz: da4c781988cd5996d6d565b42d5ce25e90e4608a
+  metadata.gz: 120874f68724447c58563d1cf6dca52a33358713
+  data.tar.gz: ba7281a8b6d1d237d6df4b31d8de16e8b3f329b8
 SHA512:
-  metadata.gz: dc8f935276423d6cb568af1dded73c38af744747b07fb8ed390a0f3f968c6ff7188e912da1acd1c3599d683a1ee8160196ff7756c2b55c384b4584342e677ca9
-  data.tar.gz: e5709ffa058e1ffed9d16bc37733f38c0d777f1d33d597447f2d38c7a168635ecbca9d13540be7baa3a8e84a8f082b68ce23b2a62b3d92b7cb0c103010443bc5
+  metadata.gz: ddcc5fc87345bcda9787a2227ddc10d5ecbd16c6fd05c5b5d771082afc72b2e9b0b7ac2046bb34bb6f8bf78ef5420221ef44b501c9055a479522cfe177820a9c
+  data.tar.gz: a0726334d47ca7e4a094c97335dff2bd873ef11c4181e1d53f6904994cb648cfedd210d74e4581dcf433517b7fbce33890d57c98d04240c9cd94855b79530ee7

data/.gitignore

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

data/CHANGELOG.markdown

@@ -1,6 +1,151 @@
-# 2.2.0
+# 2.3.0
 
-* ScoutProf BETA
+Note: ScoutApm Agent version 2.2.0 was the initial ScoutProf agent that was
+determined quickly to be a big enough change to warrant the move to 3.0. We are not
+reusing that version number to avoid confusion.
+
+* Deeper database query instrumentation. The agent now collects app-wide
+  database usage on every call. This will allow you to better identify
+  persistently slow queries, and capacity bottlenecks.
+* Optimize the approach used during recording each request to avoid unnecessary
+  work, improving performance
+
+# 2.1.32
+
+* Better naming when using Resque + ActiveJob
+* Better naming when using Sidekiq + DelayedExtension
+
+# 2.1.31
+
+* Better detection of Resque queue names
+* Fix passing arguments through Active Record instrumentation. (Thanks to Nick Quaranto for providing the fix)
+* Stricter checks to prevent agent from starting in Rails console
+
+# 2.1.30
+
+* Add Resque support.
+
+# 2.1.29
+
+* Add `scm_subdirectory` option. Useful for when your app code does not live in your SCM root directory.
+
+# 2.1.28
+
+* Changes to app server load data
+
+# 2.1.27
+
+* Don't attempt to call `current_layer.type` on nil
+
+# 2.1.26
+
+* Bug fix [4b188d6](https://github.com/scoutapp/scout_apm_ruby/commit/4b188d698852c86b86d8768ea5b37d706ce544fe)
+
+# 2.1.25
+
+* Automatically instrument API and Metal controllers.
+
+# 2.1.24
+
+* Capture additional layers of application backtrace frames. (From 3 -> 8)
+
+# 2.1.23
+
+* Extend Mongoid instrumentation to 6.x
+
+# 2.1.22
+
+* Add DevTrace support for newest 4.2.x and 5.x versions of Rails
+
+# 2.1.21
+
+* Fix edge case, causing DevTrace to fail
+* Add debug tooling, allowing custom functions to be inserted into the agent at
+  key points.
+
+# 2.1.20
+
+* Add a `detailed_middleware` boolean configuration option to capture
+  per-middleware data, as opposed to the default of aggregating all middleware
+  together.  This has a small amount of additional overhead, approximately
+  10-15ms per request.
+
+# 2.1.19
+
+* Log all configuration settings at start when log level is debug
+* Tune DelayedJob class name detection
+
+# 2.1.18
+
+* Max layaway file threshold limit
+
+# 2.1.17
+
+* Additional logging around file system usage
+
+# 2.1.16
+
+* Extract the name correctly for DelayedJob workers run via ActiveJob
+
+# 2.1.15
+
+* Limit memory usage for very long running requests.
+
+# 2.1.14
+
+* Add TrackedRequest#ignore_request! to entirely ignore and stop capturing a
+  certain request. Use in your code by calling:
+    ScoutApm::RequestManager.lookup.ignore_request!
+
+# 2.1.13
+
+* Rework Delayed Job instrumentation to not interfere with other instruments.
+
+# 2.1.12
+
+* Revert 2.1.11's Delayed Job change - caused issues in a handful of environments
+
+# 2.1.11
+
+* Support alternate methods of launching Delayed Job
+
+# 2.1.10
+
+* Fix issue getting a default Application Name when it wasn't explicitly set
+
+# 2.1.9
+
+* Send raw histograms of response time, enabling more accurate 95th %iles
+* Raw histograms are used in Apdex calculations
+* Gzip payloads
+* Fix Mongoid (5.0) + Mongo (2.1) support
+* 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
+
+# 2.1.7
+
+* Fix allocations extension compilation on Ruby 1.8.7
+
+# 2.1.6
+
+* Support older versions of Grape (0.10 onward)
+* Vendor rusage library
+* Fix double-exit that caused error messages when running under Passenger
+
+# 2.1.5
+
+* Be less strict loading Rails environments that don't have a matching
+  scout_apm.yml section. Previously we raised, now we log and continue
+  to load with the ENV settings
+* Fix a memory leak in error recovery code
+* Fix a minor race condition in data coordination between processes.
+  * There was a tiny sliver of a window where a lock wasn't held, and it caused
+    an exception to be raised.
 
 # 2.1.4
 

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/Rakefile

@@ -3,7 +3,7 @@ require "bundler/gem_tasks"
 task :default => :test
 
 desc "Run Unit Tests"
-task :test do
+task :test => [:compile] do
   $: << File.expand_path(File.dirname(__FILE__) + "/test")
   Dir.glob('./test/**/*_test.rb').each { |file| require file }
 end
@@ -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

@@ -1,4 +1,8 @@
+#ifdef HAVE_RUBY_RUBY_H
 #include <ruby/ruby.h>
+#else // Ruby <= 1.8.7
+#include <ruby.h>
+#endif
 
 VALUE mScoutApm;
 VALUE mInstruments;
@@ -52,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);
 }
@@ -74,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/ext/allocations/extconf.rb

@@ -1,3 +1,4 @@
 require 'mkmf'
 
+have_header("ruby/ruby.h") # Needed to check for Ruby <= 1.8.7
 create_makefile('allocations')

data/ext/rusage/README.md

@@ -0,0 +1,26 @@
+This is a vendored copy of the rusage gem.
+
+
+= rusage
+
+* http://github.com/sandofsky/rusage
+
+== DESCRIPTION:
+
+A gem that calls getrusage to get details on the current process.
+
+Ripped out of the proc/wait3 library, originally written by Daniel J. Berger.
+
+http://raa.ruby-lang.org/project/proc-wait3/
+
+== LICENSE:
+
+Inherits the Artistic License 2.0 from proc/wait3.
+
+== COPYRIGHT:
+
+The original code is still copyright Daniel J. Berger.
+
+rusage gem is copyright Ben Sandofsky.
+
+Code changes after being added to this repository are copyright Zimuth, Inc.

data/ext/rusage/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+dir_config("rusage")
+
+create_makefile("rusage")

data/ext/rusage/rusage.c

@@ -0,0 +1,52 @@
+// VERSION = "x.y.z"
+#include <ruby.h>
+#include <sys/resource.h>
+
+VALUE v_usage_struct;
+
+static VALUE do_rusage_get(int who){
+  struct rusage r;
+  int ret;
+
+  ret = getrusage(who, &r);
+  if(ret == -1)
+    rb_sys_fail("getrusage");
+
+  return rb_struct_new(v_usage_struct,
+      rb_float_new((double)r.ru_utime.tv_sec+(double)r.ru_utime.tv_usec/1e6),
+      rb_float_new((double)r.ru_stime.tv_sec+(double)r.ru_stime.tv_usec/1e6),
+      LONG2NUM(r.ru_maxrss),
+      LONG2NUM(r.ru_ixrss),
+      LONG2NUM(r.ru_idrss),
+      LONG2NUM(r.ru_isrss),
+      LONG2NUM(r.ru_minflt),
+      LONG2NUM(r.ru_majflt),
+      LONG2NUM(r.ru_nswap),
+      LONG2NUM(r.ru_inblock),
+      LONG2NUM(r.ru_oublock),
+      LONG2NUM(r.ru_msgsnd),
+      LONG2NUM(r.ru_msgrcv),
+      LONG2NUM(r.ru_nsignals),
+      LONG2NUM(r.ru_nvcsw),
+      LONG2NUM(r.ru_nivcsw)
+   );
+}
+
+static VALUE rusage_get(int argc, VALUE* argv, VALUE mod){
+  return do_rusage_get(RUSAGE_SELF);
+}
+
+static VALUE crusage_get(int argc, VALUE* argv, VALUE mod){
+  return do_rusage_get(RUSAGE_CHILDREN);
+}
+
+void Init_rusage(){
+  v_usage_struct =
+     rb_struct_define("RUsage","utime","stime","maxrss","ixrss","idrss",
+        "isrss","minflt","majflt","nswap","inblock","oublock","msgsnd",
+        "msgrcv","nsignals","nvcsw","nivcsw",NULL
+     );
+
+  rb_define_module_function(rb_mProcess, "rusage", rusage_get, -1);
+  rb_define_module_function(rb_mProcess, "crusage", crusage_get, -1);
+}

data/lib/scout_apm.rb

@@ -14,7 +14,7 @@ require 'socket'
 require 'thread'
 require 'time'
 require 'yaml'
-require 'rbconfig'
+require 'webrick'
 
 #####################################
 # Gem Requires
@@ -26,8 +26,11 @@ require 'rusage'
 #####################################
 require 'scout_apm/version'
 
+require 'scout_apm/debug'
 require 'scout_apm/tracked_request'
 require 'scout_apm/layer'
+require 'scout_apm/limited_layer'
+require 'scout_apm/layer_children_set'
 require 'scout_apm/request_manager'
 require 'scout_apm/call_set'
 
@@ -37,9 +40,12 @@ require 'scout_apm/layer_converters/error_converter'
 require 'scout_apm/layer_converters/job_converter'
 require 'scout_apm/layer_converters/slow_job_converter'
 require 'scout_apm/layer_converters/metric_converter'
+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/histograms'
+require 'scout_apm/layer_converters/find_layer_by_type'
 
 require 'scout_apm/server_integrations/passenger'
 require 'scout_apm/server_integrations/puma'
@@ -51,6 +57,7 @@ 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/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'
@@ -63,9 +70,6 @@ require 'scout_apm/platform_integrations/server'
 
 require 'scout_apm/histogram'
 
-require 'scout_apm/deploy_integrations/capistrano_3'
-# require 'scout_apm/deploy_integrations/capistrano_2'
-
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
@@ -73,26 +77,20 @@ require 'scout_apm/instruments/mongoid'
 require 'scout_apm/instruments/redis'
 require 'scout_apm/instruments/influxdb'
 require 'scout_apm/instruments/elasticsearch'
-require 'scout_apm/instruments/delayed_job'
 require 'scout_apm/instruments/active_record'
 require 'scout_apm/instruments/action_controller_rails_2'
 require 'scout_apm/instruments/action_controller_rails_3_rails4'
 require 'scout_apm/instruments/middleware_summary'
-# require 'scout_apm/instruments/middleware_detailed' # Currently disabled functionality, see the file for details.
+require 'scout_apm/instruments/middleware_detailed' # Disabled by default, see the file for more details
 require 'scout_apm/instruments/rails_router'
 require 'scout_apm/instruments/grape'
 require 'scout_apm/instruments/sinatra'
 require 'scout_apm/instruments/process/process_cpu'
 require 'scout_apm/instruments/process/process_memory'
 require 'scout_apm/instruments/percentile_sampler'
+require 'scout_apm/instruments/action_view'
 require 'allocations'
 
-begin
-  require 'stacks'
-rescue LoadError
-  require 'scout_apm/utils/fake_stacks'
-end
-
 require 'scout_apm/app_server_load'
 
 require 'scout_apm/ignored_uris.rb'
@@ -101,9 +99,12 @@ require 'scout_apm/utils/backtrace_parser'
 require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/klass_helper'
 require 'scout_apm/utils/null_logger'
+require 'scout_apm/utils/scm'
 require 'scout_apm/utils/sql_sanitizer'
 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/config'
 require 'scout_apm/environment'
@@ -117,15 +118,18 @@ require 'scout_apm/background_worker'
 require 'scout_apm/bucket_name_splitter'
 require 'scout_apm/stack_item'
 require 'scout_apm/metric_set'
+require 'scout_apm/db_query_metric_set'
 require 'scout_apm/store'
 require 'scout_apm/fake_store'
 require 'scout_apm/tracer'
 require 'scout_apm/context'
 require 'scout_apm/instant_reporting'
-require 'scout_apm/trace_compactor'
+require 'scout_apm/background_recorder'
+require 'scout_apm/synchronous_recorder'
 
 require 'scout_apm/metric_meta'
 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/scored_item_set'
@@ -134,22 +138,31 @@ require 'scout_apm/slow_job_policy'
 require 'scout_apm/job_record'
 require 'scout_apm/request_histograms'
 
-require 'scout_apm/capacity'
 require 'scout_apm/attribute_arranger'
+require 'scout_apm/git_revision'
 
 require 'scout_apm/serializers/payload_serializer'
 require 'scout_apm/serializers/payload_serializer_to_json'
 require 'scout_apm/serializers/jobs_serializer_to_json'
 require 'scout_apm/serializers/slow_jobs_serializer_to_json'
 require 'scout_apm/serializers/metrics_to_json_serializer'
+require 'scout_apm/serializers/histograms_serializer_to_json'
+require 'scout_apm/serializers/db_query_serializer_to_json'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
-require 'scout_apm/serializers/deploy_serializer'
 
 require 'scout_apm/middleware'
 
 require 'scout_apm/instant/middleware'
 
+require 'scout_apm/rack'
+
+require 'scout_apm/remote/server'
+require 'scout_apm/remote/router'
+require 'scout_apm/remote/message'
+require 'scout_apm/remote/recorder'
+require 'scout_apm/instruments/resque'
+
 if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3 && defined?(Rails::Railtie)
   module ScoutApm
     class Railtie < Rails::Railtie