scout_apm 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 359e7ebbd4d2be52175b519c7eed26801f332cf6
-  data.tar.gz: d54ba2ef21fc61b38e54136637bd97391ba0c26b
+  metadata.gz: 1c2f4d07b1f636737317fc8200121bc301c8dd53
+  data.tar.gz: 59f8d5df43b92220fc8e482e04ab33a7b3a82337
 SHA512:
-  metadata.gz: d5c7c714ffa299176340a4b6d1c62f248106840565245c1ecef1696e103218f3c91dcd2e31d3f0164bf97d125f36f6312c4f4db1c3875dc6c4a2a9b3d12c3420
-  data.tar.gz: 45cabecb512ef84af5ab618d227a787d92f64e62874352c770d70a8b8ccf23facf992b30a0ce7ded385b291bf44f11858a5cf3b5f5544d63766fa34fb504ab7b
+  metadata.gz: 546f2ea5ac44f2a1100f8b84c99e9fa7f9493b0ec91a104ff3926e02c0373c340651c7276a27a50be72a18eafc9a389b39a6c621cf6e333d699f30e0b80beb25
+  data.tar.gz: dd3ed781983a7f0e3e9522eac7439a40b7af2f1ec457c7c51fe68731745868dd630fd8c3f6ec6242b1e9822d02095cb950d740f02a655faa7293190a9b464f89

data/CHANGELOG.markdown

@@ -1,3 +1,14 @@
+# 0.9.1
+
+Big set of features getting merged in for this release.
+
+* StackProf support!  Get visibility into your Ruby code. On Ruby 2.1+, just
+  add `gem 'stackprof'` to your Gemfile.
+* Deploy tracking! Compare your application's response time, throughput and
+  error rate between different releases.  At the bottom of your Capistrano
+  deploy.rb file, add `require 'scout_apm'` and we do the rest.
+* Log message overhaul. Removed a lot of the noise, clarified messages.
+
 # 0.9.0
 
 * Come out of alpha, and release a beta version.

data/lib/scout_apm.rb

@@ -1,6 +1,9 @@
 module ScoutApm
 end
 
+#####################################
+# Ruby StdLibrary Requires
+#####################################
 require 'cgi'
 require 'logger'
 require 'net/http'
@@ -10,6 +13,18 @@ require 'socket'
 require 'yaml'
 require 'thread'
 
+#####################################
+# Gem Requires
+#####################################
+begin
+  require 'stackprof'
+rescue LoadError
+  require 'scout_apm/utils/fake_stack_prof'
+end
+
+#####################################
+# Internal Requires
+#####################################
 require 'scout_apm/version'
 
 require 'scout_apm/server_integrations/passenger'
@@ -25,6 +40,9 @@ require 'scout_apm/framework_integrations/rails_3_or_4'
 require 'scout_apm/framework_integrations/sinatra'
 require 'scout_apm/framework_integrations/ruby'
 
+require 'scout_apm/deploy_integrations/capistrano_3'
+#require 'scout_apm/deploy_integrations/capistrano_2'
+
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
@@ -41,6 +59,7 @@ require 'scout_apm/utils/sql_sanitizer'
 require 'scout_apm/utils/null_logger'
 require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/time'
+
 require 'scout_apm/config'
 require 'scout_apm/environment'
 require 'scout_apm/agent'
@@ -56,12 +75,14 @@ require 'scout_apm/stack_item'
 require 'scout_apm/store'
 require 'scout_apm/tracer'
 require 'scout_apm/context'
+require 'scout_apm/stackprof_tree_collapser'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/capacity'
 
 require 'scout_apm/serializers/payload_serializer'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
+require 'scout_apm/serializers/deploy_serializer'
 
 if defined?(Rails) and Rails.respond_to?(:version) and Rails.version >= '3'
   module ScoutApm

data/lib/scout_apm/agent.rb

@@ -78,6 +78,11 @@ module ScoutApm
       init_logger
       logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
 
+      if environment.deploy_integration
+        logger.info "Starting monitoring for [#{environment.deploy_integration.name}]]."
+        return environment.deploy_integration.install
+      end
+
       return false unless preconditions_met?
 
       @started = true
@@ -93,16 +98,16 @@ module ScoutApm
 
       app_server_load_hook
 
-      if start_background_worker? # TODO: Clarify name. This is not the path that unicorn workers take....
-        # This branch fires only on non-forking servers, directly starts the
-        # background thread and then requests are served.
+      # start_background_worker? is true on non-forking servers, and directly
+      # starts the background worker.  On forking servers, a server-specific
+      # hook is inserted to start the background worker after forking.
+      if start_background_worker?
         start_background_worker
         handle_exit
         logger.info "Scout Agent [#{ScoutApm::VERSION}] Initialized"
       else
-        # This branch fires on.... master only? of forking servers
-        logger.debug "Not starting worker thread. Will start worker loops after forking."
         environment.app_server_integration.install
+        logger.info "Scout Agent [#{ScoutApm::VERSION}] loaded in [#{environment.app_server}] master process. Monitoring will start after server forks its workers."
       end
     end
 
@@ -121,7 +126,7 @@ module ScoutApm
       logger.debug "Exit handler not supported" and return if exit_handler_unsupported?
 
       at_exit do
-        logger.debug "Shutdown!"
+        logger.info "Shutting down Scout Agent"
         # MRI 1.9 bug drops exit codes.
         # http://bugs.ruby-lang.org/issues/5218
         if environment.ruby_19?
