scout_apm 2.6.10 → 3.0.0.pre0

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -2,7 +2,7 @@ module ScoutApm
   module Serializers
     module PayloadSerializerToJson
       class << self
-        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
+        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs)
           metadata.merge!({:payload_version => 2})
 
           jsonify_hash({:metadata => metadata,
@@ -10,12 +10,7 @@ module ScoutApm
                         :slow_transactions => rearrange_the_slow_transactions(slow_transactions),
                         :jobs => JobsSerializerToJson.new(jobs).as_json,
                         :slow_jobs => SlowJobsSerializerToJson.new(slow_jobs).as_json,
-                        :histograms => HistogramsSerializerToJson.new(histograms).as_json,
-                        :db_metrics => {
-                          :query => DbQuerySerializerToJson.new(db_query_metrics).as_json,
-                        },
-                        :span_traces => traces.map{ |t| t.as_json },
-          })
+                      })
         end
 
         # For the old style of metric serializing.
@@ -45,36 +40,18 @@ module ScoutApm
           "{#{str_parts.join(",")}}"
         end
 
-        # Ruby 1.8.7 seems to be fundamentally different in how gsub or regexes
-        # work. This is a hack and will be removed as soon as we can drop
-        # support
-        if RUBY_VERSION == "1.8.7"
-          ESCAPE_MAPPINGS = {
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-            '\\' => '\\\\',
-          }
-        else
-          ESCAPE_MAPPINGS = {
-            # Stackoverflow answer on gsub matches and backslashes - https://stackoverflow.com/a/4149087/2705125
-            '\\' => '\\\\\\\\',
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-          }
-        end
+        ESCAPE_MAPPINGS = {
+          "\b" => '\\b',
+          "\t" => '\\t',
+          "\n" => '\\n',
+          "\f" => '\\f',
+          "\r" => '\\r',
+          '"'  => '\\"',
+          '\\' => '\\\\',
+        }
 
         def escape(string)
-          ESCAPE_MAPPINGS.inject(string.to_s) {|s, (bad, good)| 
-            s.gsub(bad, good)
-          }
+          ESCAPE_MAPPINGS.inject(string.to_s) {|s, (bad, good)| s.gsub(bad, good) }
         end
 
         def format_by_type(formatee)
@@ -90,6 +67,10 @@ module ScoutApm
             %Q["#{formatee.iso8601}"]
           when nil
             "null"
+          when TrueClass
+            "true"
+          when FalseClass
+            "false"
           else # strings and everything
             %Q["#{escape(formatee)}"]
           end

data/lib/scout_apm/serializers/slow_jobs_serializer_to_json.rb

@@ -21,11 +21,9 @@ module ScoutApm
             "allocations" => job.allocations,
             "seconds_since_startup" => job.seconds_since_startup,
             "hostname" => job.hostname,
-            "git_sha" => job.git_sha,
             "metrics" => MetricsToJsonSerializer.new(job.metrics).as_json, # New style of metrics
             "allocation_metrics" => MetricsToJsonSerializer.new(job.allocation_metrics).as_json, # New style of metrics
             "context" => job.context.to_hash,
-            "truncated_metrics" => job.truncated_metrics,
 
             "score" => job.score,
           }
@@ -34,3 +32,4 @@ module ScoutApm
     end
   end
 end
+

data/lib/scout_apm/server_integrations/passenger.rb

@@ -29,7 +29,7 @@ module ScoutApm
         # This does run when a process stops.
         PhusionPassenger.on_event(:stopping_worker_process) do
           logger.debug "Passenger is stopping a worker process, shutting down the agent."
-          ScoutApm::Agent.instance.stop_background_worker
+          ScoutApm::Agent.instance.shutdown
         end
       end
 

data/lib/scout_apm/server_integrations/puma.rb

@@ -24,13 +24,10 @@ module ScoutApm
       end
 
       def install
-        old = ::Puma.cli_config.options[:before_worker_boot] || []
-        new = Array(old) + [Proc.new do
+        ::Puma.cli_config.options[:before_worker_boot] << Proc.new do
           logger.info "Installing Puma worker loop."
           ScoutApm::Agent.instance.start_background_worker
-        end]
-
-        ::Puma.cli_config.options[:before_worker_boot] = new
+        end
       rescue
         logger.warn "Unable to install Puma worker loop: #{$!.message}"
       end

