scout_apm 2.6.10 → 3.0.0.pre0

data/lib/scout_apm/remote/server.rb

@@ -1,60 +0,0 @@
-# Web Server bound to localhost that listens for remote agent reports. Forwards
-# onto the router
-module ScoutApm
-  module Remote
-    class Server
-      attr_reader :router
-      attr_reader :bind
-      attr_reader :port
-      attr_reader :logger
-
-      def initialize(bind, port, router, logger)
-        @router = router
-        @logger = logger
-        @bind = bind
-        @port = port
-        @server = nil
-      end
-
-      def start
-        require 'webrick'
-
-        @server = WEBrick::HTTPServer.new(
-          :BindAddress => bind,
-          :Port => port,
-          :AccessLog => [],
-          :Logger => @logger
-        )
-
-        @server.mount_proc '/' do |request, response|
-          router.handle(request.body)
-
-          # arbitrary response, client doesn't expect anything in particular
-          response.body = 'Ok'
-        end
-
-        @thread = Thread.new do
-          begin
-            logger.debug("Remote: Starting Server on #{bind}:#{port}")
-
-            @server.start
-
-            logger.debug("Remote: Server returned after #start call, thread exiting")
-          rescue => e
-            logger.debug("Remote: Server Exception, #{e},\n#{e.backtrace.join("\n\t")}")
-          end
-        end
-      end
-
-      def running?
-        @thread.alive?
-        @server && @server.status == :Running
-      end
-
-      def stop
-        @server.stop
-        @thread.kill
-      end
-    end
-  end
-end

data/lib/scout_apm/reporting.rb