@@ -160,12 +165,11 @@ module ScoutApm
     # Creates the worker thread. The worker thread is a loop that runs continuously. It sleeps for +Agent#period+ and when it wakes,
     # processes data, either saving it to disk or reporting to Scout.
     def start_background_worker
-      logger.debug "Creating worker thread."
+      logger.info "Initializing worker thread."
       @background_worker = ScoutApm::BackgroundWorker.new
       @background_worker_thread = Thread.new do
         @background_worker.start { process_metrics }
-      end # thread new
-      logger.debug "Done creating worker thread."
+      end
     end
 
     def should_load_instruments?
@@ -174,8 +178,6 @@ module ScoutApm
 
     # Loads the instrumention logic.
     def load_instruments
-      logger.debug "Installing instrumentation"
-
       case environment.framework
       when :rails       then install_instrument(ScoutApm::Instruments::ActionControllerRails2)
       when :rails3_or_4 then install_instrument(ScoutApm::Instruments::ActionControllerRails3)
@@ -186,6 +188,10 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::Moped)
       install_instrument(ScoutApm::Instruments::Mongoid)
       install_instrument(ScoutApm::Instruments::NetHttp)
+
+      if StackProf.respond_to?(:fake?) && StackProf.fake?
+        logger.info 'StackProf not found - add `gem "stackprof"` to your Gemfile to enable advanced code profiling (only for Ruby 2.1+)'
+      end
     rescue
       logger.warn "Exception loading instruments:"
       logger.warn $!.message
@@ -197,5 +203,9 @@ module ScoutApm
       @installed_instruments << instance
       instance.install
     end
+
+    def deploy_integration
+      environment.deploy_integration
+    end
   end
 end

data/lib/scout_apm/agent/reporting.rb

@@ -20,13 +20,14 @@ module ScoutApm
         if payload.any?
           add_metric_ids(metrics)
 
-          logger.warn "Some data may be lost - metric size is at limit" if metrics.size == ScoutApm::Store::MAX_SIZE
+          logger.warn "Metric Size is at Limit, truncating" if metrics.size == ScoutApm::Store::MAX_SIZE
+
           # for debugging, count the total number of requests
-          controller_count = 0
+          total_request_count = 0
 
           metrics.each do |meta,stats|
             if meta.metric_name =~ /\AController/
-              controller_count += stats.call_count
+              total_request_count += stats.call_count
             end
           end
 
@@ -35,7 +36,10 @@ module ScoutApm
 
           payload = ScoutApm::Serializers::PayloadSerializer.serialize(metrics, slow_transactions)
           slow_transactions_kb = Marshal.dump(slow_transactions).size/1024 # just for performance debugging
-          logger.debug "#{config.value('name')} Delivering total payload [#{payload.size/1024} KB] for #{controller_count} requests and slow transactions [#{slow_transactions_kb} KB] for #{slow_transactions.size} transactions of durations: #{slow_transactions.map(&:total_call_time).join(',')}."
+
+          logger.info "Delivering #{metrics.length} Metrics for #{total_request_count} requests and #{slow_transactions.length} Slow Transaction Traces"
+
+          logger.debug "Total payload [#{payload.size/1024} KB] for #{total_request_count} requests and Slow Transactions [#{slow_transactions_kb} KB] for #{slow_transactions.size} transactions of durations: #{slow_transactions.map(&:total_call_time).join(',')}."
 
           response = reporter.report(payload)
 
@@ -44,7 +48,7 @@ module ScoutApm
 
             self.metric_lookup.merge!(directives[:metric_lookup])
             if directives[:reset]
-              logger.info "Resetting metric_lookup."
+              logger.debug "Resetting metric_lookup."
               self.metric_lookup = Hash.new
             end
             logger.debug "Metric Cache Size: #{metric_lookup.size}"

data/lib/scout_apm/app_server_load.rb

@@ -9,13 +9,17 @@ module ScoutApm
     def run
       @thread = Thread.new do
         begin
-          logger.info("Sending Startup Info: #{data.inspect}")
+          logger.info "Sending Application Startup Info - App Server: #{data[:app_server]}, Framework: #{data[:framework]}, Framework Version: #{data[:framework_version]}, Database Engine: #{data[:database_engine]}"
+          logger.debug("Full Application Startup Info: #{data.inspect}")
+
           payload = ScoutApm::Serializers::AppServerLoadSerializer.serialize(data)
           reporter = Reporter.new(:app_server_load)
           reporter.report(payload)
-          logger.info("Finished sending Startup Info")
+
+          logger.debug("Finished sending Startup Info")
         rescue => e
-          logger.debug("Failed Startup Info In Thread - #{e.message} \n\t#{e.backtrace.join("\t\n")}")
+          logger.info("Failed Sending Application Startup Info - #{e.message}")
+          logger.debug(e.backtrace.join("\t\n"))
         end
       end
     rescue => e

data/lib/scout_apm/config.rb

@@ -21,6 +21,7 @@ module ScoutApm
     DEFAULTS =  {
         'host'      => 'https://apm.scoutapp.com',
         'log_level' => 'info',
+        'stackprof_interval' => 20000 # microseconds, 1000 = 1 millisecond, so 20k == 20 milliseconds
     }.freeze
 
     def initialize(config_path = nil)
