scout_apm 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e79b5f288da544777712971294bf8c37adf7bf64
-  data.tar.gz: 5ca3cb606fee63ad83d31b48458c815024d10a91
+  metadata.gz: 91a0c14d41ab0d56bce566a96e08014a452ba693
+  data.tar.gz: 8b1f7239c3f43bfaa1cb6191ff20d8bcc29bd288
 SHA512:
-  metadata.gz: 388a1865dbcd8dd8be6a93d8a6229ac1560e8b235af4599f58a6c75f69815b186dff72ebbb5d3ad60cac25a59bb7e88827e7e820e703ef6ebd7ece760ac96e68
-  data.tar.gz: 57785a9a9027acbbb5c6c6c6b4a8b7659dd3df47ded3b29705d3b215fb27dcf0613a6880a8f98a6247c165e3b60b8b044e2b676a0a2f4d019c5d2489797901ef
+  metadata.gz: 0f11acf434f45f02d92106f76d7976aa13c86808a10e5716d6698660f82889a9de4a374060acaa5c170df182b60eb9943226da10478f76c33e6ac02bebd4bde6
+  data.tar.gz: baa5db394ee68a07b26fae9a493a96f0e512c6dbc0c583082b2eb5974dfdbd946632c11d83b914cd8033c60f85b3cebc94bccb44b18153f3f95d478fa801c487

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 0.1.7
+
+* Ability to ignore child calls in instrumentation.
+
 # 0.1.6
 
 * Fix issues with Ruby 1.8.7 regexes

data/lib/scout_apm.rb

@@ -1,32 +1,57 @@
 module ScoutApm
 end
-require 'socket'
-require 'set'
+
+require 'cgi'
+require 'logger'
 require 'net/http'
 require 'openssl'
-require 'logger'
+require 'set'
+require 'socket'
 require 'yaml'
-require 'cgi'
 
-require File.expand_path('../scout_apm/version.rb', __FILE__)
-require File.expand_path('../scout_apm/agent.rb', __FILE__)
-require File.expand_path('../scout_apm/agent/logging.rb', __FILE__)
-require File.expand_path('../scout_apm/agent/reporting.rb', __FILE__)
-require File.expand_path('../scout_apm/layaway.rb', __FILE__)
-require File.expand_path('../scout_apm/layaway_file.rb', __FILE__)
-require File.expand_path('../scout_apm/config.rb', __FILE__)
-require File.expand_path('../scout_apm/background_worker.rb', __FILE__)
-require File.expand_path('../scout_apm/environment.rb', __FILE__)
-require File.expand_path('../scout_apm/metric_meta.rb', __FILE__)
-require File.expand_path('../scout_apm/metric_stats.rb', __FILE__)
-require File.expand_path('../scout_apm/stack_item.rb', __FILE__)
-require File.expand_path('../scout_apm/store.rb', __FILE__)
-require File.expand_path('../scout_apm/tracer.rb', __FILE__)
-require File.expand_path('../scout_apm/context.rb', __FILE__)
-require File.expand_path('../scout_apm/slow_transaction.rb', __FILE__)
-require File.expand_path('../scout_apm/capacity.rb', __FILE__)
-require File.expand_path('../scout_apm/instruments/process/process_cpu.rb', __FILE__)
-require File.expand_path('../scout_apm/instruments/process/process_memory.rb', __FILE__)
+require 'scout_apm/version'
+
+require 'scout_apm/server_integrations/passenger'
+require 'scout_apm/server_integrations/puma'
+require 'scout_apm/server_integrations/rainbows'
+require 'scout_apm/server_integrations/thin'
+require 'scout_apm/server_integrations/unicorn'
+require 'scout_apm/server_integrations/webrick'
+require 'scout_apm/server_integrations/null'
+
+require 'scout_apm/framework_integrations/rails_2'
+require 'scout_apm/framework_integrations/rails_3_or_4'
+require 'scout_apm/framework_integrations/sinatra'
+require 'scout_apm/framework_integrations/ruby'
+
+require 'scout_apm/app_server_load'
+
+require 'scout_apm/utils/sql_sanitizer'
+require 'scout_apm/utils/null_logger'
+require 'scout_apm/config'
+require 'scout_apm/environment'
+require 'scout_apm/agent'
+require 'scout_apm/agent/logging'
+require 'scout_apm/agent/reporting'
+require 'scout_apm/layaway'
+require 'scout_apm/layaway_file'
+require 'scout_apm/reporter'
+require 'scout_apm/background_worker'
+require 'scout_apm/metric_meta'
+require 'scout_apm/metric_stats'
+require 'scout_apm/stack_item'
+require 'scout_apm/store'
+require 'scout_apm/tracer'
+require 'scout_apm/context'
+require 'scout_apm/slow_transaction'
+require 'scout_apm/capacity'
+require 'scout_apm/instruments/process/process_cpu'
+require 'scout_apm/instruments/process/process_memory'
+
+
+require 'scout_apm/serializers/payload_serializer'
+require 'scout_apm/serializers/directive_serializer'
+require 'scout_apm/serializers/app_server_load_serializer'
 
 if defined?(Rails) and Rails.respond_to?(:version) and Rails.version >= '3'
   module ScoutApm