@@ -1,143 +0,0 @@
-# Methods related to sending metrics to scoutapp.com.
-module ScoutApm
-  class Reporting
-    attr_reader :context
-
-    def initialize(context)
-      @context = context
-    end
-
-    def logger
-      context.logger
-    end
-
-    def reporter
-      @reporter ||= ScoutApm::Reporter.new(context, :checkin)
-    end
-
-    # The data moves through a treadmill of reporting, coordinating several Rails processes by using an external file.
-    # * During the minute it is being recorded by the instruments, it gets
-    #   recorded into the ram of each process (in the Store class).
-    # * The minute after, each process writes its own metrics to a shared LayawayFile
-    # * The minute after that, the first process to wake up pushes the combined
-    #   data to the server, and wipes it. Next processes don't have anything to do.
-    #
-    # At any given point, there is data in each of those steps, moving its way through the process
-    def process_metrics
-      # Do any per-minute work necessary for the store
-      context.store.tick!
-
-      # Write the previous minute's data to the shared-across-process layaway file.
-      context.store.write_to_layaway(context.layaway)
-
-      # Attempt to send 2 minutes ago's data up to the server.  This
-      # only acctually occurs if this process is the first to wake up this
-      # minute.
-      report_to_server
-    end
-
-    # In a running app, one process will get the period ready for delivery, the others will see 0.
-    def report_to_server
-      period_to_report = ScoutApm::StoreReportingPeriodTimestamp.minutes_ago(2)
-
-      logger.debug("Attempting to claim #{period_to_report.to_s}")
-
-      did_write = context.layaway.with_claim(period_to_report) do |rps|
-        logger.debug("Succeeded claiming #{period_to_report.to_s}")
-
-        begin
-          merged = rps.inject { |memo, rp| memo.merge(rp) }
-          logger.debug("Merged #{rps.length} reporting periods, delivering")
-          metadata = metadata(merged)
-          deliver_period(merged,metadata)
-          context.extensions.run_periodic_callbacks(merged, metadata)
-          true
-        rescue => e
-          logger.debug("Error merging reporting periods #{e.message}")
-          logger.debug("Error merging reporting periods #{e.backtrace}")
-          false
-        end
-
-      end
-
-      if !did_write
-        logger.debug("Failed to obtain claim for #{period_to_report.to_s}")
-      end
-    end
-
-    def metadata(reporting_period)
-      {
-        :app_root      => context.environment.root.to_s,
-        :unique_id     => ScoutApm::Utils::UniqueId.simple,
-        :agent_version => ScoutApm::VERSION,
-        :agent_time    => reporting_period.timestamp.to_s,
-        :agent_pid     => Process.pid,
-        :platform      => "ruby",
-      }
-    end
-
-    def deliver_period(reporting_period,metadata)
-      metrics = reporting_period.metrics_payload
-      slow_transactions = reporting_period.slow_transactions_payload
-      jobs = reporting_period.jobs
-      slow_jobs = reporting_period.slow_jobs_payload
-      histograms = reporting_period.histograms
-      db_query_metrics = reporting_period.db_query_metrics_payload
-      traces = (slow_transactions.map(&:span_trace) + slow_jobs.map(&:span_trace)).compact
-
-      log_deliver(metrics, slow_transactions, metadata, slow_jobs, histograms)
-
-      payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
-      logger.debug("Sending payload w/ Headers: #{headers.inspect}")
-
-      reporter.report(payload, headers)
-    rescue => e
-      logger.warn "Error on checkin"
-      logger.info e.message
-      logger.debug e.backtrace
-    end
-
-    def log_deliver(metrics, slow_transactions, metadata, jobs_traces, histograms)
-      total_request_count = metrics.
-        select { |meta,stats| meta.metric_name =~ /\AController/ }.
-        inject(0) {|sum, (_, stat)| sum + stat.call_count }
-
-      memory = metrics.
-        find {|meta,stats| meta.metric_name =~ /\AMemory/ }
-      process_log_str = if memory
-                          "Recorded from #{memory.last.call_count} processes"
-                        else
-                          "Recorded across (unknown) processes"
-                        end
-
-      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"
-      histogram_clause  = "#{histograms.length} Histograms"
-
-      logger.info "#{time_clause} Delivering #{metrics_clause} and #{slow_trans_clause} and #{job_clause}, #{process_log_str}."
-      logger.debug("\n\nMetrics: #{metrics.pretty_inspect}\nSlowTrans: #{slow_transactions.pretty_inspect}\nMetadata: #{metadata.inspect.pretty_inspect}\n\n")
-    end
-
-    # TODO: Move this into PayloadSerializer?
-    # XXX: Remove non-json report format entirely
-    def headers
-      if ScoutApm::Agent.instance.context.config.value("report_format") == 'json'
-        headers = {'Content-Type' => 'application/json'}
-      else
-        headers = {}
-      end
-    end
-
-    # Before reporting, lookup metric_id for each MetricMeta. This speeds up
-    # reporting on the server-side.
-    def add_metric_ids(metrics)
-      metrics.each do |meta,stats|
-        if metric_id = metric_lookup[meta]
-          meta.metric_id = metric_id
-        end
-      end
-    end
-  end
-end

data/lib/scout_apm/serializers/db_query_serializer_to_json.rb

@@ -1,15 +0,0 @@
-module ScoutApm
-  module Serializers
-    class DbQuerySerializerToJson
-      attr_reader :db_query_metrics
-
-      def initialize(db_query_metrics)
-        @db_query_metrics = db_query_metrics
-      end
-
-      def as_json
-        db_query_metrics.map{|metric| metric.as_json }
-      end
-    end
-  end
-end

data/lib/scout_apm/serializers/histograms_serializer_to_json.rb

@@ -1,21 +0,0 @@
-
-module ScoutApm
-  module Serializers
-    class HistogramsSerializerToJson
-      attr_reader :histograms
-
-      def initialize(histograms)
-        @histograms = histograms
-      end
-
-      def as_json
-        histograms.map do |histo|
-          {
-            "name" => histo.name,
-            "histogram" => histo.histogram.as_json,
-          }
-        end
-      end
-    end
-  end
-end

data/lib/scout_apm/synchronous_recorder.rb

@@ -1,30 +0,0 @@
-# Provide a synchronous approach to recording TrackedRequests
-# Doesn't attempt to background the work, or do it elsewhere. It happens
-# inline, in the caller thread right when record! is called
-
-module ScoutApm
-  class SynchronousRecorder
-    attr_reader :context
-
-    def initialize(context)
-      @context = context
-    end
-
-    def logger
-      context.logger
-    end
-
-    def start
-      # nothing to do
-      self
-    end
-
-    def stop
-      # nothing to do
-    end
-
-    def record!(request)
-      request.record!
-    end
-  end
-end