@@ -36,9 +37,9 @@ module ScoutApm
     # boot, where we needed an option to set the application root.
     def value(key, env_only=false)
       value = if env_only
-                ENV['SCOUT_'+key.upcase]
+                ENV['SCOUT_' + key.upcase]
               else
-                ENV['SCOUT_'+key.upcase] || settings[key]
+                ENV['SCOUT_' + key.upcase] || setting(key)
               end
 
       value.to_s.strip.length.zero? ? nil : value
@@ -54,8 +55,12 @@ module ScoutApm
       File.expand_path(config_path)
     end
 
-    def settings
-      @settings ||= load_file
+    def setting(key)
+      settings[key] || settings(true)[key]
+    end
+
+    def settings(try_reload=false)
+      (@settings.nil? || try_reload) ? @settings = load_file : @settings
     end
 
     def config_environment

data/lib/scout_apm/deploy_integrations/capistrano_2.cap

@@ -0,0 +1,12 @@
+namespace :scout_apm do
+  namespace :deploy do
+    task :starting do
+      # Warn if missing scout apm deploy creds?
+    end
+    task :finished do
+      ScoutApm::Agent.instance.deploy_integration.report
+    end
+  end
+end
+
+after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_2.rb

@@ -0,0 +1,83 @@
+require 'scout_apm'
+
+module ScoutApm
+  module DeployIntegrations
+    class Capistrano2
+      attr_reader :logger
+
+      def initialize(logger)
+        @logger = logger
+        @cap = defined?(Capistrano::Configuration) ? ObjectSpace.each_object(Capistrano::Configuration).map.first : nil rescue nil
+      end
+
+      def name
+        :capistrano_2
+      end
+
+      def version
+        present? ? Capistrano::VERSION : nil
+      end
+
+      def present?
+        if !@cap.nil? && @cap.is_a?(Capistrano::Configuration)
+          require 'capistrano/version'
+          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 2.0').match?('', Capistrano::VERSION.to_s)
+        else
+          return false
+        end
+        return true
+      rescue
+        return false
+      end
+
+      def install
+        logger.debug "Initializing Capistrano2 Deploy Integration."
+        @cap.load File.expand_path("../capistrano_2.cap", __FILE__)
+      end
+
+      def root
+        '.'
+      end
+
+      def env
+        @cap.fetch(:stage)
+      end
+
+      def found?
+        true
+      end
+
+      def report
+        if reporter.can_report?
+          data = deploy_data
+          logger.debug "Sending deploy hook data: #{data}"
+          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
+          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
+        else
+          logger.warn "Unable to post deploy hook data"
+        end
+      end
+
+      def reporter
+        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, ScoutApm::Agent.instance.config, @logger)
+      end
+
+      def deploy_data
+        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
+      end
+
+      def branch
+        @cap.fetch(:branch)
+      end
+
+      def current_revision
+        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
+      end
+
+      def deployed_by
+        ScoutApm::Agent.instance.config.value('deployed_by')
+      end
+
+    end
+  end
+end

data/lib/scout_apm/deploy_integrations/capistrano_3.cap

@@ -0,0 +1,12 @@
+namespace :scout_apm do
+  namespace :deploy do
+    task :starting do
+      # Warn if missing scout apm deploy creds?
+    end
+    task :finished do
+      ScoutApm::Agent.instance.deploy_integration.report
+    end
+  end
+end
+
+after 'deploy:finished', 'scout_apm:deploy:finished'

data/lib/scout_apm/deploy_integrations/capistrano_3.rb

@@ -0,0 +1,82 @@
+require 'scout_apm'
+
+module ScoutApm
+  module DeployIntegrations
+    class Capistrano3
+      attr_reader :logger
+
+      def initialize(logger)
+        @logger = logger
+        @cap = Rake.application rescue nil
+      end
+
+      def name
+        :capistrano_3
+      end
+
+      def version
+        present? ? Capistrano::VERSION : nil
+      end
+
+      def present?
+        if !@cap.nil? && @cap.is_a?(Capistrano::Application)
+          require 'capistrano/version'
+          defined?(Capistrano::VERSION) && Gem::Dependency.new('', '~> 3.0').match?('', Capistrano::VERSION.to_s)
+        else
+          return false
+        end
+      rescue
+        return false
+      end
+
+      def install
+        logger.debug "Initializing Capistrano3 Deploy Integration."
+        load File.expand_path("../capistrano_3.cap", __FILE__)
+      end
+
+      def root
+        '.'
+      end
+
+      def env
+        @cap.fetch(:stage).to_s
+      end
+
+      def found?
+        true
+      end
+
+      def report
+        if reporter.can_report?
+          data = deploy_data
+          logger.debug "Sending deploy hook data: #{data}"
+          payload = ScoutApm::Serializers::DeploySerializer.serialize(data)
+          reporter.report(payload, ScoutApm::Serializers::DeploySerializer::HTTP_HEADERS)
+        else
+          logger.warn "Unable to post deploy hook data"
+        end
+      end
+
+      def reporter
+        @reporter ||= ScoutApm::Reporter.new(:deploy_hook, ScoutApm::Agent.instance.config, @logger)
+      end
+
+      def deploy_data
+        {:revision => current_revision, :branch => branch, :deployed_by => deployed_by}
+      end
+
+      def branch
+        @cap.fetch(:branch)
+      end
+
+      def current_revision
+        @cap.fetch(:current_revision) || `git rev-list --max-count=1 --abbrev-commit --abbrev=12 #{branch}`.chomp
+      end
+
+      def deployed_by
+        ScoutApm::Agent.instance.config.value('deployed_by')
+      end
+
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -24,8 +24,13 @@ module ScoutApm
       ScoutApm::FrameworkIntegrations::Ruby.new, # Fallback if none match
     ]
 
