scout_apm 3.0.0.pre11 → 3.0.0.pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36bac9cf47e89f5cec6475b574b6cd948339d627
-  data.tar.gz: dd2bc23001811e393950d502f04b2a359dae083d
+  metadata.gz: ca4bf16454ad9fca2937243b738f7b8a6ae6c080
+  data.tar.gz: 9c84f2ee03e001220109dc1ffb32f2d5f7ab8e50
 SHA512:
-  metadata.gz: 0d2e5b8270afe767d63890df65b8ea6f1fba96f4a2187cd58537372e13c7555f94875b3884473f210eb6e96f1815240508a53c50638e0ba74ad96075d9364888
-  data.tar.gz: 7b0169e3e311061dc20da5088f7b22247ec3acf66ba145b827a926ef87763bf6e576282a282611c2d5178412de7b8ade5a24a7c50e730399c560e1f846626020
+  metadata.gz: f8b62b98284c93d8190408a9d364f9f3a82894670c52241a3de2faadd08635c332bdb93c50c37c331cd1458ebee8b67b68e979db03a2ea375d4775ce6103ea03
+  data.tar.gz: 99500b8f0e6e536e868c2f0e337775e61af71c7da1ddad986e2213807493e96d74b56330c0e84f4aca78cb35f6ecb1ddbeed0a6b4bd5e20cc5e367387e58fc29

data/CHANGELOG.markdown

@@ -1,13 +1,23 @@
-<<<<<<< HEAD
 # 3.0.0
 
 * ScoutProf BETA
-=======
+
+# 2.3.0
+
+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
->>>>>>> master
 
 # 2.1.31
 
@@ -46,7 +56,6 @@
 # 2.1.23
 
 * Extend Mongoid instrumentation to 6.x
->>>>>>> master
 
 # 2.1.22
 

data/Guardfile

@@ -18,6 +18,7 @@
 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' }
 

data/lib/scout_apm.rb

@@ -41,9 +41,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'
@@ -122,6 +125,7 @@ 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'
@@ -133,6 +137,7 @@ 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'
@@ -150,6 +155,7 @@ 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'
 

data/lib/scout_apm/agent/reporting.rb

@@ -59,6 +59,7 @@ module ScoutApm
         jobs = reporting_period.jobs
         slow_jobs = reporting_period.slow_jobs_payload
         histograms = reporting_period.histograms
+        db_query_metrics = reporting_period.db_query_metrics_payload
 
         metadata = {
           :app_root      => ScoutApm::Environment.instance.root.to_s,
@@ -71,7 +72,7 @@ module ScoutApm
 
         log_deliver(metrics, slow_transactions, metadata, slow_jobs, histograms)
 
-        payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms)
+        payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics)
         logger.debug("Sending payload w/ Headers: #{headers.inspect}")
 
         reporter.report(payload, headers)

data/lib/scout_apm/attribute_arranger.rb

@@ -14,7 +14,20 @@ module ScoutApm
         when :name
           attribute_hash[attribute] = subject.bucket_name
         when Symbol
-          attribute_hash[attribute] = subject.send(attribute)
+          data = subject.send(attribute)
+
+          # Never try to `as_json` a time object, since it'll break if the
+          # app has the Oj gem set to mimic_JSON, and there's never
+          # anything interesting nested inside of a Time obj. We just want
+          # the ISO8601 string (which happens later in the payload
+          # serializing process)
+          if data.is_a?(Time)
+            attribute_hash[attribute] = data
+          elsif data.respond_to?(:as_json)
+            attribute_hash[attribute] = data.as_json
+          else
+            attribute_hash[attribute] = data
+          end
         end
         attribute_hash
       end

data/lib/scout_apm/config.rb

@@ -41,6 +41,8 @@ module ScoutApm
         'compress_payload',
         'config_file',
         'data_file',
+        'database_metric_limit',
+        'database_metric_report_limit',
         'detailed_middleware',
         'dev_trace',
         'direct_host',
@@ -125,6 +127,12 @@ module ScoutApm
       end
     end
 
+    class IntegerCoercion
+      def coerce(val)
+        val.to_i
+      end
+    end
+
     # Simply returns the passed in value, without change
     class NullCoercion
       def coerce(val)
@@ -140,6 +148,8 @@ module ScoutApm
       "enable_background_jobs" => BooleanCoercion.new,
       "ignore"                 => JsonCoercion.new,
       "monitor"                => BooleanCoercion.new,
+      'database_metric_limit'  => IntegerCoercion.new,
+      'database_metric_report_limit' => IntegerCoercion.new,
     }
 
 
@@ -227,6 +237,8 @@ module ScoutApm
         'uri_reporting'          => 'full_path',
         'remote_agent_host'      => '127.0.0.1',
         'remote_agent_port'      => 7721, # picked at random