data/lib/scout_apm/agent.rb

@@ -1,8 +1,8 @@
 module ScoutApm
-  # The agent gathers performance data from a Ruby application. One Agent instance is created per-Ruby process. 
+  # The agent gathers performance data from a Ruby application. One Agent instance is created per-Ruby process.
   #
-  # Each Agent object creates a worker thread (unless monitoring is disabled or we're forking). 
-  # The worker thread wakes up every +Agent#period+, merges in-memory metrics w/those saved to disk, 
+  # Each Agent object creates a worker thread (unless monitoring is disabled or we're forking).
+  # The worker thread wakes up every +Agent#period+, merges in-memory metrics w/those saved to disk,
   # saves tshe merged data to disk, and sends it to the Scout server.
   class Agent
     # see self.instance
@@ -12,19 +12,18 @@ module ScoutApm
     attr_accessor :store
     attr_accessor :layaway
     attr_accessor :config
-    attr_accessor :environment
     attr_accessor :capacity
     attr_accessor :logger
     attr_accessor :log_file # path to the log file
     attr_accessor :options # options passed to the agent when +#start+ is called.
     attr_accessor :metric_lookup # Hash used to lookup metric ids based on their name and scope
 
-    # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process. 
+    # All access to the agent is thru this class method to ensure multiple Agent instances are not initialized per-Ruby process.
     def self.instance(options = {})
       @@instance ||= self.new(options)
     end
 
-    # Note - this doesn't start instruments or the worker thread. This is handled via +#start+ as we don't 
+    # Note - this doesn't start instruments or the worker thread. This is handled via +#start+ as we don't
     # want to start the worker thread or install instrumentation if (1) disabled for this environment (2) a worker thread shouldn't
     # be started (when forking).
     def initialize(options = {})
@@ -32,74 +31,108 @@ module ScoutApm
       @options ||= options
       @config = ScoutApm::Config.new(options[:config_path])
 
-      @store = ScoutApm::Store.new
-      @layaway = ScoutApm::Layaway.new
-      @metric_lookup = Hash.new
-      @process_cpu = ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors)
-      @process_memory = ScoutApm::Instruments::Process::ProcessMemory.new
-      @capacity = ScoutApm::Capacity.new
+      @store          = ScoutApm::Store.new
+      @layaway        = ScoutApm::Layaway.new
+      @metric_lookup  = Hash.new
+
+      @capacity       = ScoutApm::Capacity.new
     end
 
     def environment
-      @environment ||= ScoutApm::Environment.new
+      ScoutApm::Environment.instance
     end
 
-    # This is called via +ScoutApm::Agent.instance.start+ when ScoutApm is required in a Ruby application.
-    # It initializes the agent and starts the worker thread (if appropiate).
-    def start(options = {})
-      @options.merge!(options)
-      init_logger
-      logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
-      if !config.value('monitor') and !@options[:force]
+    def apm_enabled?
+      config.value('monitor') and !@options[:force]
+    end
+
+    def preconditions_met?
+      if !apm_enabled?
         logger.warn "Monitoring isn't enabled for the [#{environment.env}] environment."
         return false