+    DEPLOY_INTEGRATIONS = [
+      ScoutApm::DeployIntegrations::Capistrano3.new(Logger.new(STDOUT)),
+      # ScoutApm::DeployIntegrations::Capistrano2.new(Logger.new(STDOUT)),
+    ]
+
     def env
-      @env ||= framework_integration.env
+      @env ||= deploy_integration? ? deploy_integration.env : framework_integration.env
     end
 
     def framework
@@ -58,6 +63,7 @@ module ScoutApm
     end
 
     def root
+      return deploy_integration.root if deploy_integration
       framework_root
     end
 
@@ -65,7 +71,6 @@ module ScoutApm
       if override_root = Agent.instance.config.value("application_root", true)
         return override_root
       end
-
       if framework == :rails
         RAILS_ROOT.to_s
       elsif framework == :rails3_or_4
@@ -106,6 +111,14 @@ module ScoutApm
       app_server_integration.forking?
     end
 
+    def deploy_integration
+      @deploy_integration ||= DEPLOY_INTEGRATIONS.detect{ |integration| integration.present? }
+    end
+
+    def deploy_integration?
+      !@deploy_integration.nil?
+    end
+
     ### ruby checks
 
     def rubinius?

data/lib/scout_apm/instruments/action_controller_rails_2.rb

@@ -31,7 +31,7 @@ module ScoutApm
             protected :rescue_action
           end
 
-          ScoutApm::Agent.instance.logger.debug "Instrumenting ActionView::Template"
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::Template"
           ::ActionView::Template.class_eval do
             include ::ScoutApm::Tracer
             instrument_method :render, :metric_name => 'View/#{path[%r{^(/.*/)?(.*)$},2]}/Rendering', :scope => true
@@ -43,7 +43,7 @@ module ScoutApm
 
     module ActionControllerRails2Instruments
       def self.included(instrumented_class)
-        ScoutApm::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
+        ScoutApm::Agent.instance.logger.info "Instrumenting #{instrumented_class.inspect}"
         instrumented_class.class_eval do
           unless instrumented_class.method_defined?(:perform_action_without_scout_instruments)
             alias_method :perform_action_without_scout_instruments, :perform_action

data/lib/scout_apm/instruments/action_controller_rails_3.rb

@@ -18,7 +18,7 @@ module ScoutApm
         # ActionController::Base is a subclass of ActionController::Metal, so this instruments both
         # standard Rails requests + Metal.
         if defined?(::ActionController) && defined?(::ActionController::Metal)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting ActionController::Metal"
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionController::Metal"
           ::ActionController::Metal.class_eval do
             include ScoutApm::Tracer
             include ScoutApm::Instruments::ActionControllerRails3Instruments
@@ -26,13 +26,26 @@ module ScoutApm
         end
 
         if defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting ActionView::PartialRenderer"
-          ActionView::PartialRenderer.class_eval do
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::PartialRenderer"
+          ::ActionView::PartialRenderer.class_eval do
             include ScoutApm::Tracer
-            instrument_method :render_partial, :metric_name => 'View/#{@template.virtual_path}/Rendering', :scope => true
+            instrument_method :render_partial,
+              :metric_name => 'View/#{@template.virtual_path rescue "Unknown Partial"}/Rendering',
+              :scope => true
+
+            instrument_method :collection_with_template,
+              :metric_name => 'View/#{@template.virtual_path rescue "Unknown Collection"}/Rendering',
+              :scope => true
           end
-        end
 
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::TemplateRenderer"
+          ::ActionView::TemplateRenderer.class_eval do
+            include ScoutApm::Tracer
+            instrument_method :render_template,
+              :metric_name => 'View/#{args[0].virtual_path rescue "Unknown"}/Rendering',
+              :scope => true
+          end
+        end
       end
     end
 
@@ -42,13 +55,18 @@ module ScoutApm
         scout_controller_action = "Controller/#{controller_path}/#{action_name}"
 
         self.class.scout_apm_trace(scout_controller_action, :uri => request.fullpath, :ip => request.remote_ip) do
+          Thread::current[:scout_apm_prof] = nil
+          StackProf.start(mode: :wall, interval: ScoutApm::Agent.instance.config.value("stackprof_interval"))
+
           begin
             super
           rescue Exception
-            ScoutApm::Agent.instance.store.track!("Errors/Request",1, :scope => nil)
+            ScoutApm::Agent.instance.store.track!("Errors/Request", 1, :scope => nil)
             raise
           ensure
             Thread::current[:scout_apm_scope_name] = nil
+            StackProf.stop
+            Thread::current[:scout_apm_prof] = StackProf.results
           end
         end
       end
@@ -56,9 +74,3 @@ module ScoutApm
   end
 end
 
-
-# Rails 3/4
-module ScoutApm
-  module Instruments
-  end
-end

data/lib/scout_apm/instruments/active_record.rb

