right_support 1.1.2 → 1.2.0

data/lib/right_support/ruby/object_extensions.rb

@@ -1,5 +1,22 @@
 module RightSupport::Ruby
   module ObjectExtensions
+    # Attempt to require one or more source files.
+    #
+    # This method is useful to conditionally define code depending on the availability
+    # of gems or standard-library source files.
+    #
+    # === Parameters
+    # Forwards all parameters transparently through to Kernel#require.
+    #
+    # === Return
+    # Returns true or false
+    def require_succeeds?(*args)
+      require(*args)
+      return true
+    rescue LoadError => e
+      return false
+    end
+
     # Attempt to require one or more source files; if the require succeeds (or
     # if the files have already been successfully required), yield to the block.
     #
@@ -7,8 +24,7 @@ module RightSupport::Ruby
     # of gems or standard-library source files. 
     #
     # === Parameters
-    # Uses a parameters glob to pass all of its parameters transparently through to
-    # Kernel#require.
+    # Forwards all parameters transparently through to Kernel#require.
     #
     # === Block
     # The block will be called if the require succeeds (if it does not raise LoadError).

data/lib/right_support/ruby/string_extensions.rb

@@ -0,0 +1,120 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rbconfig'
+
+module RightSupport::Ruby
+  module StringExtensions
+    if require_succeeds?('active_support')
+      ACTIVE_SUPPORT_WORKALIKES = false
+    else
+      ACTIVE_SUPPORT_WORKALIKES = true
+    end
+
+    # Convert to snake case.
+    #
+    #   "FooBar".snake_case           #=> "foo_bar"
+    #   "HeadlineCNNNews".snake_case  #=> "headline_cnn_news"
+    #   "CNN".snake_case              #=> "cnn"
+    #
+    # @return [String] Receiver converted to snake case.
+    #
+    # @api public
+    def snake_case
+      return downcase if match(/\A[A-Z]+\z/)
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z])([A-Z])/, '\1_\2').
+      downcase
+    end
+  
+    # Convert a constant name to a path, assuming a conventional structure.
+    #
+    #   "FooBar::Baz".to_const_path # => "foo_bar/baz"
+    #
+    # @return [String] Path to the file containing the constant named by receiver
+    #   (constantized string), assuming a conventional structure.
+    #
+    # @api public
+    def to_const_path
+      snake_case.gsub(/::/, "/")
+    end
+  
+    # Convert constant name to constant
+    #
+    #    "FooBar::Baz".to_const => FooBar::Baz
+    #
+    # @return [Constant] Constant corresponding to given name or nil if no
+    #   constant with that name exists
+    #
+    # @api public
+    def to_const
+      names = split('::')
+      names.shift if names.empty? || names.first.empty?
+  
+      constant = Object
+      names.each do |name|
+        # modified to return nil instead of raising an const_missing error
+        constant = constant && constant.const_defined?(name) ? constant.const_get(name) : nil
+      end
+      constant
+    end
+
+    # Reverse operation of snake case:
+    #
+    #    "some_string/some_other_string" => "SomeString::SomeOtherString"
+    #
+    # @return [String] Camelized string
+    #
+    # @api public
+    if !String.public_method_defined?(:camelize) && ACTIVE_SUPPORT_WORKALIKES
+      def camelize(first_letter = :upper)
+        case first_letter
+          when :upper then gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+          when :lower then first + camelize(self)[1..-1]
+        end
+      end
+    end
+
+    # Add ability to output colored text to console
+    # e.g.: puts "Hello".red
+    def bold; colorize("\e[1m\e[29m"); end
+    def grey; colorize("\e[30m"); end
+    def red; colorize("\e[1m\e[31m"); end
+    def dark_red; colorize("\e[31m"); end
+    def green; colorize("\e[1m\e[32m"); end
+    def dark_green; colorize("\e[32m"); end
+    def yellow; colorize("\e[1m\e[33m"); end
+    def blue; colorize("\e[1m\e[34m"); end
+    def dark_blue; colorize("\e[34m"); end
+    def pur; colorize("\e[1m\e[35m"); end
+    def colorize(color_code)
+      # Doesn't work with the Windows prompt...
+      @windows ||= RbConfig::CONFIG['host_os'] =~ /mswin|win32|dos|mingw|cygwin/i
+      (@windows || !$stdout.isatty) ? to_s : "#{color_code}#{to_s}\e[0m"
+    end
+  
+  end
+end
+
+class String
+  include RightSupport::Ruby::StringExtensions
+end

