scout_apm 2.0.0.pre → 2.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18724905e7c795caad3fc416688b3044e624d79
-  data.tar.gz: ee4ec99aeb9fa9e32c7b846caec0f010070546c2
+  metadata.gz: 119d6658eaefd7e3b177c1e982006f0d59dd208b
+  data.tar.gz: 5585bca449804241d8778a1ff716444c50ac86d8
 SHA512:
-  metadata.gz: 236bfd93df93733c409684ac735dfbc77b5412f221127b5acbec9fc679b3141c6ac8e4c46c485295532aee7821b8fda36edd648233f820ed045d667905237448
-  data.tar.gz: 4b43e6158568bd089b3174bd8af445baef2260f92a33c31b50ed8627722a9f194fc2e4352c509c12e677e71f824e04e22226ce5c1b7a5c542f2e806167c0aabb
+  metadata.gz: 5e6ad957c5948b239d530e9cc4e35445a37abb1331ef3c20357371a1c5da9286e4b9d38e84df2aecedd23a39e1a5d0163d76dd76549e41c700b78e15f770338d
+  data.tar.gz: 060b1d7a09e6e5c37cd1a087bd7bf13faaab3e3b5b3aaf8d7f4173a50fa97c76d39c4ccaf299b05cdd48232a6b7638caeab88674110072a26692ad77fad2533e

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp/*
 .DS_Store
 test/tmp/*coverage/*
 coverage/*
+lib/allocations.bundle

data/CHANGELOG.markdown

@@ -1,17 +1,34 @@
+
 # 2.0.0
 
 * Reporting object allocation metrics and mem delta with slow requests and jobs.
+* Collecting memory metrics on slow transactions
+* Collecting additional fields for slow transactions:
+  * hostname
+  * seconds_since_startup (larger memory increases and other other odd behavior more common when close to startup)
+* Initial support for instant traces
+* Collect 95th percentiles
+
+# 1.5.5
+
+* Handle backslash escaped quotes inside mysql strings.
+
+# 1.5.4
+
+* Fix issue where error counts were being misreported
+* Politely ignore cases when `request.remote_ip` raises exceptions.
+
+# 1.5.3
+
+* Fix another minor bug related to iso8601 timestamps
 
 # 1.5.2
 
-* Fix deploy webhook endpoint
+* Force timestamps to be iso8601 format
 
 # 1.5.1
 
-* Collecting memory metrics on slow transactions
-* Collecting additional fields for slow transactions:
-  * hostname
-  * seconds_since_startup (larger memory increases and other other odd behavior more common when close to startup)
+* Add `ignore_traces` config option to ignore SlowTransactions from certain URIs.
 
 # 1.5.0
 

data/Rakefile

@@ -17,3 +17,8 @@ task :console do
   ARGV.clear
   IRB.start
 end
+
+# Rake Compiler
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('allocations')
+

data/lib/scout_apm.rb

@@ -87,6 +87,7 @@ require 'scout_apm/instruments/rails_router'
 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 'allocations'
 
 require 'scout_apm/app_server_load'
@@ -116,15 +117,18 @@ require 'scout_apm/store'
 require 'scout_apm/tracer'
 require 'scout_apm/context'
 require 'scout_apm/stackprof_tree_collapser'
+require 'scout_apm/instant_reporting'
 
 require 'scout_apm/metric_meta'
 require 'scout_apm/metric_stats'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/slow_job_record'
 require 'scout_apm/slow_item_set'
+require 'scout_apm/scored_item_set'
 require 'scout_apm/slow_request_policy'
 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'

data/lib/scout_apm/agent.rb

@@ -21,6 +21,12 @@ module ScoutApm
     attr_reader :slow_job_policy
     attr_reader :process_start_time # used when creating slow transactions to report how far from startup the transaction was recorded.
 
+    # Histogram of the cumulative requests since the start of the process
+    attr_reader :request_histograms
+
+    # Histogram of the requests since last reset. Reset by the sampler, so once per minutes.
+    attr_reader :request_histograms_resettable
+
     # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process.
     def self.instance(options = {})
       @@instance ||= self.new(options)
@@ -41,14 +47,15 @@ module ScoutApm
       # Later in initialization, we reset @config to include the file.
       @config = ScoutApm::Config.without_file
 
+      @slow_request_policy = ScoutApm::SlowRequestPolicy.new
       @slow_job_policy = ScoutApm::SlowJobPolicy.new
+      @request_histograms = ScoutApm::RequestHistograms.new
+      @request_histograms_resettable = ScoutApm::RequestHistograms.new
 
       @store          = ScoutApm::Store.new
       @layaway        = ScoutApm::Layaway.new
       @metric_lookup  = Hash.new
 
-      @slow_request_policy = ScoutApm::SlowRequestPolicy.new
-
       @capacity       = ScoutApm::Capacity.new
       @installed_instruments = []
     end
@@ -119,7 +126,8 @@ module ScoutApm
 
       @samplers = [
         ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors, logger),
-        ScoutApm::Instruments::Process::ProcessMemory.new(logger)
+        ScoutApm::Instruments::Process::ProcessMemory.new(logger),
+        ScoutApm::Instruments::PercentileSampler.new(logger, 95),
       ]
 
       app_server_load_hook
@@ -193,9 +201,11 @@ module ScoutApm
         store.write_to_layaway(layaway, :force)
       end
 
-      # Make sure we don't exit the process while the background worker is running its task.
-      logger.debug "Joining background worker thread"
-      @background_worker_thread.join if @background_worker_thread
+      # make sure we don't exit the process while the background worker is running its task. Bypass this step in development.
+      if environment.env != 'development'
+        logger.debug "Joining background worker thread"
+        @background_worker_thread.join if @background_worker_thread
+      end
     end
 
     def started?
@@ -308,8 +318,12 @@ module ScoutApm
     def run_samplers
       @samplers.each do |sampler|
         begin
-          result = sampler.run
-          store.track_one!(sampler.metric_type, sampler.metric_name, result) if result
+          if sampler.respond_to? :metrics
+            store.track!(sampler.metrics)
+          else
+            result = sampler.run
+            store.track_one!(sampler.metric_type, sampler.metric_name, result) if result
+          end
         rescue => e
           logger.info "Error reading #{sampler.human_name}"
           logger.debug e.message

data/lib/scout_apm/agent/reporting.rb

@@ -50,7 +50,7 @@ module ScoutApm
           :platform      => "ruby",
         }
 
-        log_deliver(metrics, slow_transactions, metadata)
+        log_deliver(metrics, slow_transactions, metadata, slow_jobs)
 
         payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs)
         logger.debug("Payload: #{payload}")
@@ -62,7 +62,7 @@ module ScoutApm
         logger.debug e.backtrace
       end
 
-      def log_deliver(metrics, slow_transactions, metadata)
+      def log_deliver(metrics, slow_transactions, metadata, jobs_traces)
         total_request_count = metrics.
           select { |meta,stats| meta.metric_name =~ /\AController/ }.
           inject(0) {|sum, (_, stat)| sum + stat.call_count }
@@ -75,7 +75,12 @@ module ScoutApm
                             "Recorded across (unknown) processes"
                           end
 
-        logger.info "[#{Time.parse(metadata[:agent_time]).strftime("%H:%M")}] Delivering #{metrics.length} Metrics for #{total_request_count} requests and #{slow_transactions.length} Slow Transaction Traces, #{process_log_str}."
+        time_clause       = "[#{Time.parse(metadata[:agent_time]).strftime("%H:%M")}]"
+        metrics_clause    = "#{metrics.length} Metrics for #{total_request_count} requests"
+        slow_trans_clause = "#{slow_transactions.length} Slow Transaction Traces"
+        job_clause        = "#{jobs_traces.length} Job Traces"
+
+        logger.info "#{time_clause} Delivering #{metrics_clause} and #{slow_trans_clause} and #{job_clause}, #{process_log_str}."
         logger.debug("Metrics: #{metrics.pretty_inspect}\nSlowTrans: #{slow_transactions.pretty_inspect}\nMetadata: #{metadata.inspect.pretty_inspect}")
       end
 

data/lib/scout_apm/attribute_arranger.rb

@@ -7,6 +7,10 @@ module ScoutApm
         case attribute
         when Array
           attribute_hash[attribute[0]] = subject.send(attribute[1])
+        when :bucket
+          attribute_hash[attribute] = subject.bucket_type
+        when :name
+          attribute_hash[attribute] = subject.bucket_name
         when Symbol
           attribute_hash[attribute] = subject.send(attribute)
         end

data/lib/scout_apm/bucket_name_splitter.rb

@@ -1,15 +1,15 @@
 module ScoutApm
   module BucketNameSplitter
-    def bucket
+    def bucket_type
       split_metric_name(metric_name).first
     end
 
-    def name
+    def bucket_name
       split_metric_name(metric_name).last
     end
 
     def key
-      {:bucket => bucket, :name => name}
+      {:bucket => bucket_type, :name => bucket_name}
     end
 
     private

data/lib/scout_apm/config.rb

@@ -7,14 +7,15 @@ require 'scout_apm/environment'
 #
 # application_root - override the detected directory of the application
 # data_file        - override the default temporary storage location. Must be a location in a writable directory
-# hostname         - override the default hostname detection. Default varies by environment - either system hostname, or PAAS hostname
+# host             - override the default hostname detection. Default varies by environment - either system hostname, or PAAS hostname
+# direct_host      - override the default "direct" host. The direct_host bypasses the ingestion pipeline and goes directly to the webserver, and is primarily used for features under development.
 # key              - the account key with Scout APM. Found in Settings in the Web UI
 # log_file_path    - either a directory or "STDOUT".
 # log_level        - DEBUG / INFO / WARN as usual
 # monitor          - true or false.  False prevents any instrumentation from starting
 # name             - override the name reported to APM. This is the name that shows in the Web UI
 # uri_reporting    - 'path' or 'full_path' default is 'full_path', which reports URL params as well as the path.
-# report_format    - 'json' or 'marshal'. Json is default, Marshal is deprecated
+# report_format    - 'json' or 'marshal'. Marshal is legacy and will be removed.
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -65,12 +66,14 @@ module ScoutApm
     class ConfigDefaults
       DEFAULTS = {
         'host'                   => 'https://checkin.scoutapp.com',
+        'direct_host'            => 'https://apm.scoutapp.com',
         'log_level'              => 'info',
         'stackprof_interval'     => 20000, # microseconds, 1000 = 1 millisecond, so 20k == 20 milliseconds
         'uri_reporting'          => 'full_path',
         'report_format'          => 'json',
         'disabled_instruments'   => [],
         'enable_background_jobs' => true,
+        'ignore_traces' => [],
       }.freeze
 
       def value(key)

data/lib/scout_apm/histogram.rb

@@ -56,6 +56,26 @@ module ScoutApm
       end
     end
 
+    # Given a value, where in this histogram does it fall?
+    # Returns a float between 0 and 1
+    def approximate_quantile_of_value(v)
+      mutex.synchronize do
+        return 100 if total == 0
+
+        count_examined = 0
+
+        bins.each_with_index do |bin, index|
+          if v <= bin.value
+            break
+          end
+
+          count_examined += bin.count
+        end
+
+        count_examined / total.to_f
+      end
+    end
+
     def mean
       mutex.synchronize do
         if total == 0

data/lib/scout_apm/instant_reporting.rb

@@ -0,0 +1,40 @@
+# InstantReporting is used when a specially flagged request hits the application.
+# The agent traces the request regardless of its performance characteristics, and reports it immediately to our servers, for instant feedback.
+# The request is detected in the ActionController instrumentation, and flagged in TrackedRequest. The trace is prepped here, and handed off to a Reporter for the actual POST.
+module ScoutApm
+  class InstantReporting
+    # trace is an instance of SlowTransaction
+    # instant_key is what was passed in from the browser to trigger the instant trace
+    def initialize(trace, instant_key)
+      @trace = trace
+      @instant_key = instant_key
+    end
+
+    def call
+      Thread.new do
+        # Serialize that trace. We reuse the PayloadSerializer, but only provide the metadata and traces.
+        # In this case, the traces array will always have just one element.
+        metadata = {
+            :app_root      => ScoutApm::Environment.instance.root.to_s,
+            :unique_id     => ScoutApm::Utils::UniqueId.simple,
+            :agent_version => ScoutApm::VERSION,
+            :agent_time    => Time.now.iso8601,
+            :agent_pid     => Process.pid,
+            :platform      => "ruby",
+        }
+
+        metrics = []
+        traces = [@trace]
+        jobs = []
+        slow_jobs = []
+
+        payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, traces, jobs, slow_jobs)
+
+        # Hand it off to the reporter for POST to our servers
+        reporter = Reporter.new(:instant_trace, config = Agent.instance.config, logger = Agent.instance.logger, instant_key = @instant_key)
+        reporter.report(payload, {'Content-Type' => 'application/json'} )
+      end
+    end
+
+  end
+end

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -61,8 +61,18 @@ module ScoutApm
         req = ScoutApm::RequestManager.lookup
         path = ScoutApm::Agent.instance.config.value("uri_reporting") == 'path' ? request.path : request.fullpath
         req.annotate_request(:uri => path)
-        req.context.add_user(:ip => request.remote_ip)
+
+        # IP Spoofing Protection can throw an exception, just move on w/o remote ip
+        req.context.add_user(:ip => request.remote_ip) rescue nil
+
         req.set_headers(request.headers)
+
+        # Check if this this request is to be reported instantly
+        if instant_key = request.cookies['scoutapminstant']
+          Agent.instance.logger.info "Instant trace request with key=#{instant_key} for path=#{path}"
+          req.instant_key = instant_key
+        end
+
         req.web!
 
         req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}") )

data/lib/scout_apm/instruments/percentile_sampler.rb

@@ -0,0 +1,38 @@
+module ScoutApm
+  module Instruments
+    class PercentileSampler
+      attr_reader :logger
+
+      attr_reader :percentiles
+
+      def initialize(logger, percentiles)
+        @logger = logger
+        @percentiles = Array(percentiles)
+      end
+
+      def human_name
+        "Percentiles"
+      end
+
+      def metrics
+        ms = {}
+
+        ScoutApm::Agent.instance.request_histograms_resettable.each_name do |name|
+          percentiles.each do |percentile|
+            meta = MetricMeta.new("Percentile/#{percentile}/#{name}")
+            stat = MetricStats.new
+            stat.update!(ScoutApm::Agent.instance.request_histograms_resettable.quantile(name, percentile))
+            ms[meta] = stat
+          end
+        end
+
+        # Wipe the histograms, get ready for the next minute's worth of data.
+        ScoutApm::Agent.instance.request_histograms_resettable.reset_all!
+
+        ms
+      end
+
+      private
+    end
+  end
+end

data/lib/scout_apm/layaway.rb

@@ -18,10 +18,7 @@ module ScoutApm
           new_req = new_val.request_count
           ScoutApm::Agent.instance.logger.debug("Merging Two reporting periods (#{old_val.timestamp.to_s}, #{new_val.timestamp.to_s}): old req #{old_req}, new req #{new_req}")
 
-          old_val.
-            merge_metrics!(new_val.metrics_payload).
-            merge_slow_transactions!(new_val.slow_transactions).
-            merge_jobs!(new_val.jobs)
+          old_val.merge(new_val)
         }
 
         ScoutApm::Agent.instance.logger.debug("AddReportingPeriod: AfterMerge Timestamps: #{existing_data.keys.map(&:to_s).inspect}")

data/lib/scout_apm/layaway_file.rb

@@ -2,8 +2,32 @@
 module ScoutApm
   class LayawayFile
     def path
-      ScoutApm::Agent.instance.config.value("data_file") ||
-        "#{ScoutApm::Agent.instance.default_log_path}/scout_apm.db"
+      return @path if @path
+
+      candidates = [
+        ScoutApm::Agent.instance.config.value("data_file"),
+        "#{ScoutApm::Agent.instance.default_log_path}/scout_apm.db",
+        "#{ScoutApm::Agent.instance.environment.root}/tmp/scout_apm.db"
+      ]
+
+      candidates.each do |candidate|
+        next if candidate.nil?
+
+        begin
+          ScoutApm::Agent.instance.logger.debug("Checking Layaway File Location: #{candidate}")
+          File.open(candidate, "w") { |f| } # Open & Close to check that we can
+
+          # No exception, it is valid
+          ScoutApm::Agent.instance.logger.info("Layaway File location found: #{candidate}")
+          @path = candidate
+          return @path
+        rescue Exception
+          ScoutApm::Agent.instance.logger.debug("Couldn't open layaway file for test write at #{candidate}")
+        end
+      end
+
+      ScoutApm::Agent.instance.logger.error("No valid layaway file found, please set a location in the configuration key `data_file`")
+      nil
     end
 
     def dump(object)

data/lib/scout_apm/layer.rb

@@ -40,7 +40,7 @@ module ScoutApm
     #   :class_name   - The ActiveRecord class name (From notification instantiation.active_record)
     attr_reader :annotations
 
-    BACKTRACE_CALLER_LIMIT = 30 # maximum number of lines to send thru for backtrace analysis
+    BACKTRACE_CALLER_LIMIT = 50 # maximum number of lines to send thru for backtrace analysis
 
     def initialize(type, name, start_time = Time.now)
       @type = type