@@ -19,7 +19,6 @@ module ScoutApm
 
         if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3 && ::Rails.respond_to?(:configuration)
           Rails.configuration.after_initialize do
-            ScoutApm::Agent.instance.logger.debug "Adding ActiveRecord instrumentation to a Rails 3 app"
             add_instruments
           end
         else
@@ -47,7 +46,7 @@ module ScoutApm
     # to trace calls to the database.
     module ActiveRecordInstruments
       def self.included(instrumented_class)
-        ScoutApm::Agent.instance.logger.debug "Instrumenting #{instrumented_class.inspect}"
+        ScoutApm::Agent.instance.logger.info "Instrumenting #{instrumented_class.inspect}"
         instrumented_class.class_eval do
           unless instrumented_class.method_defined?(:log_without_scout_instruments)
             alias_method :log_without_scout_instruments, :log

data/lib/scout_apm/instruments/mongoid.rb

@@ -17,7 +17,7 @@ module ScoutApm
 
         # Mongoid versions that use Moped should instrument Moped.
         if defined?(::Mongoid) and !defined?(::Moped)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting Mongoid"
+          ScoutApm::Agent.instance.logger.info "Instrumenting Mongoid"
 
           ::Mongoid::Collection.class_eval do
             include ScoutApm::Tracer

data/lib/scout_apm/instruments/moped.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed = true
 
         if defined?(::Moped)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting Moped"
+          ScoutApm::Agent.instance.logger.info "Instrumenting Moped"
           ::Moped::Node.class_eval do
             include ScoutApm::Tracer
 

data/lib/scout_apm/instruments/net_http.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed = true
 
         if defined?(::Net) && defined?(::Net::HTTP)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting Net::HTTP"
+          ScoutApm::Agent.instance.logger.info "Instrumenting Net::HTTP"
 
           ::Net::HTTP.class_eval do
             include ScoutApm::Tracer

data/lib/scout_apm/instruments/process/process_cpu.rb

@@ -37,7 +37,7 @@ module ScoutApm
           wall_clock_elapsed  = now - last_run
           if wall_clock_elapsed < 0
             save_times(now, utime, stime)
-            logger.warn "#{human_name}: Negative time elapsed.  now: #{now}, last_run: #{last_run}, total time: #{wall_clock_elapsed}"
+            logger.info "#{human_name}: Negative time elapsed.  now: #{now}, last_run: #{last_run}, total time: #{wall_clock_elapsed}."
             return nil
           end
 
@@ -49,7 +49,7 @@ module ScoutApm
           # pre-fork, records {u,s}time, then forks. This resets {u,s}time to 0
           if process_elapsed < 0
             save_times(now, utime, stime)
-            logger.warn "#{human_name}: Negative process time elapsed.  utime: #{utime_elapsed}, stime: #{stime_elapsed}, total time: #{process_elapsed}"
+            logger.debug "#{human_name}: Negative process time elapsed.  utime: #{utime_elapsed}, stime: #{stime_elapsed}, total time: #{process_elapsed}. This is normal to see when starting a forking web server."
             return nil
           end
 
@@ -65,7 +65,7 @@ module ScoutApm
 
           if res < 0
             save_times(now, utime, stime)
-            logger.warn "#{human_name}: Negative CPU.  #{process_elapsed} / #{normalized_wall_clock_elapsed} * 100 ==> #{res}"
+            logger.info "#{human_name}: Negative CPU.  #{process_elapsed} / #{normalized_wall_clock_elapsed} * 100 ==> #{res}"
             return nil
           end
 

data/lib/scout_apm/instruments/sinatra.rb

@@ -16,7 +16,7 @@ module ScoutApm
         @installed = true
 
         if defined?(::Sinatra) && defined?(::Sinatra::Base) && ::Sinatra::Base.private_method_defined?(:dispatch!)
-          ScoutApm::Agent.instance.logger.debug "Instrumenting Sinatra"
+          ScoutApm::Agent.instance.logger.info "Instrumenting Sinatra"
           ::Sinatra::Base.class_eval do
             include ScoutApm::Tracer
             include ScoutApm::Instruments::SinatraInstruments

data/lib/scout_apm/reporter.rb

@@ -16,8 +16,8 @@ module ScoutApm
     end
 
     # TODO: Parse & return a real response object, not the HTTP Response object
-    def report(payload)
-      post(uri, payload)
+    def report(payload, headers = {})
+      post(uri, payload, headers)
     end
 
     def uri
@@ -26,9 +26,26 @@ module ScoutApm
         URI.parse("#{config.value('host')}/apps/checkin.scout?key=#{config.value('key')}&name=#{CGI.escape(Environment.instance.application_name)}")
       when :app_server_load
         URI.parse("#{config.value('host')}/apps/app_server_load.scout?key=#{config.value('key')}&name=#{CGI.escape(Environment.instance.application_name)}")
+      when :deploy_hook
+        URI.parse("#{config.value('host')}/apps/deploy.scout?key=#{config.value('key')}&name=#{CGI.escape(config.value('name'))}")
       end.tap{|u| logger.debug("Posting to #{u.to_s}")}
     end
 
+    def can_report?
+      case type
+      when :deploy_hook
+        %w(host key name).each do |k|
+          if config.value(k).nil?
+            logger.warn "/#{type} FAILED: missing required config value for #{k}"
+            return false
+          end
+        end
+        return true
+      else
+        return true
+      end
+    end
+
     private
 
     def post(uri, body, headers = Hash.new)
