scout_apm 2.6.10 → 3.0.0.pre0

data/lib/scout_apm/background_recorder.rb

@@ -1,48 +0,0 @@
-# Provide a background thread queue to do the processing of
-# TrackedRequest objects, to remove it from the hot-path of returning a
-# web response
-
-module ScoutApm
-  class BackgroundRecorder
-    attr_reader :context
-
-    attr_reader :queue
-    attr_reader :thread
-
-    def initialize(context)
-      @context = context
-      @queue = Queue.new
-    end
-
-    def logger
-      context.logger
-    end
-
-    def start
-      logger.info("Starting BackgroundRecorder")
-      @thread = Thread.new(&method(:thread_func))
-      self
-    end
-
-    def stop
-      @thread.kill
-    end
-
-    def record!(request)
-      start unless @thread.alive?
-      @queue.push(request)
-    end
-
-    def thread_func
-      while req = queue.pop
-        begin
-          logger.debug("recording in thread. Queue size: #{queue.size}")
-          # For now, just proxy right back into the TrackedRequest object's record function
-          req.record!
-        rescue => e
-          logger.warn("Error in BackgroundRecorder - #{e.message} : #{e.backtrace}")
-        end
-      end
-    end
-  end
-end

data/lib/scout_apm/db_query_metric_set.rb

@@ -1,97 +0,0 @@
-# Note, this class must be Marshal Dumpable
-module ScoutApm
-  class DbQueryMetricSet
-    include Enumerable
-
-    attr_reader :metrics # the raw metrics. You probably want #metrics_to_report
-
-    def marshal_dump
-      [ @metrics ]
-    end
-
-    def marshal_load(array)
-      @metrics = array.first
-      @context = ScoutApm::Agent.instance.context
-    end
-
-    def initialize(context)
-      @context = context
-
-      # A hash of DbQueryMetricStats values, keyed by DbQueryMetricStats.key
-      @metrics = Hash.new
-    end
-
-    # Need to look this up again if we end up as nil. Which I guess can happen
-    # after a Marshal load?
-    def context
-      @context ||= ScoutApm::Agent.instance.context
-    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 = context.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 ||= context.config.value('database_metric_limit')
-      metrics.size >= @limit
-    end
-
-  end
-end

data/lib/scout_apm/db_query_metric_stats.rb

@@ -1,102 +0,0 @@
-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/debug.rb

@@ -1,37 +0,0 @@
-module ScoutApm
-  class Debug
-    # see self.instance
-    @@instance = nil
-
-    def self.instance
-      @@instance ||= new
-    end
-
-    def register_periodic_hook(&hook)
-      @periodic_hooks << hook
-    end
-
-    def call_periodic_hooks
-      @periodic_hooks.each do |hook|
-        begin
-          hook.call
-        rescue => e
-          logger.info("Periodic debug hook failed to run: #{e}\n\t#{e.backtrace.join("\n\t")}")
-        end
-      end
-    rescue
-      # Something went super wrong for the inner rescue to not catch this. Just
-      # swallow the error. The debug tool should never crash the app.
-    end
-
-    private
-
-    def initialize
-      @periodic_hooks = []
-    end
-
-    def logger
-      ScoutApm::Agent.instance.context.logger
-    end
-  end
-end

data/lib/scout_apm/detailed_trace.rb

@@ -1,217 +0,0 @@
-# DetailedTrace contains all details about a certain transaction, spans with
-# start & stop times, tags, etc.
-
-# {
-# "version": 1,
-# "identity": {
-#   "transaction_id": "req-....",
-#   "revision": "abcdef",
-#   "start_instant": "01-01-01T00:00:00.0000Z",
-#   "stop_instant": "01-01-01T00:00:01.0000Z",
-#   "type": "Web",
-#   "naming": {
-#     "path": "/users",
-#     "code": "UsersController#index",
-#   },
-#   "score": {
-#     "total": 10.5,
-#     "percentile": 4.5,
-#     "age": 2.0,
-#     "memory_delta": 3,
-#     "allocations": 1
-#   }
-# },
-#
-# "tags": {
-#   "allocations": 1000
-# },
-#
-# "spans": [
-#   ...
-# ]
-
-class DetailedTrace
-  attr_reader :spans
-  attr_reader :tags
-
-  attr_reader :transaction_id
-  attr_reader :revision
-  attr_reader :start_instant
-  attr_reader :stop_instant
-  attr_reader :duration
-  attr_reader :type # "Web" or "Job"
-  attr_reader :host
-
-  attr_reader :path # /users/1
-  attr_reader :code # UsersController#show or similar
-
-  attr_reader :total_score
-  attr_reader :percentile_score
-  attr_reader :age_score
-  attr_reader :memory_delta_score
-  attr_reader :memory_allocations_score
-
-  VERSION = 1
-
-  def initialize(transaction_id, revision, host, start_instant, stop_instant, type, path, code, spans, tags)
-    @spans = spans
-    @tags = DetailedTraceTags(tags)
-
-    @transaction_id = transaction_id
-    @revision = revision
-    @host = host
-    @start_instant = start_instant
-    @stop_instant = stop_instant
-    @type = type
-
-    @path = path
-    @code = code
-
-    @total_score = 0
-    @percentile_score = 0
-    @age_score = 0
-    @memory_delta_score = 0
-    @memory_allocations_score = 0
-
-  end
-
-  def as_json(*)
-    {
-      :version => VERSION,
-      :identity => {
-        :transaction_id => transaction_id,
-        :revision => revision,
-        :host => host,
-        :start_instant => start_instant.iso8601(6),
-        :stop_instant => stop_instant.iso8601(6),
-        :type => type,
-        :naming => {
-          :path => path,
-          :code => code,
-        },
-        :score => {
-          :total => total_score,
-          :percentile => percentile_score,
-          :age => age_score,
-          :memory_delta => memory_delta_score,
-          :allocations => memory_allocations_score,
-        }
-      },
-      :tags => tags.as_json,
-      :spans => spans.map{|span| span.as_json},
-    }
-  end
-
-  ########################
-  # Scorable interface
-  #
-  # Needed so we can merge ScoredItemSet instances
-  def call
-    self
-  end
-
-  def name
-    code
-  end
-
-  def score
-    @total_score
-  end
-
-end
-
-##########
-#  SPAN  #
-##########
-
-#
-# {
-#   "type": "Standard",
-#   "identity": {
-#     "id": "....",
-#     "parent_id": "....",
-#     "start_time": "01-01-01T00:00:00.0000Z",
-#     "stop_time": "01-01-01T00:00:00.0001Z",
-#     "operation": "SQL/User/find"
-#   },
-#   "tags": {
-#     "allocations": 1000,
-#     "db.statement": "SELECT * FROM users where id = 1",
-#     "db.rows": 1,
-#     "backtrace": [ {
-#       "file": "app/controllers/users_controller.rb",
-#       "line": 10,
-#       "function": "index"
-#     } ]
-#   }
-class DetailedTraceSpan
-  attr_reader :tags
-
-  attr_reader :span_type
-  attr_reader :span_id, :parent_id
-  attr_reader :start_instant, :stop_instant
-
-  # What is the "name" of this span.
-  #
-  # Examples:
-  #   SQL/User/find
-  #   Controller/Users/index
-  #   HTTP/GET/example.com
-  attr_reader :operation
-
-  def initialize(span_id, parent_id, start_instant, stop_instant, operation, tags)
-    # This will be dynamic when we implement limited spans
-    @span_type = "Standard"
-
-    @span_id = span_id
-    @parent_id = parent_id
-
-    @start_instant = start_instant
-    @stop_instant = stop_instant
-    @operation = operation
-    @tags = DetailedTraceTags(tags)
-  end
-
-  def as_json(*)
-    {
-      :type => @span_type,
-      :identity => {
-        :id => span_id,
-        :parent_id => parent_id,
-        :start_instant => start_instant.iso8601(6),
-        :stop_instant => stop_instant.iso8601(6),
-        :operation => operation,
-      },
-      :tags => @tags.as_json,
-    }
-  end
-end
-
-
-#############
-#  content  #
-#############
-
-# Tags for either a request, or a span
-class DetailedTraceTags
-  attr_reader :tags
-
-  def initialize(hash)
-    @tags = hash
-  end
-
-  # @tags is already a hash, so no conversion needed
-  def as_json(*)
-    @tags
-  end
-end
-
-# Converter function to turn an input into a DetailedTraceTags object
-def DetailedTraceTags(arg)
-  if DetailedTraceTags === arg
-    arg
-  elsif Hash === arg
-    DetailedTraceTags.new(arg)
-  end
-end
-

data/lib/scout_apm/error.rb

@@ -1,27 +0,0 @@
-# Public API for the Scout Error Monitoring service
-#
-# See-Also ScoutApm::Transaction and ScoutApm::Tracing for APM related APIs
-module ScoutApm
-  module Error
-    # Capture an exception, optionally with an environment hash. This may be a
-    # Rack environment, but is not required.
-    def self.capture(exception, env={})
-      context = ScoutApm::Agent.instance.context
-
-      # Skip if error monitoring isn't enabled at all
-      if ! context.config.value("errors_enabled")
-        return false
-      end
-
-      # Skip if this one error is ignored
-      if context.ignored_exceptions.ignored?(exception)
-        return false
-      end
-
-      # Capture the error for further processing and shipping
-      context.error_buffer.capture(exception, env)
-
-      return true
-    end
-  end
-end

data/lib/scout_apm/error_service/error_buffer.rb

@@ -1,39 +0,0 @@
-# Holds onto exceptions, and moves them forward to shipping when appropriate
-module ScoutApm
-  module ErrorService
-    class ErrorBuffer
-      include Enumerable
-
-      attr_reader :agent_context
-
-      def initialize(agent_context)
-        @agent_context = agent_context
-        @error_records = []
-        @mutex = Monitor.new
-      end
-
-      def capture(exception, env)
-        context = ScoutApm::Context.current
-
-        @mutex.synchronize {
-          @error_records << ErrorRecord.new(agent_context, exception, env, context)
-        }
-      end
-
-      def get_and_reset_error_records
-        @mutex.synchronize {
-          ret = @error_records
-          @error_records = []
-          ret
-        }
-      end
-
-      # Enables enumerable - for count and each and similar methods
-      def each
-        @error_records.each do |error_record|
-          yield error_record
-        end
-      end
-    end
-  end
-end