-      elsif !config.value('name')
+      end
+
+      if !Environment.instance.application_name
         logger.warn "An application name is required. Specify the :name value in scout_apm.yml. Not starting agent."
         return false
-      elsif !environment.app_server
+      end
+
+      if !environment.app_server
         logger.warn "Couldn't find a supported app server. Not starting agent."
         return false
-      elsif started?
+      end
+
+      if started?
         logger.warn "Already started agent."
         return false
       end
+
+      true
+    end
+
+    # This is called via +ScoutApm::Agent.instance.start+ when ScoutApm is required in a Ruby application.
+    # It initializes the agent and starts the worker thread (if appropiate).
+    def start(options = {})
+      @options.merge!(options)
+      init_logger
+      logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
+
+      return false unless preconditions_met?
+
       @started = true
-      logger.info "Starting monitoring for [#{config.value('name')}]. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
+
+      logger.info "Starting monitoring for [#{environment.application_name}]. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
+
       load_instruments
-      if !start_background_worker?
+      @samplers = [
+        ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors, logger),
+        ScoutApm::Instruments::Process::ProcessMemory.new(logger)
+      ]
+
+      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
+        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."
-        install_passenger_events if environment.app_server == :passenger
-        install_unicorn_worker_loop if environment.app_server == :unicorn
-        install_rainbows_worker_loop if environment.app_server == :rainbows
-        install_puma_worker_loop if environment.app_server == :puma
-        return
+        environment.app_server_integration.install
       end
-      start_background_worker
-      handle_exit
-      logger.info "Scout Agent [#{ScoutApm::VERSION}] Initialized"
     end
-    
+
+    # Sends a ping to APM right away, smoothes out onboarding
+    # Collects up any relevant info (framework, app server, system time, ruby version, etc)
+    def app_server_load_hook
+      AppServerLoad.new.run
+    end
+
+    def exit_handler_unsupported?
+      environment.sinatra? || environment.jruby? || environment.rubinius?
+    end
+
     # at_exit, calls Agent#shutdown to wrapup metric reporting.
     def handle_exit
-      if environment.sinatra? || environment.jruby? || environment.rubinius?
-        logger.debug "Exit handler not supported"
-      else
-        at_exit do 
-          logger.debug "Shutdown!"
-          # MRI 1.9 bug drops exit codes.
-          # http://bugs.ruby-lang.org/issues/5218
-          if environment.ruby_19?
-            status = $!.status if $!.is_a?(SystemExit)
-            shutdown
-            exit status if status
-          else
-            shutdown
-          end
-        end # at_exit
+      logger.debug "Exit handler not supported" and return if exit_handler_unsupported?
+
+      at_exit do
+        logger.debug "Shutdown!"
+        # MRI 1.9 bug drops exit codes.
+        # http://bugs.ruby-lang.org/issues/5218
+        if environment.ruby_19?
+          status = $!.status if $!.is_a?(SystemExit)
+          shutdown
+          exit status if status
+        else
+          shutdown
+        end
       end
     end
-    
-    # Called via an at_exit handler, it (1) stops the background worker and (2) runs it a final time. 
+
+    # Called via an at_exit handler, it (1) stops the background worker and (2) runs it a final time.
     # The final run ensures metrics are stored locally to the layaway / reported to scoutapp.com. Otherwise,
     # in-memory metrics would be lost and a gap would appear on restarts.
     def shutdown
@@ -107,68 +140,21 @@ module ScoutApm
       @background_worker.stop
       @background_worker.run_once
     end
-    
+
     def started?
       @started
     end
-    
-    def gem_root
-      File.expand_path(File.join("..","..",".."), __FILE__)
-    end
-    
+
     # The worker thread will automatically start UNLESS:
     # * A supported application server isn't detected (example: running via Rails console)
-    # * A supported application server is detected, but it forks. In this case, 
+    # * A supported application server is detected, but it forks. In this case,
     #   the agent is started in the forked process.
     def start_background_worker?
