scout_apm 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dab9d1dfbd7c814de188768159109981c7100a54
-  data.tar.gz: 85d434f1c0c82b3cb19d3ad72fc3c04de45ad958
+  metadata.gz: 5e446ee188c5294111023e7110aa649c3d1e0d6d
+  data.tar.gz: 28bf8811e6e819ea847b806ae3f5abf62c2531b2
 SHA512:
-  metadata.gz: 45d7d02378d1d103bc55067e67a0c13e3ea16d86bc790bddd8577b6b2ca70ff1d5ece8e01894a1995a40f2ef009b94149a9bd0b7b65443d27894114190fca1d9
-  data.tar.gz: cce129502472b05706abec00715bda69543049fdadf227f69cd2a5dd7626872a1a6ec86890f4ae400fe74ac3239c5d18da422264f2dfd0d2c2200a77cd4a937d
+  metadata.gz: 9b174e8e7a4aa643a6b7ae8491aab27d969b2b64c3513ee32911b2045b2b4d9703cbca2a011404f7fd9c4557c6ed45948dce8d0119f55eafdcbc17950d34a188
+  data.tar.gz: 292f67f6b0d69de6aaf2582f53dfb1faae882baaf66127431566ba1c30692f1d2b5fd018e45df2fd9da664dacd037013d97d98805f9908880ec898b558ec1af2

data/CHANGELOG.markdown

@@ -1,3 +1,17 @@
+# 0.1.3
+
+* Adds capacity calculation via "Instance/Capacity" metric. 
+* Tweaks tracing to still count a transaction if it results in a 500 error and includes it in accumulated time.
+* Adds per-transaction error tracking (ex: Errors/Controller/widgets/index)
+
+# 0.1.2
+
+* Adds Heroku support:
+  * Detects Heroku via the 'DYNO' environment variable
+  * Defaults logger to STDOUT
+  * uses the dyno name vs. the hostname as the hostname
+* Environment vars with "SCOUT_" prefix override any settings specified in the config file.
+
 # 0.1.1
 
 * Store the start time of slow requests.

data/lib/scout_apm.rb

@@ -24,6 +24,7 @@ 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__)
 

data/lib/scout_apm/agent.rb

@@ -5,8 +5,6 @@ module ScoutApm
   # 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
-    # Headers passed up with all API requests.
-    HTTP_HEADERS = { "Agent-Hostname" => Socket.gethostname }
     # see self.instance
     @@instance = nil 
     
@@ -15,7 +13,7 @@ module ScoutApm
     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.
@@ -38,6 +36,7 @@ module ScoutApm
       @metric_lookup = Hash.new
       @process_cpu=ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors)
       @process_memory=ScoutApm::Instruments::Process::ProcessMemory.new
+      @capacity = ScoutApm::Capacity.new
     end
     
     def environment
@@ -49,10 +48,13 @@ module ScoutApm
     def start(options = {})
       @options.merge!(options)
       init_logger
-      logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{Socket.gethostname}]"
-      if !config.settings['monitor'] and !@options[:force]
+      logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
+      if !config.value('monitor') and !@options[:force]
         logger.warn "Monitoring isn't enabled for the [#{environment.env}] environment."
         return false