data/lib/right_support/stats.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  #
+  # A namespace for statistics tracking functionality.
+  #
+  module Stats
+
+  end
+end
+
+require 'right_support/stats/exceptions'
+require 'right_support/stats/helpers'
+require 'right_support/stats/activity'

data/lib/right_support/stats/activity.rb

@@ -0,0 +1,206 @@
+# Copyright (c) 2009-2012 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport::Stats
+  
+  # Track statistics for a given kind of activity
+  class Activity
+
+    # Number of samples included when calculating average recent activity
+    # with the smoothing formula A = ((A * (RECENT_SIZE - 1)) + V) / RECENT_SIZE,
+    # where A is the current recent average and V is the new activity value
+    # As a rough guide, it takes approximately 2 * RECENT_SIZE activity values
+    # at value V for average A to reach 90% of the original difference between A and V
+    # For example, for A = 0, V = 1, RECENT_SIZE = 3 the progression for A is
+    # 0, 0.3, 0.5, 0.7, 0.8, 0.86, 0.91, 0.94, 0.96, 0.97, 0.98, 0.99, ...
+    RECENT_SIZE = 3
+
+    # Maximum string length for activity type
+    MAX_TYPE_SIZE = 60
+
+    # (Integer) Total activity count
+    attr_reader :total
+
+    # (Hash) Count of activity per type
+    attr_reader :count_per_type
+
+    # Initialize activity data
+    #
+    # === Parameters
+    # measure_rate(Boolean):: Whether to measure activity rate
+    def initialize(measure_rate = true)
+      @measure_rate = measure_rate
+      reset
+    end
+
+    # Reset statistics
+    #
+    # === Return
+    # true:: Always return true
+    def reset
+      @interval = 0.0
+      @last_start_time = Time.now
+      @avg_duration = nil
+      @total = 0
+      @count_per_type = {}
+      @last_type = nil
+      @last_id = nil
+      true
+    end
+
+    # Mark the start of an activity and update counts and average rate
+    # with weighting toward recent activity
+    # Ignore the update if its type contains "stats"
+    #
+    # === Parameters
+    # type(String|Symbol):: Type of activity, with anything that is not a symbol, true, or false
+    #   automatically converted to a String and truncated to MAX_TYPE_SIZE characters,
+    #   defaults to nil
+    # id(String):: Unique identifier associated with this activity
+    #
+    # === Return
+    # now(Time):: Update time
+    def update(type = nil, id = nil)
+      now = Time.now
+      if type.nil? || !(type =~ /stats/)
+        @interval = average(@interval, now - @last_start_time) if @measure_rate
+        @last_start_time = now
+        @total += 1
+        unless type.nil?
+          unless [Symbol, TrueClass, FalseClass].include?(type.class)
+            type = type.inspect unless type.is_a?(String)
+            type = type[0, MAX_TYPE_SIZE - 3] + "..." if type.size > (MAX_TYPE_SIZE - 3)
+          end
+          @count_per_type[type] = (@count_per_type[type] || 0) + 1
+        end
+        @last_type = type
+        @last_id = id
+      end
+      now
+    end
+
+    # Mark the finish of an activity and update the average duration
+    #
+    # === Parameters
+    # start_time(Time):: Time when activity started, defaults to last time update was called
+    # id(String):: Unique identifier associated with this activity
+    #
+    # === Return
+    # duration(Float):: Activity duration in seconds
+    def finish(start_time = nil, id = nil)
+      now = Time.now
+      start_time ||= @last_start_time
+      duration = now - start_time
+      @avg_duration = average(@avg_duration || 0.0, duration)
+      @last_id = 0 if id && id == @last_id
+      duration
+    end
+
+    # Convert average interval to average rate
+    #
+    # === Return
+    # (Float|nil):: Recent average rate, or nil if total is 0
+    def avg_rate
+      if @total > 0
+        if @interval == 0.0 then 0.0 else 1.0 / @interval end
+      end
+    end
+
+
+    # Get average duration of activity
+    #
+    # === Return
+    # (Float|nil) Average duration in seconds of activity weighted toward recent activity, or nil if total is 0
+    def avg_duration
+      @avg_duration if @total > 0
+    end
+
+    # Get stats about last activity
+    #
+    # === Return
+    # (Hash|nil):: Information about last activity, or nil if the total is 0
+    #   "elapsed"(Integer):: Seconds since last activity started
+    #   "type"(String):: Type of activity if specified, otherwise omitted
+    #   "active"(Boolean):: Whether activity still active
+    def last
+      if @total > 0
+        result = {"elapsed" => (Time.now - @last_start_time).to_i}
+        result["type"] = @last_type if @last_type
+        result["active"] = @last_id != 0 if !@last_id.nil?
+        result
+      end
+    end
+
+    # Convert count per type into percentage by type
+    #
+    # === Return
+    # (Hash|nil):: Converted counts, or nil if total is 0
+    #   "total"(Integer):: Total activity count
+    #   "percent"(Hash):: Percentage for each type of activity if tracking type, otherwise omitted
+    def percentage
+      if @total > 0
+        percent = {}
+        @count_per_type.each { |k, v| percent[k] = (v / @total.to_f) * 100.0 }
+        {"percent" => percent, "total" => @total}
+      end
+    end
+
+    # Get stat summary including all aspects of activity that were measured except duration
+    #
+    # === Return
+    # (Hash|nil):: Information about activity, or nil if the total is 0
+    #   "total"(Integer):: Total activity count
+    #   "percent"(Hash):: Percentage for each type of activity if tracking type, otherwise omitted
+    #   "last"(Hash):: Information about last activity
+    #     "elapsed"(Integer):: Seconds since last activity started
+    #     "type"(String):: Type of activity if tracking type, otherwise omitted
+    #     "active"(Boolean):: Whether activity still active if tracking whether active, otherwise omitted
+    #   "rate"(Float):: Recent average rate if measuring rate, otherwise omitted
+    def all
+      if @total > 0
+        result = if @count_per_type.empty?
+          {"total" => @total}
+        else
+          percentage
+        end
+        result.merge!("last" => last)
+        result.merge!("rate" => avg_rate) if @measure_rate
+        result
+      end
+    end
+
+    protected
+
+    # Calculate smoothed average with weighting toward recent activity
+    #
+    # === Parameters
+    # current(Float|Integer):: Current average value
+    # value(Float|Integer):: New value
+    #
+    # === Return
+    # (Float):: New average
+    def average(current, value)
+      ((current * (RECENT_SIZE - 1)) + value) / RECENT_SIZE.to_f
+    end
+
+  end # Activity
+
+end # RightScale::Stats

data/lib/right_support/stats/exceptions.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2009-2012 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport::Stats
+
+  # Track statistics for exceptions
+  class Exceptions
+
+    include RightSupport::Log::Mixin
+
+    # Maximum number of recent exceptions to track per category
+    MAX_RECENT_EXCEPTIONS = 10
+
+    # (Hash) Exceptions raised per category with keys
+    #   "total"(Integer):: Total exceptions for this category
+    #   "recent"(Array):: Most recent as a hash of "count", "type", "message", "when", and "where"
+    attr_reader :stats
+    alias :all :stats
+
+    # Initialize exception data
+    #
+    # === Parameters
+    # server(Object):: Server where exceptions are originating, must be defined for callbacks
+    # callback(Proc):: Block with following parameters to be activated when an exception occurs
+    #   exception(Exception):: Exception
+    #   message(Packet):: Message being processed
+    #   server(Server):: Server where exception occurred
+    def initialize(server = nil, callback = nil)
+      @server = server
+      @callback = callback
+      reset
+    end
+
+    # Reset statistics
+    #
+    # === Return
+    # true:: Always return true
+    def reset
+      @stats = nil
+      true
+    end
+
+    # Track exception statistics and optionally make callback to report exception
+    # Catch any exceptions since this function may be called from within an EM block
+    # and an exception here would then derail EM
+    #
+    # === Parameters
+    # category(String):: Exception category
+    # exception(Exception):: Exception
+    #
+    # === Return
+    # true:: Always return true
+    def track(category, exception, message = nil)
+      begin
+        @callback.call(exception, message, @server) if @server && @callback && message
+        @stats ||= {}
+        exceptions = (@stats[category] ||= {"total" => 0, "recent" => []})
+        exceptions["total"] += 1
+        recent = exceptions["recent"]
+        last = recent.last
+        if last && last["type"] == exception.class.name && last["message"] == exception.message && last["where"] == exception.backtrace.first
+          last["count"] += 1
+          last["when"] = Time.now.to_i
+        else
+          backtrace = exception.backtrace.first if exception.backtrace
+          recent.shift if recent.size >= MAX_RECENT_EXCEPTIONS
+          recent.push({"count" => 1, "when" => Time.now.to_i, "type" => exception.class.name,
+                       "message" => exception.message, "where" => backtrace})
+        end
+      rescue Exception => e
+        logger.exception("Failed to track exception '#{exception}'", e, :trace) rescue nil
+      end
+      true
+    end
+
+  end # Exceptions
+
+end # RightSupport::Stats