data/lib/scout_apm/slow_job_policy.rb

@@ -17,10 +17,6 @@ module ScoutApm
     # Outliers are worth up to "1000ms" of weight
     POINT_MULTIPLIER_PERCENTILE = 1.0
 
-    # Points for an endpoint's who's throughput * response time is a large % of
-    # overall time spent processing requests
-    POINT_MULTIPLIER_PERCENT_TIME = 2.5
-
     # A hash of Job Names to the last time we stored a slow trace for it.
     #
     # Defaults to a start time that is pretty close to application boot time.
@@ -28,18 +24,14 @@ module ScoutApm
     # has been running.
     attr_reader :last_seen
 
-    # The AgentContext we're running in
-    attr_reader :context
-
-    def initialize(context)
-      @context = context
 
+    def initialize
       zero_time = Time.now
       @last_seen = Hash.new { |h, k| h[k] = zero_time }
     end
 
     def stored!(request)
-      last_seen[request.unique_name] = Time.now
+      last_seen[unique_name_for(request)] = Time.now
     end
 
     # Determine if this job trace should be fully analyzed by scoring it
@@ -62,15 +54,22 @@ module ScoutApm
       age = Time.now - last_seen[unique_name]
 
       # What approximate percentile was this request?
-      percentile = context.request_histograms.approximate_quantile_of_value(unique_name, total_time)
-
-      percent_of_total_time = context.transaction_time_consumed.percent_of_total(unique_name)
+      percentile = ScoutApm::Agent.instance.request_histograms.approximate_quantile_of_value(unique_name, total_time)
 
-      return speed_points(total_time) + percentile_points(percentile) + age_points(age) + percent_time_points(percent_of_total_time)
+      return speed_points(total_time) + percentile_points(percentile) + age_points(age)
     end
 
     private
 
+    def unique_name_for(request)
+      scope_layer = LayerConverters::ConverterBase.new(request).scope_layer
+      if scope_layer
+        scope_layer.legacy_metric_name
+      else
+        :unknown
+      end
+    end
+
     # Time in seconds
     # Logarithm keeps huge times from swamping the other metrics.
     # 1+ is necessary to keep the log function in positive territory.
@@ -96,16 +95,5 @@ module ScoutApm
     def age_points(age)
       age / 60.0 * POINT_MULTIPLIER_AGE
     end
-
-    # Of the total time spent handling endpoints in this app, if this endpoint
-    # is a higher percent, it should get more points.
-    #
-    # A: 20 calls @ 100ms each => 2 seconds of total time
-    # B: 10 calls @ 100ms each => 1 second of total time
-    #
-    # Then A is 66% of the total call time
-    def percent_time_points(percent) # Scale 0.0 - 1.0
-      percent * POINT_MULTIPLIER_PERCENT_TIME
-    end
   end
 end

data/lib/scout_apm/slow_job_record.rb

@@ -20,12 +20,8 @@ module ScoutApm
     attr_reader :hostname
     attr_reader :seconds_since_startup
     attr_reader :score
-    attr_reader :git_sha
-    attr_reader :truncated_metrics
 
-    attr_reader :span_trace
-
-    def initialize(agent_context, queue_name, job_name, time, total_time, exclusive_time, context, metrics, allocation_metrics, mem_delta, allocations, score, truncated_metrics, span_trace)
+    def initialize(queue_name, job_name, time, total_time, exclusive_time, context, metrics, allocation_metrics, mem_delta, allocations, score)
       @queue_name = queue_name
       @job_name = job_name
       @time = time
@@ -36,15 +32,10 @@ module ScoutApm
       @allocation_metrics = allocation_metrics
       @mem_delta = mem_delta
       @allocations = allocations
-      @seconds_since_startup = (Time.now - agent_context.process_start_time)
-      @hostname = agent_context.environment.hostname
-      @git_sha = agent_context.environment.git_revision.sha
+      @seconds_since_startup = (Time.now - ScoutApm::Agent.instance.process_start_time)
+      @hostname = ScoutApm::Environment.instance.hostname
       @score = score
-      @truncated_metrics = truncated_metrics
-
-      @span_trace = span_trace
-
-      agent_context.logger.debug { "Slow Job [#{metric_name}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta}"}
+      ScoutApm::Agent.instance.logger.debug { "Slow Job [#{metric_name}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta}"}
     end
 
     def metric_name