-      !environment.forking? or environment.app_server == :thin # clarify why Thin is here but not WEBrick
-    end
-
-    ## TODO - Likely possible to unify starting the worker loop in forking servers by listening for the first transaction 
-    ## to start and starting the background worker then in that process.
-    
-    def install_passenger_events
-      PhusionPassenger.on_event(:starting_worker_process) do |forked|
-        logger.debug "Passenger is starting a worker process. Starting worker thread."
-        self.class.instance.start_background_worker
-      end
-      # The agent's at_exit hook doesn't run when a Passenger process stops. 
-      # 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.shutdown
-      end
-    end
-    
-    def install_unicorn_worker_loop
-      logger.debug "Installing Unicorn worker loop."
-      Unicorn::HttpServer.class_eval do
-        old = instance_method(:worker_loop)
-        define_method(:worker_loop) do |worker|
-          ScoutApm::Agent.instance.start_background_worker
-          old.bind(self).call(worker)
-        end
-      end
-    end
-    
-    def install_rainbows_worker_loop
-      logger.debug "Installing Rainbows worker loop."
-      Rainbows::HttpServer.class_eval do
-        old = instance_method(:worker_loop)
-        define_method(:worker_loop) do |worker|
-          ScoutApm::Agent.instance.start_background_worker
-          old.bind(self).call(worker)
-        end
-      end
-    end
+      return true if environment.app_server == :thin
+      return true if environment.app_server == :webrick
+      return false if environment.forking?
 
-    def install_puma_worker_loop
-      Puma.cli_config.options[:before_worker_boot] << Proc.new do
-        logger.debug "Installing Puma worker loop."
-        ScoutApm::Agent.instance.start_background_worker
-      end
-    rescue
-      logger.warn "Unable to install Puma worker loop: #{$!.message}"
+      false
     end
 
     # Creates the worker thread. The worker thread is a loop that runs continuously. It sleeps for +Agent#period+ and when it wakes,
@@ -182,29 +168,6 @@ module ScoutApm
       logger.debug "Done creating worker thread."
     end
 
-    # Called from #process_metrics, which is run via the background worker. 
-    def run_samplers
-      begin
-        cpu_util=@process_cpu.run # returns a hash
-        logger.debug "Process CPU: #{cpu_util.inspect} [#{environment.processors} CPU(s)]"
-        store.track!("CPU/Utilization",cpu_util,:scope => nil) if cpu_util
-      rescue => e
-        logger.info "Error reading ProcessCpu"
-        logger.debug e.message
-        logger.debug e.backtrace.join("\n")
-      end
-
-      begin
-        mem_usage=@process_memory.run # returns a single number, in MB
-        logger.debug "Process Memory: #{mem_usage}MB"
-        store.track!("Memory/Physical",mem_usage,:scope => nil) if mem_usage
-      rescue => e
-        logger.info "Error reading ProcessMemory"
-        logger.debug e.message
-        logger.debug e.backtrace.join("\n")
-      end
-    end
-
     # Loads the instrumention logic.
     def load_instruments
       logger.debug "Installing instrumentation"
@@ -223,5 +186,5 @@ module ScoutApm
       logger.warn $!.message
       logger.warn $!.backtrace
     end
-  end # class Agent
-end # module ScoutApm
+  end
+end

data/lib/scout_apm/agent/reporting.rb

@@ -2,8 +2,9 @@
 module ScoutApm
   class Agent
     module Reporting
-      CA_FILE     = File.join( File.dirname(__FILE__), *%w[.. .. .. data cacert.pem] )
-      VERIFY_MODE = OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+      def reporter
+        @reporter ||= ScoutApm::Reporter.new(config, logger)
+      end
 
       # Called in the worker thread. Merges in-memory metrics w/those on disk and reports metrics
       # to the server.
@@ -12,26 +13,35 @@ module ScoutApm
         run_samplers
         capacity.process
         payload = layaway.deposit_and_deliver
+
         metrics = payload[:metrics]
         slow_transactions = payload[:slow_transactions]
+
         if payload.any?
-          add_metric_ids(metrics)  
+          add_metric_ids(metrics)
+
           logger.warn "Some data may be lost - metric size is at limit" if metrics.size == ScoutApm::Store::MAX_SIZE
-          # for debugging, count the total number of requests    
+          # for debugging, count the total number of requests
           controller_count = 0