@@ -52,6 +69,8 @@ module ScoutApm
         logger.debug "/#{type} OK"
       when Net::HTTPBadRequest
         logger.warn "/#{type} FAILED: The Account Key [#{config.value('key')}] is invalid."
+      when Net::HTTPUnprocessableEntity
+        logger.warn "/#{type} FAILED: #{response.body}"
       else
         logger.debug "/#{type} FAILED: #{response.inspect}"
       end

data/lib/scout_apm/serializers/deploy_serializer.rb

@@ -0,0 +1,16 @@
+# Serialize & deserialize deploy data up to the APM server
+module ScoutApm
+  module Serializers
+    class DeploySerializer
+      HTTP_HEADERS = {'Content-Type' => 'application/x-www-form-urlencoded'}
+
+      def self.serialize(data)
+        URI.encode_www_form(data)
+      end
+
+      def self.deserialize(data)
+        Marshal.load(data)
+      end
+    end
+  end
+end

data/lib/scout_apm/server_integrations/passenger.rb

@@ -18,6 +18,8 @@ module ScoutApm
       end
 
       def install
+        logger.info "Installing Passenger worker loop."
+
         PhusionPassenger.on_event(:starting_worker_process) do |forked|
           logger.debug "Passenger is starting a worker process. Starting worker thread."
           ScoutApm::Agent.instance.start_background_worker

data/lib/scout_apm/server_integrations/puma.rb

@@ -14,7 +14,6 @@ module ScoutApm
       def forking?
         return false unless defined?(::Puma)
         options = ::Puma.cli_config.instance_variable_get(:@options)
-        logger.debug options.inspect
         options[:preload_app]
       rescue
         false
@@ -26,7 +25,7 @@ module ScoutApm
 
       def install
         ::Puma.cli_config.options[:before_worker_boot] << Proc.new do
-          logger.debug "Installing Puma worker loop."
+          logger.info "Installing Puma worker loop."
           ScoutApm::Agent.instance.start_background_worker
         end
       rescue

data/lib/scout_apm/server_integrations/rainbows.rb

@@ -21,7 +21,7 @@ module ScoutApm
       end
 
       def install
-        logger.debug "Installing Rainbows worker loop."
+        logger.info "Installing Rainbows worker loop."
 
         Rainbows::HttpServer.class_eval do
           old = instance_method(:worker_loop)

data/lib/scout_apm/server_integrations/unicorn.rb

@@ -29,6 +29,7 @@ module ScoutApm
       end
 
       def install
+        logger.info "Installing Unicorn worker loop."
         ::Unicorn::HttpServer.class_eval do
           old = instance_method(:worker_loop)
           define_method(:worker_loop) do |worker|

data/lib/scout_apm/slow_transaction.rb

@@ -1,36 +1,49 @@
-class ScoutApm::SlowTransaction
-  BACKTRACE_THRESHOLD = 0.5 # the minimum threshold to record the backtrace for a metric.
-  BACKTRACE_LIMIT = 5 # Max length of callers to display
-  MAX_SIZE = 100 # Limits the size of the metric hash to prevent a metric explosion.
-  attr_reader :metric_name, :total_call_time, :metrics, :meta, :uri, :context, :time, :prof, :raw_prof
+module ScoutApm
+  class SlowTransaction
+    BACKTRACE_THRESHOLD = 0.5 # the minimum threshold to record the backtrace for a metric.
+    BACKTRACE_LIMIT = 5 # Max length of callers to display
+    MAX_SIZE = 100 # Limits the size of the metric hash to prevent a metric explosion.
 
-  # Given a call stack, generates a filtered backtrace that:
-  # * Limits to the app/models, app/controllers, or app/views directories
-  # * Limits to 5 total callers
-  # * Makes the app folder the top-level folder used in trace info
-  def self.backtrace_parser(backtrace)
-    stack = []
-    backtrace.each do |c|
-      if m=c.match(/(\/app\/(controllers|models|views)\/.+)/)
-        stack << m[1]
-        break if stack.size == BACKTRACE_LIMIT
+    attr_reader :metric_name
+    attr_reader :total_call_time
+    attr_reader :metrics
+    attr_reader :meta
+    attr_reader :uri
+    attr_reader :context
+    attr_reader :time
+    attr_reader :prof
+    attr_reader :raw_prof
+
+    # Given a call stack, generates a filtered backtrace that:
+    # * Limits to the app/models, app/controllers, or app/views directories
+    # * Limits to 5 total callers
+    # * Makes the app folder the top-level folder used in trace info
+    def self.backtrace_parser(backtrace)
+      stack = []
+      backtrace.each do |c|
+        if m=c.match(/(\/app\/(controllers|models|views)\/.+)/)
+          stack << m[1]
+          break if stack.size == BACKTRACE_LIMIT
+        end
       end
+      stack
     end
-    stack
-  end
 
-  def initialize(uri,metric_name,total_call_time,metrics,context,time)
-    @uri = uri
-    @metric_name = metric_name
-    @total_call_time = total_call_time
-    @metrics = metrics
-    @context = context
-    @time = time
-  end
+    def initialize(uri, metric_name, total_call_time, metrics, context, time, raw_stackprof)
+      @uri = uri
+      @metric_name = metric_name
+      @total_call_time = total_call_time
+      @metrics = metrics
+      @context = context
+      @time = time
+      @prof = ScoutApm::StackprofTreeCollapser.new(raw_stackprof).call
+      @raw_prof = raw_stackprof # Send whole data up to server
+    end
 