+      elsif !config.value('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
         logger.warn "Couldn't find a supported app server. Not starting agent."
         return false
@@ -61,7 +63,7 @@ module ScoutApm
         return false
       end
       @started = true
-      logger.info "Starting monitoring. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
+      logger.info "Starting monitoring for [#{config.value('name')}]. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
       start_instruments
       if !start_background_worker?
         logger.debug "Not starting worker thread"

data/lib/scout_apm/agent/logging.rb

@@ -2,12 +2,13 @@
 module ScoutApm
   class Agent
     module Logging
-      def log_path
+
+      def default_log_path
         "#{environment.root}/log"
       end
       
       def init_logger
-        @log_file = "#{log_path}/scout_apm.log"
+        @log_file = wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
         begin 
           @logger = Logger.new(@log_file) 
           @logger.level = log_level
@@ -23,13 +24,13 @@ module ScoutApm
       def apply_log_format
         def logger.format_message(severity, timestamp, progname, msg)
           # since STDOUT isn't exclusive like the scout_apm.log file, apply a prefix.
-          prefix = @logdev.dev == STDOUT ? "scout_apm " : ''
-          prefix + "[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{Socket.gethostname} (#{$$})] #{severity} : #{msg}\n"
+          prefix = @logdev.dev == STDOUT ? "[Scout] " : ''
+          prefix + "[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{ScoutApm::Agent.instance.environment.hostname} (#{$$})] #{severity} : #{msg}\n"
         end
       end
 
       def log_level
-        case config.settings['log_level'].downcase
+        case config.value('log_level').downcase
           when "debug" then Logger::DEBUG
           when "info" then Logger::INFO
           when "warn" then Logger::WARN
@@ -38,6 +39,14 @@ module ScoutApm
           else Logger::INFO
         end
       end
+
+      def log_file_path
+        config.value('log_file_path') || default_log_path
+      end
+
+      def wants_stdout?
+        config.value('log_file_path').to_s.upcase == 'STDOUT' || environment.heroku?
+      end
     end # module Logging
     include Logging
   end # class Agent

data/lib/scout_apm/agent/reporting.rb

@@ -10,6 +10,7 @@ module ScoutApm
       def process_metrics
         logger.debug "Processing metrics"
         run_samplers
+        capacity.process
         payload = layaway.deposit_and_deliver
         metrics = payload[:metrics]
         slow_transactions = payload[:slow_transactions]
@@ -25,7 +26,7 @@ module ScoutApm
           end      
           payload = Marshal.dump(:metrics => metrics, :slow_transactions => slow_transactions)
           slow_transactions_kb = Marshal.dump(slow_transactions).size/1024 # just for performance debugging
-          logger.debug "#{config.settings['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.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" )
@@ -58,7 +59,7 @@ module ScoutApm
       end
       
       def checkin_uri
-        URI.parse("#{config.settings['host']}/apps/checkin.scout?key=#{config.settings['key']}&name=#{CGI.escape(config.settings['name'])}")
+        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)
@@ -66,7 +67,7 @@ module ScoutApm
         request(uri) do |connection|
           post = Net::HTTP::Post.new( uri.path +
                                       (uri.query ? ('?' + uri.query) : ''),
-                                      HTTP_HEADERS.merge(headers) )
+                                      http_headers.merge(headers) )
           post.body = body
           response=connection.request(post)
         end
@@ -81,7 +82,7 @@ module ScoutApm
         when Net::HTTPSuccess, Net::HTTPNotModified
           logger.debug "/checkin OK"
         when Net::HTTPBadRequest
-          logger.warn "/checkin FAILED: The Account Key [#{config.settings['key']}] is invalid."
+          logger.warn "/checkin FAILED: The Account Key [#{config.value('key')}] is invalid."
         else
           logger.debug "/checkin FAILED: #{response.inspect}"
         end
@@ -91,11 +92,16 @@ module ScoutApm
         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.settings['proxy'].to_s)
+        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

data/lib/scout_apm/capacity.rb

@@ -0,0 +1,54 @@
+# Encapsulates logic for determining capacity utilization of the Ruby processes.
+class ScoutApm::Capacity
+	attr_reader :processing_start_time, :accumulated_time, :transaction_entry_time
+
+	def initialize
+		@processing_start_time = Time.now
+		@lock ||= Mutex.new # the transaction_entry_time could be modified while processing a request or when #process is called.
+		@accumulated_time = 0.0
+	end
+	
+	# Called when a transaction is traced.
+	def start_transaction!
+		@lock.synchronize do
+			@transaction_entry_time = Time.now
+		end
+	end
+
+	# Called when a transaction completes to record its time used.
+	def finish_transaction!
+		@lock.synchronize do
+			if transaction_entry_time
+				@accumulated_time += (Time.now - transaction_entry_time).to_f
+			else
+				ScoutApm::Agent.instance.logger.warn "No transaction entry time. Not recording capacity metrics for transaction."
+			end
+			@transaction_entry_time = nil
+		end
+	end
+
+	# Ran when sending metrics to server. Reports capacity usage metrics.
+	def process
+		process_time = Time.now
+		ScoutApm::Agent.instance.logger.debug "Processing capacity usage for [#{@processing_start_time}] to [#{process_time}]. Time Spent: #{@accumulated_time}."
+		@lock.synchronize do
+			time_spent = @accumulated_time
+			@accumulated_time = 0.0
+			# If a transaction is still running, capture its running time up to now and 
+			# reset the +transaction_entry_time+ to now. 
+			if @transaction_entry_time
+				time_spent += (process_time - @transaction_entry_time).to_f
+				ScoutApm::Agent.instance.logger.debug "A transaction is running while calculating capacity. Start time: [#{transaction_entry_time}]. Will update the entry time to [#{process_time}]."
+				@transaction_entry_time = process_time # prevent from over-counting capacity usage. update the transaction start time to now.
+			end
+			time_spent = 0.0 if time_spent < 0.0
+
+			window = (process_time - processing_start_time).to_f # time period we are evaulating capacity usage.
+			window = 1.0 if window <= 0.0 # prevent divide-by-zero if clock adjusted.
+			capacity = time_spent / window
+			ScoutApm::Agent.instance.logger.debug "Instance/Capacity: #{capacity}"
+			ScoutApm::Agent.instance.store.track!("Instance/Capacity",capacity,:scope => nil)
+			@processing_start_time = process_time
+		end
+	end
+end