data/lib/scout_apm/tasks/doctor.rb

@@ -1,75 +0,0 @@
-module ScoutApm
-  module Tasks
-    class Doctor
-      def self.run!
-        new.run!
-      end
-
-      def initialize()
-      end
-
-      def run!
-        puts "Scout Doctor"
-        puts "============"
-        puts
-        puts "Detected App Server: #{agent_context.environment.app_server_integration.name}"
-        # puts "Detected Background Job: #{agent_context.environment.background_job_integration.name}"
-        puts
-        puts "Instruments:"
-        puts "----------------------------------------"
-        puts installed_instruments
-        puts
-        puts
-        puts "Configuration Settings:"
-        puts "-------------|------------------------------|-------"
-        puts "    From     |             Key              | Value "
-        puts "-------------|------------------------------|-------"
-        puts configuration_settings
-        puts
-        puts
-        puts "Misc:"
-        puts "---------------"
-        puts "Layaway Files stored at: #{agent_context.layaway.directory}"
-        puts "Logs stored at: #{log_details}"
-
-      end
-
-      def agent_context
-        ScoutApm::Agent.instance.context
-      end
-
-      def installed_instruments
-        ScoutApm::Agent.
-          instance.
-          instrument_manager.
-          installed_instruments.
-          map{|instance| "#{instance.installed? ? "Installed    " : "Not Installed"} - #{instance.class.to_s}"}.
-          join("\n")
-      end
-
-      def configuration_settings
-        all_settings = agent_context.config.all_settings
-
-        longest_key = all_settings.
-          map{|setting| setting[:key] }.
-          inject(0) { |len, key| key.length > len ? key.length : len }
-
-        format_string = "%12s | %-#{longest_key}s | %s"
-
-        all_settings.
-          map{|setting| sprintf format_string, setting[:source], setting[:key], setting[:value]}.
-          join("\n")
-      end
-
-      def log_details
-        if agent_context.logger.log_destination == STDOUT
-          "STDOUT"
-        elsif agent_context.logger.log_destination == STDERR
-          "STDERR"
-        else
-          "#{agent_context.logger.log_file_path}"
-        end
-      end
-    end
-  end
-end

data/lib/scout_apm/tasks/support.rb

@@ -1,22 +0,0 @@
-module ScoutApm
-  module Tasks
-    class Support
-      def self.run!
-        puts "Support Task"
-        new.run!
-      end
-
-      def initialize
-        @doctor = ScoutApm::Tasks::Doctor.new
-      end
-
-      def run!
-        instruments = @doctor.installed_instruments
-        config = @doctor.configuration_settings
-        collect_logs
-
-        post_data
-      end
-    end
-  end
-end

data/lib/scout_apm/transaction.rb

@@ -1,13 +0,0 @@
-module ScoutApm
-  module Transaction
-    # Ignores the current request
-    def self.ignore!
-      ::ScoutApm::RequestManager.lookup.ignore_request!
-    end
-
-    # Renames the last Controller or Job layer
-    def self.rename(name)
-      ::ScoutApm::RequestManager.lookup.name_override = name
-    end
-  end
-end

data/lib/scout_apm/transaction_time_consumed.rb

@@ -1,51 +0,0 @@
-module ScoutApm
-  class TransactionTimeConsumed
-    # Private Accessor:
-    # A hash of Endpoint Name to an time consumed record
-    attr_reader :endpoints
-    private :endpoints
-
-    # Private Accessor:
-    # The total time spent across all endpoints
-    attr_reader :total_duration
-    private :total_duration
-
-    def initialize
-      @total_duration = 0.0
-      @endpoints = Hash.new { |h, k| h[k] = TotalTimeRecord.new }
-    end
-
-    def add(item, duration)
-      @total_duration += duration.to_f
-      @endpoints[item].add(duration.to_f)
-    end
-
-    def percent_of_total(item)
-      if total_duration == 0.0
-        0
-      else
-        @endpoints[item].total_duration / total_duration
-      end
-    end
-
-    def total_time_for(item)
-      @endpoints[item].total_duration
-    end
-
-    def call_count_for(item)
-      @endpoints[item].count
-    end
-
-    # Time is in seconds
-    TotalTimeRecord = Struct.new(:total_duration, :count) do
-      def initialize
-        super(0, 0)
-      end
-
-      def add(duration)
-        self.total_duration += duration.to_f
-        self.count += 1
-      end
-    end
-  end
-end