-  # Used to remove metrics when the payload will be too large.
-  def clear_metrics!
-    @metrics = nil
-    self
+    # Used to remove metrics when the payload will be too large.
+    def clear_metrics!
+      @metrics = nil
+      self
+    end
   end
 end

data/lib/scout_apm/stackprof_tree_collapser.rb

@@ -0,0 +1,95 @@
+module ScoutApm
+  class StackprofTreeCollapser
+    attr_reader :raw_stackprof
+    attr_reader :nodes
+
+    def initialize(raw_stackprof)
+      @raw_stackprof = raw_stackprof
+      unless StackProf.respond_to?(:fake?) && StackProf.fake?
+        ScoutApm::Agent.instance.logger.debug("StackProf - Samples: #{raw_stackprof[:samples]}, GC: #{raw_stackprof[:gc_samples]}, missed: #{raw_stackprof[:missed_samples]}, Interval: #{raw_stackprof[:interval]}")
+      end
+    end
+
+    def call
+      build_tree
+      connect_children
+      total_samples_of_app_nodes
+    end
+
+    private
+
+    def build_tree
+      @nodes = raw_stackprof[:frames].map do |(frame_id, frame_data)|
+        TreeNode.new(frame_id,                     # frame_id
+                     frame_data[:name],            # name
+                     frame_data[:file],            # file
+                     frame_data[:line],            # line
+                     frame_data[:samples],         # samples
+                     frame_data[:total_samples],   # total_samples
+                     (frame_data[:edges] || {}),   # children_edges [ { id => weight } ]
+                     [],                           # children [ treenode, ... ]
+                     []                            # parents [ [treenode, int (weight) ], [...] ]
+                    )
+      end
+    end
+
+    def connect_children
+      nodes.each do |node|
+        children = nodes.find_all { |n| node.children_edges.keys.include? n.frame_id }
+
+        node.children_edges.each do |(frame_id, weight)|
+          child = children.detect{ |c| c.frame_id == frame_id }
+          child.parents << [node, weight]
+        end
+
+        node.children = children
+      end
+    end
+
+    def in_app_nodes
+      nodes.select {|n| n.app? }
+    end
+
+    def total_samples_of_app_nodes
+      in_app_nodes.reject{|n| n.calls_only_app_nodes? && !n.has_samples? }.
+        map{|n| { samples: n.total_samples,
+                  name: n.name,
+                  file: n.file,
+                  line: n.line
+                }
+        }
+    end
+
+    ###########################################
+    # TreeNode class represents a single node.
+    ###########################################
+    TreeNode = Struct.new(:frame_id, :name, :file, :line, :samples, :total_samples,
+                          :children_edges, :children, :parents) do
+      def app?
+        @is_app ||= file =~ /^#{ScoutApm::Environment.instance.root}/
+      end
+
+      # Force object_id to be the equality mechanism, rather than struct's
+      # default which delegates to == on each value.  That is wrong because
+      # we want to be able to dup a node in the tree construction process and
+      # not have those compare equal to each other.
+      def ==(other)
+        object_id == other.object_id
+      end
+
+      def inspect
+        "#{frame_id}: #{name} - ##{samples}\n" +
+        "  Parents: #{parents.map{ |(p, w)| "#{p.name}: #{w}"}.join("\n           ") }\n" +
+        "  Children: #{children_edges.inspect} \n"
+      end
+
+      def calls_only_app_nodes?
+        children.all?(&:app?)
+      end
+
+      def has_samples?
+        samples > 0
+      end
+    end
+  end
+end

data/lib/scout_apm/store.rb

@@ -72,7 +72,7 @@ module ScoutApm
       end
 
       duration = Time.now - item.start_time
-      if last=stack.last
+      if last = stack.last
         last.children_time += duration
       end
 