+        'database_metric_limit'  => 5000, # The hard limit on db metrics
+        'database_metric_report_limit' => 1000,
       }.freeze
 
       def value(key)

data/lib/scout_apm/db_query_metric_set.rb

@@ -0,0 +1,80 @@
+module ScoutApm
+  class DbQueryMetricSet
+    include Enumerable
+
+    attr_reader :metrics # the raw metrics. You probably want #metrics_to_report
+    attr_reader :config # A ScoutApm::Config instance
+
+    def initialize(config=ScoutApm::Agent.instance.config)
+      # A hash of DbQueryMetricStats values, keyed by DbQueryMetricStats.key
+      @metrics = Hash.new
+      @config = config
+    end
+
+    def each
+      metrics.each do |_key, db_query_metric_stat|
+        yield db_query_metric_stat
+      end
+    end
+
+    # Looks up a DbQueryMetricStats instance in the +@metrics+ hash. Sets the value to +other+ if no key
+    # Returns a DbQueryMetricStats instance
+    def lookup(other)
+      metrics[other.key] ||= other
+    end
+
+    # Take another set, and merge it with this one
+    def combine!(other)
+      other.each do |metric|
+        self << metric
+      end
+      self
+    end
+
+    # Add a single DbQueryMetricStats object to this set.
+    #
+    # Looks up an existing one under this key and merges, or just saves a new
+    # one under the key
+    def <<(stat)
+      existing_stat = metrics[stat.key]
+      if existing_stat
+        existing_stat.combine!(stat)
+      elsif at_limit?
+        # We're full up, can't add any more.
+        # Should I log this? It may get super noisy?
+      else
+        metrics[stat.key] = stat
+      end
+    end
+
+    def increment_transaction_count!
+      metrics.each do |_key, db_query_metric_stat|
+        db_query_metric_stat.increment_transaction_count!
+      end
+    end
+
+    def metrics_to_report
+      report_limit = config.value('database_metric_report_limit')
+      if metrics.size > report_limit
+        metrics.
+          values.
+          sort_by {|stat| stat.call_time }.
+          reverse.
+          take(report_limit)
+      else
+        metrics.values
+      end
+    end
+
+    def inspect
+      metrics.map {|key, metric|
+        "#{key.inspect} - Count: #{metric.call_count}, Total Time: #{"%.2f" % metric.call_time}"
+      }.join("\n")
+    end
+
+    def at_limit?
+      @limit ||= config.value('database_metric_limit')
+      metrics.size >= @limit
+    end
+  end
+end

data/lib/scout_apm/db_query_metric_stats.rb

@@ -0,0 +1,102 @@
+module ScoutApm
+  class DbQueryMetricStats
+
+    DEFAULT_HISTOGRAM_SIZE = 50
+
+    attr_reader :model_name
+    attr_reader :operation
+    attr_reader :scope
+
+    attr_reader :transaction_count
+
+    attr_reader :call_count
+    attr_reader :call_time
+    attr_reader :rows_returned
+
+    attr_reader :min_call_time
+    attr_reader :max_call_time
+
+    attr_reader :min_rows_returned
+    attr_reader :max_rows_returned
+
+    attr_reader :histogram
+
+    def initialize(model_name, operation, scope, call_count, call_time, rows_returned)
+      @model_name = model_name
+      @operation = operation
+
+      @call_count = call_count
+
+      @call_time = call_time
+      @min_call_time = call_time
+      @max_call_time = call_time
+
+      @rows_returned = rows_returned
+      @min_rows_returned = rows_returned
+      @max_rows_returned = rows_returned
+
+      # Should we have a histogram for timing, and one for rows_returned?
+      # This histogram is for call_time
+      @histogram = NumericHistogram.new(DEFAULT_HISTOGRAM_SIZE)
+      @histogram.add(call_time)
+
+      @transaction_count = 0
+
+      @scope = scope
+    end
+
+    # Merge data in this scope. Used in DbQueryMetricSet
+    def key
+      @key ||= [model_name, operation, scope]
+    end
+
+    # Combine data from another DbQueryMetricStats into +self+. Modifies and returns +self+
+    def combine!(other)
+      return self if other == self
+
+      @transaction_count += other.transaction_count
+      @call_count += other.call_count
+      @rows_returned += other.rows_returned
+      @call_time += other.call_time
+
+      @min_call_time = other.min_call_time if @min_call_time.zero? or other.min_call_time < @min_call_time
+      @max_call_time = other.max_call_time if other.max_call_time > @max_call_time
+
+      @min_rows_returned = other.min_rows_returned if @min_rows_returned.zero? or other.min_rows_returned < @min_rows_returned
+      @max_rows_returned = other.max_rows_returned if other.max_rows_returned > @max_rows_returned
+
+      @histogram.combine!(other.histogram)
+      self
+    end
+
+    def as_json
+      json_attributes = [
+        :model_name,
+        :operation,
+        :scope,
+
+        :transaction_count,
+        :call_count,
+
+        :histogram,
+        :call_time,
+        :max_call_time,
+        :min_call_time,
+
+        :max_rows_returned,
+        :min_rows_returned,
+        :rows_returned,
+      ]
+
+      ScoutApm::AttributeArranger.call(self, json_attributes)
+    end
+
+    # Called by the Set on each DbQueryMetricStats object that it holds, only
+    # once during the recording of a transaction.
+    #
+    # Don't call elsewhere, and don't set to 1 in the initializer.
+    def increment_transaction_count!
+      @transaction_count += 1
+    end
+  end
+end