data/lib/scout_apm/config.rb

@@ -8,12 +8,15 @@ module ScoutApm
     def initialize(config_path = nil)
       @config_path = config_path
     end
-    
-    def settings
-      return @settings if @settings
-      load_file
+  
+    # Fetch a config value. It first attempts to fetch an ENV var prefixed with 'SCOUT_', then from the settings file.
+    def value(key)
+      value = ENV['SCOUT_'+key.upcase] || settings[key]
+      value.to_s.strip.length.zero? ? nil : value
     end
-    
+
+    private
+
     def config_path
       @config_path || File.join(ScoutApm::Agent.instance.environment.root,"config","scout_apm.yml")
     end
@@ -21,6 +24,11 @@ module ScoutApm
     def config_file
       File.expand_path(config_path)
     end
+
+    def settings
+      return @settings if @settings
+      load_file
+    end
     
     def load_file
       begin

data/lib/scout_apm/environment.rb

@@ -50,6 +50,14 @@ module ScoutApm
         '.'
       end
     end
+
+    def heroku?
+      ENV['DYNO']      
+    end
+
+    def hostname
+      heroku? ? ENV['DYNO'] : Socket.gethostname
+    end
     
     # This needs to be improved. Frequently, multiple app servers gem are present and which
     # ever is checked first becomes the designated app server. 

data/lib/scout_apm/layaway_file.rb

@@ -1,7 +1,7 @@
 # Logic for the serialized file access
 class ScoutApm::LayawayFile
   def path
-    "#{ScoutApm::Agent.instance.log_path}/scout_apm.db"
+    "#{ScoutApm::Agent.instance.default_log_path}/scout_apm.db"
   end
 
   def dump(object)

data/lib/scout_apm/tracer.rb

@@ -22,15 +22,23 @@ module ScoutApm::Tracer
       ScoutApm::Agent.instance.store.reset_transaction!  
       ScoutApm::Context.current.add_user(:ip => options[:ip]) if options[:ip]    
       Thread::current[:scout_apm_trace_time] = Time.now.utc
+      ScoutApm::Agent.instance.capacity.start_transaction!
+      e = nil
       instrument(metric_name, options) do
         Thread::current[:scout_apm_scope_name] = metric_name
-        yield
+        begin
+          yield
+        rescue Exception => e
+          ScoutApm::Agent.instance.store.track!("Errors/#{metric_name}",1, :scope => nil)
+        end
         Thread::current[:scout_apm_scope_name] = nil
       end
       Thread::current[:scout_apm_trace_time] = nil
+      ScoutApm::Agent.instance.capacity.finish_transaction!
       # The context is cleared after instrumentation (rather than before) as tracing controller-actions doesn't occur until the controller-action is called.
       # It does not trace before filters, which is a likely spot to add context. This means that any context applied during before_filters would be cleared.
       ScoutApm::Context.clear!
+      raise e if e
     end
     
     # Options:

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies: []
 description: Monitors Ruby apps and reports detailed metrics on performance to Scout.
 email:
@@ -29,6 +29,7 @@ files:
 - lib/scout_apm/agent/logging.rb
 - lib/scout_apm/agent/reporting.rb
 - lib/scout_apm/background_worker.rb
+- lib/scout_apm/capacity.rb
 - lib/scout_apm/config.rb
 - lib/scout_apm/context.rb
 - lib/scout_apm/environment.rb
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring