scout_rails 1.0.5.pre → 1.0.5

data/CHANGELOG.markdown

@@ -1,8 +1,11 @@
-# 1.0.5.pre
+# 1.0.5
 
 * Removing duplicate Enviornment#unicorn? method 
 * Removing logging when not instrumenting unscoped method (confusing - looks like an error)
 * Recording ActiveRecord exists queries as MODEL#exists vs. SQL#UNKNOWN
+* Handling log_level config option and defaulting to 'info' instead of 'debug'
+* Not crashing the app when log file isn't writeable
+* Handling the :reset directive. Resets the metric_lookup when provided.
 
 # 1.0.4
 

data/lib/scout_rails/agent/logging.rb

@@ -0,0 +1,44 @@
+# Contains methods specific to logging (initializing the log file, applying the log level, applying the log format, etc.)
+module ScoutRails
+  class Agent
+    module Logging
+      def log_path
+        "#{environment.root}/log"
+      end
+      
+      def init_logger
+        @log_file = "#{log_path}/scout_rails.log"
+        begin 
+          @logger = Logger.new(@log_file) 
+          @logger.level = log_level
+          apply_log_format
+        rescue Exception => e
+          @logger = Logger.new(STDOUT)
+          apply_log_format
+          @logger.error "Unable to access log file: #{e.message}"
+        end
+        @logger
+      end
+
+      def apply_log_format
+        def logger.format_message(severity, timestamp, progname, msg)
+          # since STDOUT isn't exclusive like the scout_rails.log file, apply a prefix.
+          prefix = @logdev.dev == STDOUT ? "scout_rails " : ''
+          prefix + "[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{Socket.gethostname} (#{$$})] #{severity} : #{msg}\n"
+        end
+      end
+
+      def log_level
+        case config.settings['log_level'].downcase
+          when "debug" then Logger::DEBUG
+          when "info" then Logger::INFO
+          when "warn" then Logger::WARN
+          when "error" then Logger::ERROR
+          when "fatal" then Logger::FATAL
+          else Logger::INFO
+        end
+      end
+    end # module Logging
+    include Logging
+  end # class Agent
+end # moudle ScoutRails

data/lib/scout_rails/agent/reporting.rb

@@ -0,0 +1,97 @@
+# Methods related to sending metrics to scoutapp.com.
+module ScoutRails
+  class Agent
+    module Reporting
+      # Called in the worker thread. Merges in-memory metrics w/those on disk and reports metrics
+      # to the server.
+      def process_metrics
+        logger.debug "Processing metrics"
+        run_samplers
+        metrics = layaway.deposit_and_deliver
+        if metrics.any?
+          add_metric_ids(metrics)  
+          # 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        
+          logger.debug "#{config.settings['name']} Delivering metrics for #{controller_count} requests."        
+          response =  post( checkin_uri,
+                             Marshal.dump(:metrics => metrics, :sample => store.sample),
+                             "Content-Type"     => "application/json" )
+          if response and response.is_a?(Net::HTTPSuccess)
+            directives = Marshal.load(response.body)
+            self.metric_lookup.merge!(directives[:metric_lookup])
+            if directives[:reset]
+              logger.info "Resetting metric_lookup."
+              self.metric_lookup = Hash.new
+            end
+            store.transaction_sample_lock.synchronize do
+              store.sample = nil
+            end
+            logger.debug "Metric Cache Size: #{metric_lookup.size}"
+          end
+        end
+      rescue
+        logger.info "Error on checkin to #{checkin_uri.to_s}"
+        logger.info $!.message
+        logger.debug $!.backtrace
+      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
+      
+      def checkin_uri
+        URI.parse("http://#{config.settings['host']}/app/#{config.settings['key']}/checkin.scout?name=#{CGI.escape(config.settings['name'])}")
+      end
+
+      def post(url, body, headers = Hash.new)
+        response = nil
+        request(url) do |connection|
+          post = Net::HTTP::Post.new( url.path +
+                                      (url.query ? ('?' + url.query) : ''),
+                                      HTTP_HEADERS.merge(headers) )
+          post.body = body
+          response=connection.request(post)
+        end
+        response
+      end
+
+      def request(url, &connector)
+        response           = nil
+        response           = http(url).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.settings['key']}] is invalid."
+        else
+          logger.debug "/checkin FAILED: #{response.inspect}"
+        end
+      rescue Exception
+        logger.debug "Exception sending request to server: #{$!.message}"
+      ensure
+        response
+      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)
+        Net::HTTP::Proxy(proxy_uri.host,proxy_uri.port,proxy_uri.user,proxy_uri.password).new(url.host, url.port)
+      end
+    end # module Reporting
+    include Reporting
+  end # class Agent
+end # module ScoutRails

data/lib/scout_rails/agent.rb

@@ -7,7 +7,6 @@ module ScoutRails
   class Agent
     # Headers passed up with all API requests.
     HTTP_HEADERS = { "Agent-Hostname" => Socket.gethostname }
-    DEFAULT_HOST = 'scoutapp.com'
     # see self.instance
     @@instance = nil 
     
@@ -93,16 +92,6 @@ module ScoutRails
       File.expand_path(File.join("..","..",".."), __FILE__)
     end
     
-    def init_logger
-      @log_file = "#{log_path}/scout_rails.log"
-      @logger = Logger.new(@log_file)
-      @logger.level = Logger::DEBUG
-      def logger.format_message(severity, timestamp, progname, msg)
-        prefix = "[#{timestamp.strftime("%m/%d/%y %H:%M:%S %z")} #{Socket.gethostname} (#{$$})] #{severity} : #{msg}\n"
-      end
-      @logger
-    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 (Passenger). In this case, 
@@ -129,10 +118,6 @@ module ScoutRails
       end
     end
     
-    def log_path
-      "#{environment.root}/log"
-    end
-    
     # in seconds, time between when the worker thread wakes up and runs.
     def period
       60
@@ -167,26 +152,6 @@ module ScoutRails
       logger.debug "Done creating worker thread."
     end
     
-    # Writes each payload to a file for auditing.
-    def write_to_file(object)
-      logger.debug "Writing to file"
-      full_path = Pathname.new(RAILS_ROOT+'/log/audit/scout')
-      ( full_path +
-        "#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}.json" ).open("w") do |f|
-        f.puts object.to_json
-      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
-    
     # Called from #process_metrics, which is run via the worker thread. 
     def run_samplers
       begin
@@ -210,82 +175,6 @@ module ScoutRails
       end
     end
     
-    # Called in the worker thread. Merges in-memory metrics w/those on disk and reports metrics
-    # to the server.
-    def process_metrics
-      logger.debug "Processing metrics"
-      run_samplers
-      metrics = layaway.deposit_and_deliver
-      if metrics.any?
-        add_metric_ids(metrics)  
-        # 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        
-        logger.debug "#{config.settings['name']} Delivering metrics for #{controller_count} requests."        
-        response =  post( checkin_uri,
-                           Marshal.dump(:metrics => metrics, :sample => store.sample),
-                           "Content-Type"     => "application/json" )
-        if response and response.is_a?(Net::HTTPSuccess)
-          directives = Marshal.load(response.body)
-          self.metric_lookup.merge!(directives[:metric_lookup])
-          store.transaction_sample_lock.synchronize do
-            store.sample = nil
-          end
-          logger.debug "Metric Cache Size: #{metric_lookup.size}"
-        end
-      end
-    rescue
-      logger.info "Error on checkin to #{checkin_uri.to_s}"
-      logger.info $!.message
-      logger.debug $!.backtrace
-    end
-    
-    def checkin_uri
-      URI.parse("http://#{config.settings['host'] || DEFAULT_HOST}/app/#{config.settings['key']}/checkin.scout?name=#{CGI.escape(config.settings['name'])}")
-    end
-    
-    def post(url, body, headers = Hash.new)
-      response = nil
-      request(url) do |connection|
-        post = Net::HTTP::Post.new( url.path +
-                                    (url.query ? ('?' + url.query) : ''),
-                                    HTTP_HEADERS.merge(headers) )
-        post.body = body
-        response=connection.request(post)
-      end
-      response
-    end
-    
-    def request(url, &connector)
-      response           = nil
-      response           = http(url).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.settings['key']}] is invalid."
-      else
-        logger.debug "/checkin FAILED: #{response.inspect}"
-      end
-    rescue Exception
-      logger.debug "Exception sending request to server: #{$!.message}"
-    ensure
-      response
-    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)
-      Net::HTTP::Proxy(proxy_uri.host,proxy_uri.port,proxy_uri.user,proxy_uri.password).new(url.host, url.port)
-    end
-    
     # Loads the instrumention logic.
     def load_instruments
       case environment.framework

data/lib/scout_rails/config.rb

@@ -1,5 +1,10 @@
 module ScoutRails
-  class Config
+  class Config   
+    DEFAULTS =  {
+        'host' => 'scoutapp.com',
+        'log_level' => 'info'
+    }
+
     def initialize(config_path = nil)
       @config_path = config_path
     end
@@ -18,17 +23,20 @@ module ScoutRails
     end
     
     def load_file
-      if !File.exist?(config_file)
-        ScoutRails::Agent.instance.logger.warn "No config file found at [#{config_file}]."
+      begin
+        if !File.exist?(config_file)
+          ScoutRails::Agent.instance.logger.warn "No config file found at [#{config_file}]."
+          @settings = {}
+        else
+          @settings = YAML.load(ERB.new(File.read(config_file)).result(binding))[ScoutRails::Agent.instance.environment.env] || {} 
+        end  
+      rescue Exception => e
+        ScoutRails::Agent.instance.logger.warn "Unable to load the config file."
+        ScoutRails::Agent.instance.logger.warn e.message
+        ScoutRails::Agent.instance.logger.warn e.backtrace
         @settings = {}
-      else
-        @settings = YAML.load(ERB.new(File.read(config_file)).result(binding))[ScoutRails::Agent.instance.environment.env] || {} 
-      end  
-    rescue Exception => e
-      ScoutRails::Agent.instance.logger.warn "Unable to load the config file."
-      ScoutRails::Agent.instance.logger.warn e.message
-      ScoutRails::Agent.instance.logger.warn e.backtrace
-      @settings = {}
+      end
+      @settings = DEFAULTS.merge(@settings)
     end
-  end
-end
+  end # Config
+end # ScoutRails

data/lib/scout_rails/layaway.rb

@@ -12,19 +12,13 @@ class ScoutRails::Layaway
   
   def deposit_and_deliver
     new_data = ScoutRails::Agent.instance.store.metric_hash
-    controller_count = 0
-    new_data.each do |meta,stats|
-      if meta.metric_name =~ /\AController/
-        controller_count += stats.call_count
-      end
-    end
-    ScoutRails::Agent.instance.logger.debug "Depositing #{controller_count} requests into #{Time.at(slot).strftime("%m/%d/%y %H:%M:%S %z")} slot."
-    
+    log_deposited_requests(new_data)
     to_deliver = {}
     file.read_and_write do |old_data|
       old_data ||= Hash.new
       # merge data
-      # if the previous minute has ended, its time to send those metrics
+      # if (1) there's data in the file and (2) there isn't any data yet for the current minute, this means we've 
+      # collected all metrics for the previous slots and we're ready to deliver.
       if old_data.any? and old_data[slot].nil?
         to_deliver = old_data
         old_data = Hash.new
@@ -34,16 +28,7 @@ class ScoutRails::Layaway
         ScoutRails::Agent.instance.logger.debug "There is no data in the layaway file to deliver."
       end
       old_data[slot]=ScoutRails::Agent.instance.store.merge_data_and_clear(old_data[slot] || Hash.new)