data/lib/scout_apm/slow_request_policy.rb

@@ -17,10 +17,6 @@ module ScoutApm
     # Outliers are worth up to "1000ms" of weight
     POINT_MULTIPLIER_PERCENTILE = 1.0
 
-    # Points for an endpoint's who's throughput * response time is a large % of
-    # overall time spent processing requests
-    POINT_MULTIPLIER_PERCENT_TIME = 2.5
-
     # A hash of Endpoint Name to the last time we stored a slow transaction for it.
     #
     # Defaults to a start time that is pretty close to application boot time.
@@ -28,18 +24,14 @@ module ScoutApm
     # has been running.
     attr_reader :last_seen
 
-    # The AgentContext we're running in
-    attr_reader :context
-
-    def initialize(context)
-      @context = context
 
+    def initialize
       zero_time = Time.now
       @last_seen = Hash.new { |h, k| h[k] = zero_time }
     end
 
     def stored!(request)
-      last_seen[request.unique_name] = Time.now
+      last_seen[unique_name_for(request)] = Time.now
     end
 
     # Determine if this request trace should be fully analyzed by scoring it
@@ -62,15 +54,22 @@ module ScoutApm
       age = Time.now - last_seen[unique_name]
 
       # What approximate percentile was this request?
-      percentile = context.request_histograms.approximate_quantile_of_value(unique_name, total_time)
-
-      percent_of_total_time = context.transaction_time_consumed.percent_of_total(unique_name)
+      percentile = ScoutApm::Agent.instance.request_histograms.approximate_quantile_of_value(unique_name, total_time)
 
-      return speed_points(total_time) + percentile_points(percentile) + age_points(age) + percent_time_points(percent_of_total_time)
+      return speed_points(total_time) + percentile_points(percentile) + age_points(age)
     end
 
     private
 
+    def unique_name_for(request)
+      scope_layer = LayerConverters::ConverterBase.new(request).scope_layer
+      if scope_layer
+        scope_layer.legacy_metric_name
+      else
+        :unknown
+      end
+    end
+
     # Time in seconds
     # Logarithm keeps huge times from swamping the other metrics.
     # 1+ is necessary to keep the log function in positive territory.
@@ -96,16 +95,5 @@ module ScoutApm
     def age_points(age)
       age / 60.0 * POINT_MULTIPLIER_AGE
     end
-
-    # Of the total time spent handling endpoints in this app, if this endpoint
-    # is a higher percent, it should get more points.
-    #
-    # A: 20 calls @ 100ms each => 2 seconds of total time
-    # B: 10 calls @ 100ms each => 1 second of total time
-    #
-    # Then A is 66% of the total call time
-    def percent_time_points(percent) # Scale 0.0 - 1.0
-      percent * POINT_MULTIPLIER_PERCENT_TIME
-    end
   end
 end

data/lib/scout_apm/slow_transaction.rb

@@ -13,14 +13,10 @@ module ScoutApm
     attr_reader :prof
     attr_reader :mem_delta
     attr_reader :allocations
-    attr_reader :span_trace
     attr_accessor :hostname # hack - we need to reset these server side.
     attr_accessor :seconds_since_startup # hack - we need to reset these server side.
-    attr_accessor :git_sha # hack - we need to reset these server side.
 
-    attr_reader :truncated_metrics # True/False that says if we had to truncate the metrics of this trace
-
-    def initialize(agent_context, uri, metric_name, total_call_time, metrics, allocation_metrics, context, time, raw_stackprof, mem_delta, allocations, score, truncated_metrics, span_trace)
+    def initialize(uri, metric_name, total_call_time, metrics, allocation_metrics, context, time, raw_stackprof, mem_delta, allocations, score)
       @uri = uri
       @metric_name = metric_name
       @total_call_time = total_call_time
@@ -31,14 +27,10 @@ module ScoutApm
       @prof = []
       @mem_delta = mem_delta
       @allocations = allocations
-      @seconds_since_startup = (Time.now - agent_context.process_start_time)
-      @hostname = agent_context.environment.hostname
+      @seconds_since_startup = (Time.now - ScoutApm::Agent.instance.process_start_time)
+      @hostname = ScoutApm::Environment.instance.hostname
       @score = score
-      @git_sha = agent_context.environment.git_revision.sha
-      @truncated_metrics = truncated_metrics
-      @span_trace = span_trace
-
-      agent_context.logger.debug { "Slow Request [#{uri}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta} Score: #{score}"}
+      ScoutApm::Agent.instance.logger.debug { "Slow Request [#{uri}] - Call Time: #{total_call_time} Mem Delta: #{mem_delta} Score: #{score}"}
     end
 
     # Used to remove metrics when the payload will be too large.
@@ -52,19 +44,7 @@ module ScoutApm
     end
 
     def as_json
-      json_attributes = [:key,
-                         :time,
-                         :total_call_time,
-                         :uri,
-                         [:context, :context_hash],
-                         :score,
-                         :prof,
-                         :mem_delta,
-                         :allocations,
-                         :seconds_since_startup,
-                         :hostname,
-                         :git_sha,
-                         :truncated_metrics]
+      json_attributes = [:key, :time, :total_call_time, :uri, [:context, :context_hash], :score, :prof, :mem_delta, :allocations, :seconds_since_startup, :hostname]
       ScoutApm::AttributeArranger.call(self, json_attributes)
     end
 

data/lib/scout_apm/store.rb

@@ -3,52 +3,30 @@
 # the layaway file for cross-process aggregation.
 module ScoutApm
   class Store
-    def initialize(context)
-      @context = context
-      @mutex = Monitor.new
-      @reporting_periods = Hash.new { |h,k|
-        @mutex.synchronize { h[k] = StoreReportingPeriod.new(k, @context) }
-      }
+    # A hash of reporting periods. { StoreReportingPeriodTimestamp => StoreReportingPeriod }
+    attr_reader :reporting_periods
+
+    # Used to pull metrics into each reporting period, as that reporting period is finished.
+    attr_reader :samplers
+
+    def initialize
+      @mutex = Mutex.new
+      @reporting_periods = Hash.new { |h,k| h[k] = StoreReportingPeriod.new(k) }
       @samplers = []
     end
 
     def current_timestamp
-      StoreReportingPeriodTimestamp.new(Time.now)
+      StoreReportingPeriodTimestamp.new
     end
 
     def current_period
-      @reporting_periods[current_timestamp]
-    end
-    private :current_period
-
-    def find_period(timestamp = nil)
-      if timestamp
-        @reporting_periods[timestamp]
-      else
-        current_period
-      end
+      reporting_periods[current_timestamp]
     end
-    private :find_period
 
     # Save newly collected metrics
     def track!(metrics, options={})
       @mutex.synchronize {
-        period = find_period(options[:timestamp])
-        period.absorb_metrics!(metrics)
-      }
-    end
-
-    def track_histograms!(histograms, options={})
-      @mutex.synchronize {
-        period = find_period(options[:timestamp])
-        period.merge_histograms!(histograms)
-      }
-    end
-
-    def track_db_query_metrics!(db_query_metric_set, options={})
-      @mutex.synchronize {
-        period = find_period(options[:timestamp])
-        period.merge_db_query_metrics!(db_query_metric_set)
+        current_period.absorb_metrics!(metrics)
       }
     end
 
@@ -87,56 +65,41 @@ module ScoutApm
     # current-minute metrics.  Useful when we are shutting down the agent
     # during a restart.
     def write_to_layaway(layaway, force=false)
-      logger.debug("Writing to layaway#{" (Forced)" if force}")
+      ScoutApm::Agent.instance.logger.debug("Writing to layaway#{" (Forced)" if force}")
 
-      to_report = @mutex.synchronize {
-        @reporting_periods.select { |time, rp|
-          force || (time.timestamp < current_timestamp.timestamp)
-        }
+      @mutex.synchronize {
+        reporting_periods.select { |time, rp| force || time.timestamp < current_timestamp.timestamp}.
+                          each   { |time, rp| write_reporting_period(layaway, time, rp) }
       }
-
-      to_report.each { |time, rp| write_reporting_period(layaway, time, rp) }
-    end
-
-    # For each tick (minute), be sure we have a reporting period, and that samplers are run for it.
-    def tick!
-      rp = current_period
-      collect_samplers(rp)
     end
 
     def write_reporting_period(layaway, time, rp)
-        layaway.write_reporting_period(rp)
+      collect_samplers(rp)
+      layaway.write_reporting_period(rp)
     rescue => e
-      logger.warn("Failed writing data to layaway file: #{e.message} / #{e.backtrace}")
+      ScoutApm::Agent.instance.logger.warn("Failed writing data to layaway file: #{e.message} / #{e.backtrace}")
     ensure
-      logger.debug("Before delete, reporting periods length: #{@reporting_periods.size}")
-      deleted_items = @mutex.synchronize { @reporting_periods.delete(time) }
-      logger.debug("After delete, reporting periods length: #{@reporting_periods.size}. Did delete #{deleted_items}")
+      reporting_periods.delete(time)
     end
-    private :write_reporting_period
 
     ######################################
     # Sampler support
-    def add_sampler(sampler_klass)
-      @samplers << sampler_klass.new(@context)
+    def add_sampler(sampler)
+      @samplers << sampler
     end
 
     def collect_samplers(rp)
       @samplers.each do |sampler|
         begin
-          sampler.metrics(rp.timestamp, self)
+          metrics = sampler.metrics(rp.timestamp)
+          rp.absorb_metrics!(metrics)
         rescue => e
-          logger.info "Error reading #{sampler.human_name} for period: #{rp}"
-          logger.debug "#{e.message}\n\t#{e.backtrace.join("\n\t")}"
+          ScoutApm::Agent.instance.logger.info "Error reading #{sampler.human_name} for period: #{rp}"
+          ScoutApm::Agent.instance.logger.debug e.message
+          ScoutApm::Agent.instance.logger.debug e.backtrace.join("\n")
         end
       end
     end
-    private :collect_samplers
-
-    def logger
-      @context.logger
-    end
-    private :logger
   end
 
   # A timestamp, normalized to the beginning of a minute. Used as a hash key to
@@ -189,34 +152,26 @@ module ScoutApm
 
   # One period of Storage. Typically 1 minute
   class StoreReportingPeriod
+
     # A ScoredItemSet holding the "best" traces for the period
     attr_reader :request_traces
 
     # A ScoredItemSet holding the "best" traces for the period
     attr_reader :job_traces
 
-    # An Array of HistogramsReport
-    attr_reader :histograms
-
     # A StoreReportingPeriodTimestamp representing the time that this
     # collection of metrics is for
     attr_reader :timestamp
 
     attr_reader :metric_set
 
-    attr_reader :db_query_metric_set
-
-    def initialize(timestamp, context)
+    def initialize(timestamp)
       @timestamp = timestamp
 
-      @request_traces = ScoredItemSet.new(context.config.value('max_traces'))
-      @job_traces = ScoredItemSet.new(context.config.value('max_traces'))
-
-      @histograms = []
+      @request_traces = ScoredItemSet.new
+      @job_traces = ScoredItemSet.new
 
       @metric_set = MetricSet.new
-      @db_query_metric_set = DbQueryMetricSet.new(context)
-
       @jobs = Hash.new
     end
 
@@ -226,9 +181,7 @@ module ScoutApm
         merge_metrics!(other.metric_set).
         merge_slow_transactions!(other.slow_transactions_payload).
         merge_jobs!(other.jobs).
-        merge_slow_jobs!(other.slow_jobs_payload).
-        merge_histograms!(other.histograms).
-        merge_db_query_metrics!(other.db_query_metric_set)
+        merge_slow_jobs!(other.slow_jobs_payload)
       self
     end
 
@@ -249,11 +202,6 @@ module ScoutApm
       self
     end
 
-    def merge_db_query_metrics!(other_metric_set)
-      db_query_metric_set.combine!(other_metric_set)
-      self
-    end
-
     def merge_slow_transactions!(new_transactions)
       Array(new_transactions).each do |one_transaction|
         request_traces << one_transaction
@@ -282,17 +230,6 @@ module ScoutApm
       self
     end
 
-    def merge_histograms!(new_histograms)
-      new_histograms = Array(new_histograms)
-      @histograms = (histograms + new_histograms).
-        group_by { |histo| histo.name }.
-        map { |(_, histos)|
-          histos.inject { |merged, histo| merged.combine!(histo) }
-        }
-
-      self
-    end
-
     #################################
     # Retrieve Metrics for reporting
     #################################
@@ -312,10 +249,6 @@ module ScoutApm
       job_traces.to_a
     end
 
-    def db_query_metrics_payload
-      db_query_metric_set.metrics_to_report
-    end
-
     #################################
     # Debug Helpers
     #################################