data/lib/scout_apm/utils/gzip_helper.rb

@@ -1,24 +0,0 @@
-module ScoutApm
-  module Utils
-    # A simple wrapper around Ruby's built-in gzip support.
-    class GzipHelper
-      DEFAULT_GZIP_LEVEL = 5
-
-      attr_reader :level
-
-      def initialize(level = DEFAULT_GZIP_LEVEL)
-        @level = level
-      end
-
-      def deflate(str)
-        strio = StringIO.new
-
-        gz = Zlib::GzipWriter.new(strio, level)
-        gz.write str
-        gz.close
-
-        strio.string
-      end
-    end
-  end
-end

data/lib/scout_apm/utils/marshal_logging.rb

@@ -1,90 +0,0 @@
-module ScoutApm
-  module Utils
-    class Error < StandardError; end
-
-    class InstanceVar
-      attr_reader :name
-      attr_reader :obj
-
-      def initialize(name, obj, parent)
-        @name = name
-        @obj = obj
-        @parent = parent
-      end
-
-      def to_s
-        "#{@name} - #{obj.class}"
-      end
-
-      def history
-        (@parent.nil? ? [] : @parent.history) + [to_s]
-      end
-    end
-
-    class MarshalLogging
-      def initialize(base_obj)
-        @base_obj = base_obj
-      end
-
-      def dive
-        to_investigate = [InstanceVar.new('Root', @base_obj, nil)]
-        max_to_check = 10000
-        checked = 0
-
-        while (var = to_investigate.shift)
-          checked += 1 
-          if checked > max_to_check
-            return "Limiting Checks (max = #{max_to_check})"
-          end
-
-          obj = var.obj
-
-          if offending_hash?(obj)
-            return "Found undumpable object: #{var.history}"
-          end
-
-          if !dumps?(obj)
-            if obj.is_a? Hash
-              keys = obj.keys
-              keys.each do |key|
-                to_investigate.push(
-                  InstanceVar.new(key.to_s, obj[key], var)
-                )
-              end
-            elsif obj.is_a? Array
-              obj.each_with_index do |value, idx|
-                to_investigate.push(
-                  InstanceVar.new("Index #{idx}", value, var)
-                )
-              end
-            else
-              symbols = obj.instance_variables
-              if !symbols.any?
-                return "Found undumpable object: #{var.history}"
-              end
-
-              symbols.each do |sym|
-                to_investigate.push(
-                  InstanceVar.new(sym, obj.instance_variable_get(sym), var)
-                )
-              end
-            end
-          end
-        end
-
-        true
-      end
-
-      def dumps?(obj)
-        Marshal.dump(obj)
-        true
-      rescue TypeError
-        false
-      end
-
-      def offending_hash?(obj)
-        obj.is_a?(Hash) && !obj.default_proc.nil?
-      end
-    end
-  end
-end

data/lib/scout_apm/utils/numbers.rb

@@ -1,14 +0,0 @@
-module ScoutApm
-  module Utils
-    class Numbers
-
-      # Round a float to a certain number of decimal places
-      def self.round(number, decimals)
-        factor = 10 ** decimals
-
-        (number * factor).round / factor.to_f
-      end
-
-    end
-  end
-end

data/lib/scout_apm/utils/scm.rb

@@ -1,14 +0,0 @@
-# Module for helping to deal with Source Code Management settings
-module ScoutApm
-  module Utils
-    class Scm
-      # Takes an *already relative* path +path+
-      # Returns a relative path, prepending the configured +scm_subdirectory+ environment string
-      def self.relative_scm_path(path, scm_subdirectory = ScoutApm::Agent.instance.context.environment.scm_subdirectory)
-        @@scm_subdirectory ||= scm_subdirectory.sub(/^\//, '')
-        @@scm_subdirectoy_blank ||= @@scm_subdirectory.empty?
-        @@scm_subdirectoy_blank ? path : File.join(@@scm_subdirectory, path)
-      end
-    end
-  end
-end

data/lib/tasks/doctor.rake

@@ -1,11 +0,0 @@
-namespace :scout do
-  desc "Prints out details of the detected environment"
-  task :doctor => :environment do
-    ScoutApm::Tasks::Doctor.run!
-  end
-
-  desc "Collect logs, settings and environment to help debug issues"
-  task :support => :environment do
-    ScoutApm::Tasks::Support.run!
-  end
-end

data/test/tmp/README.md

@@ -1,17 +0,0 @@
-# Temporary Data
-
-Use this directory for temporary test files.
-
-## Usage
-
-The `DATA_FILE_DIR` constant points at this directory:
-
-```ruby
-class MyTest < Minitest::Test
-  def database_path
-    File.expand_path('test.sqlite3', DATA_FILE_DIR)
-  end
-
-  # ... tests
-end
-```

data/test/unit/agent_context_test.rb

@@ -1,15 +0,0 @@
-require "test_helper"
-
-require "scout_apm/agent_context"
-
-class AgentContextTest < Minitest::Test
-  def test_has_error_service_ignored_exceptions
-    context = ScoutApm::AgentContext.new
-    assert ScoutApm::ErrorService::IgnoredExceptions, context.ignored_exceptions.class
-  end
-
-  def test_has_error_buffer
-    context = ScoutApm::AgentContext.new
-    assert ScoutApm::ErrorService::ErrorBuffer, context.error_buffer.class
-  end
-end

data/test/unit/auto_instrument/assignments-instrumented.rb

@@ -1,31 +0,0 @@
-
-class Assignments
-  def test_op_asgn
-    foo.bar += ::ScoutApm::AutoInstrument("User.size",["ROOT/test/unit/auto_instrument/assignments.rb:4:in `test_op_asgn'"]){User.size}
-    foo.bar -= ::ScoutApm::AutoInstrument("User.size",["ROOT/test/unit/auto_instrument/assignments.rb:5:in `test_op_asgn'"]){User.size}
-  end
-
-  def nested_assignment
-    @email ||= if (email = ::ScoutApm::AutoInstrument("session[\"email\"]",["ROOT/test/unit/auto_instrument/assignments.rb:9:in `nested_assignment'"]){session["email"]}).present?
-        ::ScoutApm::AutoInstrument("User.where(email: email).first",["ROOT/test/unit/auto_instrument/assignments.rb:10:in `nested_assignment'"]){User.where(email: email).first}
-      else
-        nil
-      end
-  end
-
-  def paginate_collection(coll)
-    page = (::ScoutApm::AutoInstrument("params[:page].present?",["ROOT/test/unit/auto_instrument/assignments.rb:17:in `paginate_collection'"]){params[:page].present?} ? ::ScoutApm::AutoInstrument("params[:page].to_i",["ROOT/test/unit/auto_instrument/assignments.rb:17:in `paginate_collection'"]){params[:page].to_i} : 1)
-    per_page = (::ScoutApm::AutoInstrument("params[:per_page].present?",["ROOT/test/unit/auto_instrument/assignments.rb:18:in `paginate_collection'"]){params[:per_page].present?} ? ::ScoutApm::AutoInstrument("params[:per_page].to_i",["ROOT/test/unit/auto_instrument/assignments.rb:18:in `paginate_collection'"]){params[:per_page].to_i} : 20)
-    pagination, self.collection = ::ScoutApm::AutoInstrument("pagy(...",["ROOT/test/unit/auto_instrument/assignments.rb:19:in `paginate_collection'"]){pagy(
-      coll,
-      items: per_page,
-      page: page
-    )}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:24:in `paginate_collection'"]){headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:25:in `paginate_collection'"]){headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:26:in `paginate_collection'"]){headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:27:in `paginate_collection'"]){headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s",["ROOT/test/unit/auto_instrument/assignments.rb:28:in `paginate_collection'"]){headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s}
-    ::ScoutApm::AutoInstrument("collection",["ROOT/test/unit/auto_instrument/assignments.rb:29:in `paginate_collection'"]){collection}
-  end
-end