-      ScoutRails::Agent.instance.logger.debug "Saving the following #{old_data.size} time slots locally:"
-      old_data.each do |k,v|
-        controller_count = 0
-        new_data.each do |meta,stats|
-          if meta.metric_name =~ /\AController/
-            controller_count += stats.call_count
-          end
-        end
-        ScoutRails::Agent.instance.logger.debug "#{Time.at(k).strftime("%m/%d/%y %H:%M:%S %z")} => #{controller_count} requests"
-      end
+      log_saved_requests(old_data,new_data)
       old_data
     end
     to_deliver.any? ? validate_data(to_deliver) : {}
@@ -73,4 +58,27 @@ class ScoutRails::Layaway
     t -= t.sec
     t.to_i
   end
+  
+  def log_deposited_requests(new_data)
+    controller_count = 0
+    new_data.each do |meta,stats|
+      if meta.metric_name =~ /\AController/
+        controller_count += stats.call_count
+      end
+    end
+    ScoutRails::Agent.instance.logger.debug "Depositing #{controller_count} requests into #{Time.at(slot).strftime("%m/%d/%y %H:%M:%S %z")} slot."
+  end
+  
+  def log_saved_requests(old_data,new_data)
+    ScoutRails::Agent.instance.logger.debug "Saving the following #{old_data.size} time slots locally:"
+    old_data.each do |k,v|
+      controller_count = 0
+      new_data.each do |meta,stats|
+        if meta.metric_name =~ /\AController/
+          controller_count += stats.call_count
+        end
+      end
+      ScoutRails::Agent.instance.logger.debug "#{Time.at(k).strftime("%m/%d/%y %H:%M:%S %z")} => #{controller_count} requests"
+    end
+  end
 end

data/lib/scout_rails/layaway_file.rb

@@ -35,8 +35,10 @@ class ScoutRails::LayawayFile
       end
     end
   rescue Errno::ENOENT, Exception  => e
-    ScoutRails::Agent.instance.logger.error(e.message)
+    ScoutRails::Agent.instance.logger.error("Unable to access the layaway file [#{e.message}]. The user running the app must have read+write access.")
     ScoutRails::Agent.instance.logger.debug(e.backtrace.split("\n"))
+    # ensure the in-memory metric hash is cleared so data doesn't continue to accumulate.
+    ScoutRails::Agent.instance.store.metric_hash = {}
   end
 
   def get_data(f)

data/lib/scout_rails/version.rb

@@ -1,3 +1,3 @@
 module ScoutRails
-  VERSION = "1.0.5.pre"
+  VERSION = "1.0.5"
 end

data/lib/scout_rails.rb

@@ -5,6 +5,8 @@ require 'set'
 require 'net/http'
 require File.expand_path('../scout_rails/version.rb', __FILE__)
 require File.expand_path('../scout_rails/agent.rb', __FILE__)
+require File.expand_path('../scout_rails/agent/logging.rb', __FILE__)
+require File.expand_path('../scout_rails/agent/reporting.rb', __FILE__)
 require File.expand_path('../scout_rails/layaway.rb', __FILE__)
 require File.expand_path('../scout_rails/layaway_file.rb', __FILE__)
 require File.expand_path('../scout_rails/config.rb', __FILE__)

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: scout_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.5.pre
-  prerelease: 6
+  version: 1.0.5
+  prerelease: 
 platform: ruby
 authors:
 - Derek Haynes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Monitors a Ruby on Rails application and reports detailed metrics on
   performance to Scout, a hosted monitoring service.
@@ -28,6 +28,8 @@ files:
 - Rakefile
 - lib/scout_rails.rb
 - lib/scout_rails/agent.rb
+- lib/scout_rails/agent/logging.rb
+- lib/scout_rails/agent/reporting.rb
 - lib/scout_rails/config.rb
 - lib/scout_rails/environment.rb
 - lib/scout_rails/instruments/active_record_instruments.rb
@@ -64,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: scout_rails
 rubygems_version: 1.8.10