@@ -90,8 +90,8 @@ module ScoutApm
 
       # Uses controllers as the entry point for a transaction. Otherwise, stats are ignored.
       if stack_empty and meta.metric_name.match(/\AController\//)
-        aggs=aggregate_calls(transaction_hash.dup,meta)
-        store_slow(options[:uri],transaction_hash.dup.merge(aggs),meta,stat)
+        aggs = aggregate_calls(transaction_hash.dup,meta)
+        store_slow(options[:uri], transaction_hash.dup.merge(aggs), meta, stat)
         # deep duplicate
         duplicate = aggs.dup
         duplicate.each_pair do |k,v|
@@ -139,12 +139,20 @@ module ScoutApm
       aggregates
     end
 
+    SLOW_TRANSACTION_THRESHOLD = 2
+
     # Stores slow transactions. This will be sent to the server.
-    def store_slow(uri,transaction_hash,parent_meta,parent_stat,options = {})
+    def store_slow(uri, transaction_hash, parent_meta, parent_stat, options = {})
       @slow_transaction_lock.synchronize do
-        # tree map of all slow transactions
-        if parent_stat.total_call_time >= 2
-          @slow_transactions.push(ScoutApm::SlowTransaction.new(uri,parent_meta.metric_name,parent_stat.total_call_time,transaction_hash.dup,ScoutApm::Context.current,Thread::current[:scout_apm_trace_time]))
+        if parent_stat.total_call_time >= SLOW_TRANSACTION_THRESHOLD
+          slow_transaction = ScoutApm::SlowTransaction.new(uri,
+                                                           parent_meta.metric_name,
+                                                           parent_stat.total_call_time,
+                                                           transaction_hash.dup,
+                                                           ScoutApm::Context.current,
+                                                           Thread::current[:scout_apm_trace_time],
+                                                           Thread::current[:scout_apm_prof])
+          @slow_transactions.push(slow_transaction)
           ScoutApm::Agent.instance.logger.debug "Slow transaction sample added. [URI: #{uri}] [Context: #{ScoutApm::Context.current.to_hash}] Array Size: #{@slow_transactions.size}"
         end
       end

data/lib/scout_apm/tracer.rb

@@ -54,13 +54,16 @@ module ScoutApm
         elsif Thread::current[:scout_ignore_children]
           return yield
         end
+
         if options.delete(:scope)
           Thread::current[:scout_apm_sub_scope] = metric_name
         end
+
         if options[:ignore_children]
           Thread::current[:scout_ignore_children] = true
         end
         stack_item = ScoutApm::Agent.instance.store.record(metric_name)
+
         begin
           yield
         ensure
@@ -68,15 +71,21 @@ module ScoutApm
           if options[:ignore_children]
             Thread::current[:scout_ignore_children] = nil
           end
+
           ScoutApm::Agent.instance.store.stop_recording(stack_item,options)
         end
       end
 
-      def instrument_method(method,options = {})
+      def instrument_method(method, options = {})
         ScoutApm::Agent.instance.logger.info "Instrumenting #{method}"
         metric_name = options[:metric_name] || default_metric_name(method)
         return if !instrumentable?(method) or instrumented?(method,metric_name)
-        class_eval instrumented_method_string(method, {:metric_name => metric_name, :scope => options[:scope]}), __FILE__, __LINE__
+
+        class_eval(instrumented_method_string(
+          method,
+          {:metric_name => metric_name, :scope => options[:scope] }),
+          __FILE__, __LINE__
+        )
 
         alias_method _uninstrumented_method_name(method, metric_name), method
         alias_method method, _instrumented_method_name(method, metric_name)
@@ -86,12 +95,14 @@ module ScoutApm
 
       def instrumented_method_string(method, options)
         klass = (self === Module) ? "self" : "self.class"
-        "def #{_instrumented_method_name(method, options[:metric_name])}(*args, &block)
+        method_str = "def #{_instrumented_method_name(method, options[:metric_name])}(*args, &block)
           result = #{klass}.instrument(\"#{options[:metric_name]}\",{:scope => #{options[:scope] || false}}) do
             #{_uninstrumented_method_name(method, options[:metric_name])}(*args, &block)
           end
           result
         end"
+
+        method_str
       end
 
       # The method must exist to be instrumented.

data/lib/scout_apm/utils/fake_stack_prof.rb

@@ -0,0 +1,40 @@
+# A fake implementation of stackprof, for systems that don't support it.
+class StackProf
+  def self.start(*args)
+    @running = true
+  end
+
+  def self.stop(*args)
+    @running = false
+  end
+
+  def self.running?
+    !!@running
+  end
+
+  def self.run(*args)
+    start
+    yield
+    stop
+    results
+  end
+
+  def self.sample(*args)
+  end
+
+  def self.results(*args)
+    {
+      :version => 0.0,
+      :mode => :wall,
+      :interval => 1000,
+      :samples => 0,
+      :gc_samples => 0,
+      :missed_samples => 0,
+      :frames => {},
+    }
+  end
+
+  def self.fake?
+    true
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -75,6 +75,10 @@ files:
 - lib/scout_apm/capacity.rb
 - lib/scout_apm/config.rb
 - lib/scout_apm/context.rb
+- lib/scout_apm/deploy_integrations/capistrano_2.cap
+- lib/scout_apm/deploy_integrations/capistrano_2.rb
+- lib/scout_apm/deploy_integrations/capistrano_3.cap
+- lib/scout_apm/deploy_integrations/capistrano_3.rb
 - lib/scout_apm/environment.rb
 - lib/scout_apm/framework_integrations/rails_2.rb
 - lib/scout_apm/framework_integrations/rails_3_or_4.rb
@@ -95,6 +99,7 @@ files:
 - lib/scout_apm/metric_stats.rb
 - lib/scout_apm/reporter.rb
 - lib/scout_apm/serializers/app_server_load_serializer.rb
+- lib/scout_apm/serializers/deploy_serializer.rb
 - lib/scout_apm/serializers/directive_serializer.rb
 - lib/scout_apm/serializers/payload_serializer.rb
 - lib/scout_apm/server_integrations/null.rb
@@ -106,8 +111,10 @@ files:
 - lib/scout_apm/server_integrations/webrick.rb
 - lib/scout_apm/slow_transaction.rb
 - lib/scout_apm/stack_item.rb
+- lib/scout_apm/stackprof_tree_collapser.rb
 - lib/scout_apm/store.rb
 - lib/scout_apm/tracer.rb
+- lib/scout_apm/utils/fake_stack_prof.rb
 - lib/scout_apm/utils/installed_gems.rb
 - lib/scout_apm/utils/null_logger.rb
 - lib/scout_apm/utils/sql_sanitizer.rb