data/lib/scout_apm/fake_store.rb

@@ -17,6 +17,12 @@ module ScoutApm
     def track_one!(type, name, value, options={})
     end
 
+    def track_histograms!(histograms, options={})
+    end
+
+    def track_db_query_metrics!(db_query_metric_set, options={})
+    end
+
     def track_slow_transaction!(slow_transaction)
     end
 

data/lib/scout_apm/instant/middleware.rb

@@ -224,7 +224,12 @@ module ScoutApm
       end
 
       def trace
-        @trace ||= LayerConverters::SlowRequestConverter.new(tracked_request).call
+        @trace ||=
+          begin
+            layer_finder = LayerConverters::FindLayerByType.new(tracked_request)
+            converter = LayerConverters::SlowRequestConverter.new(tracked_request, layer_finder, ScoutApm::FakeStore.new)
+            converter.call
+          end
       end
 
       def payload

data/lib/scout_apm/instruments/active_record.rb

@@ -42,6 +42,23 @@ module ScoutApm
           end
         end
 
+        if Utils::KlassHelper.defined?("ActiveRecord::Base")
+          ::ActiveRecord::Base.class_eval do
+            include ::ScoutApm::Instruments::ActiveRecordUpdateInstruments
+          end
+        end
+
+        # Disabled until we can determine how to use Module#prepend in the
+        # agent. Otherwise, this will cause infinite loops if NewRelic is
+        # installed. We can't just use normal Module#include, since the
+        # original methods don't call super the way Base#save does
+        #
+        #if Utils::KlassHelper.defined?("ActiveRecord::Relation")
+        #  ::ActiveRecord::Relation.class_eval do
+        #    include ::ScoutApm::Instruments::ActiveRecordRelationInstruments
+        #  end
+        #end
+
         if Utils::KlassHelper.defined?("ActiveRecord::Querying")
           ::ActiveRecord::Querying.module_eval do
             include ::ScoutApm::Tracer
@@ -208,5 +225,99 @@ module ScoutApm
         end
       end
     end
+
+    module ActiveRecordUpdateInstruments
+      def save(*args, &block)
+        model = self.class.name
+        operation = self.persisted? ? "Update" : "Create"
+
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} #{operation}"))
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          super(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+
+      def save!(*args, &block)
+        model = self.class.name
+        operation = self.persisted? ? "Update" : "Create"
+
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} #{operation}"))
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          super(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+    end
+
+    module ActiveRecordRelationInstruments
+      def self.included(instrumented_class)
+        ::ActiveRecord::Relation.class_eval do
+          alias_method :update_all_without_scout_instruments, :update_all
+          alias_method :update_all, :update_all_with_scout_instruments
+
+          alias_method :delete_all_without_scout_instruments, :delete_all
+          alias_method :delete_all, :delete_all_with_scout_instruments
+
+          alias_method :destroy_all_without_scout_instruments, :destroy_all
+          alias_method :destroy_all, :destroy_all_with_scout_instruments
+        end
+      end
+
+      def update_all_with_scout_instruments(*args, &block)
+        model = self.name
+
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} Update"))
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          update_all_without_scout_instruments(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+
+      def delete_all_with_scout_instruments(*args, &block)
+        model = self.name
+
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} Delete"))
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          delete_all_without_scout_instruments(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+
+      def destroy_all_with_scout_instruments(*args, &block)
+        model = self.name
+
+        req = ScoutApm::RequestManager.lookup
+        layer = ScoutApm::Layer.new("ActiveRecord", Utils::ActiveRecordMetricName.new("", "#{model} Delete"))
+        req.start_layer(layer)
+        req.ignore_children!
+        begin
+          destroy_all_without_scout_instruments(*args, &block)
+        ensure
+          req.acknowledge_children!
+          req.stop_layer
+        end
+      end
+    end
   end
 end