+
           metrics.each do |meta,stats|
             if meta.metric_name =~ /\AController/
               controller_count += stats.call_count
             end
           end
-          payload = Marshal.dump(:metrics => metrics, :slow_transactions => slow_transactions)
+
+          logger.debug("Metrics: #{metrics}")
+          logger.debug("SlowTrans: #{slow_transactions}")
+
+          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(',')}."        
-          response =  post( checkin_uri,
-                             payload,
-                             "Content-Type"     => "application/octet-stream" )
+          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(',')}."
+
+          response = reporter.report(payload)
+
           if response and response.is_a?(Net::HTTPSuccess)
-            directives = Marshal.load(response.body)
+            directives = ScoutApm::Serializers::DirectiveSerializer.deserialize(response.body)
+
             self.metric_lookup.merge!(directives[:metric_lookup])
             if directives[:reset]
               logger.info "Resetting metric_lookup."
@@ -39,16 +49,16 @@ module ScoutApm
             end
             logger.debug "Metric Cache Size: #{metric_lookup.size}"
           elsif response
-            logger.warn "Error on checkin to #{checkin_uri.to_s}: #{response.inspect}"
+            logger.warn "Error on checkin to #{reporter.uri.to_s}: #{response.inspect}"
           end
         end
       rescue
-        logger.warn "Error on checkin to #{checkin_uri.to_s}"
+        logger.warn "Error on checkin to #{reporter.uri.to_s}"
         logger.info $!.message
         logger.debug $!.backtrace
       end
 
-      # Before reporting, lookup metric_id for each MetricMeta. This speeds up 
+      # 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|
@@ -58,57 +68,18 @@ module ScoutApm
         end
       end
 
-      def checkin_uri
-        URI.parse("#{config.value('host')}/apps/checkin.scout?key=#{config.value('key')}&name=#{CGI.escape(config.value('name'))}")
-      end
-
-      def post(uri, body, headers = Hash.new)
-        response = nil
-        request(uri) do |connection|
-          post = Net::HTTP::Post.new( uri.path +
-                                      (uri.query ? ('?' + uri.query) : ''),
-                                      http_headers.merge(headers) )
-          post.body = body
-          response=connection.request(post)
-        end
-        response
-      end
-
-      def request(uri, &connector)
-        response           = nil
-        response           = http(uri).start(&connector)
-        logger.debug "got response: #{response.inspect}"
-        case response
-        when Net::HTTPSuccess, Net::HTTPNotModified
-          logger.debug "/checkin OK"
-        when Net::HTTPBadRequest
-          logger.warn "/checkin FAILED: The Account Key [#{config.value('key')}] is invalid."
-        else
-          logger.debug "/checkin FAILED: #{response.inspect}"
-        end
-      rescue Exception
-        logger.debug "Exception sending request to server: #{$!.message}\n#{$!.backtrace}"
-      ensure
-        response
-      end
-
-      # Headers passed up with all API requests.
-      def http_headers
-        @http_headers ||= { "Agent-Hostname" => environment.hostname }
-      end
-
-      # Take care of the http proxy, if specified in config.
-      # Given a blank string, the proxy_uri URI instance's host/port/user/pass will be nil.
-      # Net::HTTP::Proxy returns a regular Net::HTTP class if the first argument (host) is nil.
-      def http(url)
-        proxy_uri = URI.parse(config.value('proxy').to_s)
-        http = Net::HTTP::Proxy(proxy_uri.host,proxy_uri.port,proxy_uri.user,proxy_uri.password).new(url.host, url.port)
-        if url.is_a?(URI::HTTPS)
-          http.use_ssl = true
-          http.ca_file = CA_FILE
-          http.verify_mode = VERIFY_MODE
+      # Called from #process_metrics, which is run via the background worker.
+      def run_samplers
+        @samplers.each do |sampler|
+          begin
+            result = sampler.run
+            store.track!(sampler.metric_name, result, scope: nil) if result
+          rescue => e
+            logger.info "Error reading #{sampler.human_name}"
+            logger.debug e.message
+            logger.debug e.backtrace.join("\n")
+          end
         end
-        http
       end
     end # module Reporting
     include Reporting