right_support 1.4.1 → 2.0.0

data/lib/right_support/net/{balancing.rb → lb.rb}

@@ -24,10 +24,10 @@
 # A namespace to hold load-balancing policies to be used with RequestBalancer
 # and potentially other networking classes.
 #
-module RightSupport::Net::Balancing
+module RightSupport::Net::LB
 
 end
 
-Dir[File.expand_path('../balancing/*.rb', __FILE__)].each do |filename|
-  require filename
-end
+require 'right_support/net/lb/health_check'
+require 'right_support/net/lb/round_robin'
+require 'right_support/net/lb/sticky'

data/lib/right_support/net/{balancing → lb}/health_check.rb

@@ -22,7 +22,7 @@
 
 require 'set'
 
-module RightSupport::Net::Balancing
+module RightSupport::Net::LB
 
   # TODO refactor this class. We store too much unstructured data about EPs; should have a simple
   # class representing EP state, and then perhaps move what logic remains into the HealthCheck class

data/lib/right_support/net/{balancing → lb}/round_robin.rb

@@ -20,7 +20,7 @@
 # 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::Net::Balancing
+module RightSupport::Net::LB
   class RoundRobin
 
     def initialize(options ={})

data/lib/right_support/net/{balancing/sticky_policy.rb → lb/sticky.rb}

@@ -20,8 +20,7 @@
 # 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::Net::Balancing
-
+module RightSupport::Net::LB
   # Implementation concepts: Create a policy that selects an endpoint and sticks with it.
   #
   # The policy should:
@@ -30,7 +29,7 @@ module RightSupport::Net::Balancing
   # - re-iterate through each endpoint when it's endpoint loses validity;
   # - return an Exception if it performs a complete iteration though each endpoint and finds none valid;
 
-  class StickyPolicy
+  class Sticky
 
     def initialize(options = {})
       @health_check = options.delete(:health_check)

data/lib/right_support/net/request_balancer.rb

@@ -108,7 +108,7 @@ module RightSupport::Net
         raise ArgumentError, "Must specify at least one endpoint"
       end
 
-      @options[:policy] ||= RightSupport::Net::Balancing::RoundRobin
+      @options[:policy] ||= RightSupport::Net::LB::RoundRobin
       @policy = @options[:policy]
       @policy = @policy.new(options) if @policy.is_a?(Class)
 

data/lib/right_support/rack.rb

@@ -29,5 +29,6 @@ module RightSupport
   end
 end
 
-require 'right_support/rack/custom_logger'
+require 'right_support/rack/log_setter'
 require 'right_support/rack/request_logger'
+require 'right_support/rack/request_tracker'

data/lib/right_support/rack/{custom_logger.rb → log_setter.rb}

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# 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
@@ -23,11 +23,15 @@
 require 'logger'
 
 module RightSupport::Rack
-  # A Rack middleware that allows an arbitrary object to be used as the Rack logger.
-  # This is more flexible than Rack's built-in Logger middleware, which always logs
-  # to a file-based Logger and doesn't allow you to control anything other than the
-  # filename.
-  class CustomLogger
+  # A Rack middleware that logs information about every HTTP request received and
+  # every exception raised while processing a request.
+  #
+  # The middleware can be configured to use its own logger, but defaults to using
+  # env['rack.logger'] for logging if it is present. If 'rack.logger' is not set,
+  # this middleware will set it before calling the next middleware. Therefore,
+  # RequestLogger can be used standalone to fulfill all logging needs, or combined
+  # with Rack::Logger or another middleware that provides logging services.
+  class LogSetter
     # Initialize an instance of the middleware. For backward compatibility, the order of the
     # logger and level parameters can be switched.
     #
@@ -36,22 +40,9 @@ module RightSupport::Rack
     # logger(Logger):: (optional) the Logger object to use, defaults to a STDERR logger
     # level(Integer):: (optional) a Logger level-constant (INFO, ERROR) to set the logger to
     #
-    def initialize(app, arg1=nil, arg2=nil)
-      if arg1.is_a?(Integer)
-        level = arg1
-      elsif arg1.is_a?(Logger)
-        logger = arg1
-      end
-
-      if arg2.is_a?(Integer)
-        level = arg2
-      elsif arg2.is_a?(Logger)
-        logger = arg2
-      end
-
+    def initialize(app, options={})
       @app    = app
-      @logger = logger
-      @level  = level
+      @logger = options[:logger]
     end
 
     # Add a logger to the Rack environment and call the next middleware.
@@ -62,18 +53,15 @@ module RightSupport::Rack
     # === Return
     # always returns whatever value is returned by the next layer of middleware
     def call(env)
-      #emulate the behavior of Rack::CommonLogger middleware, which instantiates a
-      #default logger if one has not been provided in the initializer
-      @logger = ::Logger.new(env['rack.errors'] || STDERR) unless @logger
-
-      if @level
-        old_level = @logger.level
-        @logger.level = @level
+      if @logger
+        logger = @logger
+      elsif env['rack.logger']
+        logger = env['rack.logger']
       end
-      env['rack.logger'] = @logger
-      status, header, body = @app.call(env)
-      @logger.level = old_level if @level
-      return [status, header, body]
+
+      env['rack.logger'] ||= logger
+
+      return @app.call(env)
     end
-  end
+   end
 end

data/lib/right_support/rack/request_logger.rb

@@ -32,17 +32,13 @@ module RightSupport::Rack
   # RequestLogger can be used standalone to fulfill all logging needs, or combined
   # with Rack::Logger or another middleware that provides logging services.
   class RequestLogger
-    # Initialize an instance of the middleware. For backward compatibility, the order of the
-    # logger and level parameters can be switched.
+    # Initialize an instance of the middleware.
     #
     # === Parameters
     # app(Object):: the inner application or middleware layer; must respond to #call
-    # logger(Logger):: (optional) the Logger object to use, defaults to a STDERR logger
-    # level(Integer):: (optional) a Logger level-constant (INFO, ERROR) to set the logger to
     #
-    def initialize(app, options={})
-      @app    = app
-      @logger = options[:logger]
+    def initialize(app)
+      @app = app
     end
 
     # Add a logger to the Rack environment and call the next middleware.
@@ -53,17 +49,13 @@ module RightSupport::Rack
     # === Return
     # always returns whatever value is returned by the next layer of middleware
     def call(env)
-      if @logger
-        logger = @logger
-      elsif env['rack.logger']
-        logger = env['rack.logger']
-      end
-
-      env['rack.logger'] ||= logger
+      logger = env["rack.logger"]
 
       began_at = Time.now
+
+      log_request_begin(logger, env)
       status, header, body = @app.call(env)
-      log_request(logger, env, status, began_at)
+      log_request_end(logger, env, status, began_at)
       log_exception(logger, env['sinatra.error']) if env['sinatra.error']
 
       return [status, header, body]
@@ -74,10 +66,15 @@ module RightSupport::Rack
 
     private
 
-    # NON Logger functions below
-    def log_request(logger, env, status, began_at)
-      duration = Time.now - began_at
-
+    # Log beginning of request
+    #
+    # === Parameters
+    # logger(Object):: the Rack logger
+    # env(Hash):: the Rack environment
+    #
+    # === Return
+    # always returns true
+    def log_request_begin(logger, env)
       # Assuming remote addresses are IPv4, make them all align to the same width
       remote_addr = env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"
       remote_addr = remote_addr.ljust(15)
@@ -96,13 +93,42 @@ module RightSupport::Rack
         env["PATH_INFO"],
         query_info,
         env["HTTP_VERSION"],
+        env["rack.request_uuid"] || ''
+      ]
+
+      logger.info %Q{Begin: %s "%s %s%s %s" %s} % params
+    end
+
+    # Log end of request
+    #
+    # === Parameters
+    # logger(Object):: the Rack logger
+    # env(Hash):: the Rack environment
+    # status(Fixnum):: status of the Rack request
+    # began_at(Time):: time of the Rack request begging
+    #
+    # === Return
+    # always returns true
+    def log_request_end(logger, env, status, began_at)
+      duration = Time.now - began_at
+      
+      params = [
         status,
-        duration
+        duration,
+        env["rack.request_uuid"] || ''
       ]
 
-      logger.info %Q{%s "%s %s%s %s" %d %0.3f} % params
+      logger.info %Q{End: %d %0.3f %s} % params
     end
 
+    # Log exception
+    #
+    # === Parameters
+    # logger(Object):: the Rack logger
+    # e(Exception):: Exception to be logged
+    #
+    # === Return
+    # always returns true
     def log_exception(logger, e)
       msg = ["#{e.class} - #{e.message}", *e.backtrace].join("\n")
       logger.error(msg)

data/lib/right_support/{config/recursive_true_class.rb → rack/request_tracker.rb}

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012 RightScale Inc
+# Copyright (c) 2011 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,44 +20,44 @@
 # 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::Config
-  
-  # Recursive(according to []) implementation of TrueClass.
-  # To use, just do: true1 = RecTrueClass.new
-  # now you can do true1['a'], true1['a']['b'], ...
-  # and it will return
-  class RecursiveTrueClass
-    
-    def initialize
-      @value = true    
-    end
-     
-    def [](something)
-      self
-    end
- 
-    # supporting standart boolean 
-    # opeimplementation 
-    def ==(other)
-      @value==other
-    end
+module RightSupport::Rack
+  # TODO docs
+  class RequestTracker
+    REQUEST_LINEAGE_UUID_HEADER = "HTTP_X_REQUEST_LINEAGE_UUID".freeze
+    REQUEST_UUID_HEADER         = "X-Request-Uuid".freeze
+    REQUEST_UUID_ENV_NAME       = "rack.request_uuid".freeze
+    UUID_SEPARATOR              = " ".freeze
 
-    def &(other)
-      @value & other
+    # Make a new Request tracker.
+    #
+    # Tags the requset with a new request UUID
+    #
+    # === Parameters
+    # app(Rack client): application to run
+    def initialize(app)
+      @app = app
     end
 
-    def ^(other)
-      @value ^ other
-    end
+    def call(env)
+      if env.has_key? REQUEST_LINEAGE_UUID_HEADER
+        request_uuid = env[REQUEST_LINEAGE_UUID_HEADER] + UUID_SEPARATOR +
+                       generate_request_uuid
+      else
+        request_uuid = generate_request_uuid
+      end
 
-    def to_s
-      @value.to_s
-    end
+      env[REQUEST_UUID_ENV_NAME] = request_uuid
+
+      status, headers, body = @app.call(env)
 
-    def |(other)
-      @value | other
+      headers[REQUEST_UUID_HEADER] = request_uuid
+      [status, headers,body]
     end
 
+
+    def generate_request_uuid
+      ::RightSupport::Data::UUID.generate
+    end
   end
 
-end
+end

data/lib/right_support/ruby/object_extensions.rb

@@ -16,28 +16,6 @@ module RightSupport::Ruby
     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.
-    #
-    # 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.
-    #
-    # === Block
-    # The block will be called if the require succeeds (if it does not raise LoadError).
-    #
-    # === Return
-    # Preserves the return value of Kernel#require (generally either true or false).
-    def if_require_succeeds(*args)
-      result = require(*args)
-      yield if block_given?
-      return result
-    rescue LoadError => e
-      return false
-    end
   end
 end
 

data/lib/right_support/stats/helpers.rb

@@ -33,6 +33,9 @@ module RightSupport
     # Maximum characters in sub-stat value line
     MAX_SUB_STAT_VALUE_WIDTH = 80
 
+    # Maximum characters displayed for exception message
+    MAX_EXCEPTION_MESSAGE_WIDTH = 60
+
     # Separator between stat name and stat value
     SEPARATOR = " : "
 
@@ -130,67 +133,37 @@ module RightSupport
       end
     end
 
-    # Wrap string by breaking it into lines at the specified separators
-    # Allow for presence of color encoding when measuring string length
+    # Wrap string by breaking it into lines at the specified separator
     #
     # === Parameters
     # string(String):: String to be wrapped
-    # max_length(Integer|Array):: Maximum length of a line, or array containing
-    #   maximum length of first line followed by maximum for any subsequent line
-    #   including indent
-    # indent(String):: Indentation for each line after first
-    # separators(Regexp):: Separators where string can wrap
+    # max_length(Integer):: Maximum length of a line excluding indentation
+    # indent(String):: Indentation for each line
+    # separator(String):: Separator at which to make line breaks
     #
     # === Return
-    # (String|Array):: Multi-line string
-    def self.wrap(string, max_length, indent, separators)
-      # Strip color encoding from string
-      strip = lambda { |string| string.gsub(/\e\[[0-9]*m/, "") }
-
-      # Split string at specified separators and return an array of arrays
-      # containing string segments and associated separator
-      split = lambda do |string, separators|
-        head, sep, tail = string.partition(separators)
-        if tail == ""
-          [[head, sep]]
-        else
-          [[head, sep]].concat(split.call(tail, separators))
-        end
-      end
-
+    # (String):: Multi-line string
+    def self.wrap(string, max_length, indent, separator)
       all = []
-      line = ["", last_sep = ""]
-      limit = max_length.is_a?(Array) ? max_length[0] : max_length
-      length = 0
-      separators = /#{separators}/ if separators.is_a?(String)
-      split.call(string, separators).each do |str, sep|
-        if (length + strip.call(str).size + last_sep.size + sep.size) > limit
-          all.push(line) unless line[0] == ""
-          line = [indent, last_sep = ""]
-          length = indent.size
-          limit = max_length.is_a?(Array) ? max_length[1] : max_length
+      line = ""
+      for l in string.split(separator)
+        if (line + l).length >= max_length
+          all.push(line)
+          line = ""
         end
-        line[0] += (str = last_sep + str)
-        line[1] = last_sep = sep
-        length += strip.call(str).size
+        line += line == "" ? l : separator + l
       end
-      all.push(line)
-      all[0..-2].inject("") { |a, (str, sep)| a + str + sep + "\n" } + all[-1][0]
+      all.push(line).join(separator + "\n" + indent)
     end
 
     # Format UTC time value
     #
     # === Parameters
     # time(Integer):: Time in seconds in Unix-epoch to be formatted
-    # with_year(Boolean):: Whether to include year, defaults to false
     #
     # (String):: Formatted time string
-    def self.time_at(time, with_year = false)
-      if with_year
-        Time.at(time).strftime("%a %b %d %H:%M:%S %Y")
-      else
-        Time.at(time).strftime("%a %b %d %H:%M:%S")
-      end
+    def self.time_at(time)
+      Time.at(time).strftime("%a %b %d %H:%M:%S")
     end
 
     # Sort hash elements by key in ascending order into array of key/value pairs
@@ -219,9 +192,9 @@ module RightSupport
     # Converts server statistics to a displayable format
     #
     # === Parameters
-    # stats(Hash):: Statistics with generic keys "name", "identity", "hostname", "revision", "service uptime",
+    # stats(Hash):: Statistics with generic keys "name", "identity", "hostname", "service uptime",
     #   "machine uptime", "memory KB", "stat time", "last reset time", "version", and "broker" with
-    #   the latter two and "revision", "machine uptime", "memory KB", "version", and "broker" being optional;
+    #   the latter two and "machine uptime", "memory KB", "version", and "broker" being optional;
     #   any other keys ending with "stats" have an associated hash value that is displayed in sorted
     #   key order, unless "stats" is preceded by a non-blank, in which case that character is prepended
     #   to the key to drive the sort order
@@ -229,6 +202,7 @@ module RightSupport
     #   :name_width(Integer):: Maximum characters in displayed stat name
     #   :sub_name_width(Integer):: Maximum characters in displayed sub-stat name
     #   :sub_stat_value_width(Integer):: Maximum characters in displayed sub-stat value line
+    #   :exception_message_width(Integer):: Maximum characters displayed for exception message
     #
     # === Return
     # (String):: Display string
@@ -237,12 +211,9 @@ module RightSupport
 
       str = stats["name"] ? sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "name", stats["name"]) : ""
       str += sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "identity", stats["identity"]) +
-             sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "hostname", stats["hostname"])
-      if stats.has_key?("revision")
-        str += sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "revision", stats["revision"])
-      end
-      str += sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "stat time", time_at(stats["stat time"], with_year = true)) +
-             sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "last reset", time_at(stats["last reset time"], with_year = true)) +
+             sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "hostname", stats["hostname"]) +
+             sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "stat time", time_at(stats["stat time"])) +
+             sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "last reset", time_at(stats["last reset time"])) +
              sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "service up", elapsed(stats["service uptime"]))
       if stats.has_key?("machine uptime")
         str += sprintf("%-#{name_width}s#{SEPARATOR}%s\n", "machine up", elapsed(stats["machine uptime"]))
@@ -285,6 +256,7 @@ module RightSupport
     #   :name_width(Integer):: Fixed width for left-justified name display
     #   :sub_name_width(Integer):: Maximum characters in displayed sub-stat name
     #   :sub_stat_value_width(Integer):: Maximum characters in displayed sub-stat value line
+    #   :exception_message_width(Integer):: Maximum characters displayed for exception message
     #
     # === Return
     # str(String):: Broker display with one line per broker plus exceptions
@@ -330,8 +302,7 @@ module RightSupport
       str += if brokers["returns"].nil? || brokers["returns"].empty?
         "none\n"
       else
-        wrap(activity_str(brokers["returns"]), [sub_stat_value_width, sub_stat_value_width + sub_value_indent.size],
-             sub_value_indent, /, /) + "\n"
+        wrap(activity_str(brokers["returns"]), sub_stat_value_width, sub_value_indent, ", ") + "\n"
       end
     end
 
@@ -354,6 +325,7 @@ module RightSupport
     #   :name_width(Integer):: Fixed width for left-justified name display
     #   :sub_name_width(Integer):: Maximum characters in displayed sub-stat name
     #   :sub_stat_value_width(Integer):: Maximum characters in displayed sub-stat value line
+    #   :exception_message_width(Integer):: Maximum characters displayed for exception message
     #
     # === Return
     # (String):: Single line display of stat
@@ -377,15 +349,13 @@ module RightSupport
           if v.empty? || v["total"] == 0
             "none"
           elsif v["total"]
-            wrap(activity_str(v), [sub_stat_value_width, sub_stat_value_width + sub_value_indent.size],
-                 sub_value_indent, ", ")
+            wrap(activity_str(v), sub_stat_value_width, sub_value_indent, ", ")
           elsif k =~ /last$/
             last_activity_str(v)
           elsif k == "exceptions"
             exceptions_str(v, sub_value_indent, options)
           else
-            wrap(hash_str(v), [sub_stat_value_width, sub_stat_value_width + sub_value_indent.size],
-                 sub_value_indent, /, /)
+            wrap(hash_str(v), sub_stat_value_width, sub_value_indent, ", ")
           end
         else
           "#{v || "none"}"
@@ -457,19 +427,20 @@ module RightSupport
     #   "recent"(Array):: Most recent as a hash of "count", "type", "message", "when", and "where"
     # indent(String):: Indentation for each line
     # options(Hash):: Formatting options
-    #   :sub_stat_value_width(Integer):: Maximum characters in displayed sub-stat value line
+    #   :exception_message_width(Integer):: Maximum characters displayed for exception message
     #
     # === Return
     # (String):: Exceptions in displayable format with line separators
     def self.exceptions_str(exceptions, indent, options = {})
-      sub_stat_value_width = options[:sub_stat_value_width] || MAX_SUB_STAT_VALUE_WIDTH
+      exception_message_width = options[:exception_message_width] || MAX_EXCEPTION_MESSAGE_WIDTH
       indent2 = indent + (" " * 4)
       exceptions.to_a.sort.map do |k, v|
         sprintf("%s total: %d, most recent:\n", k, v["total"]) + v["recent"].reverse.map do |e|
-          where = " IN #{e["where"]}" if e["where"]
-          indent + wrap("(#{e["count"]}) #{time_at(e["when"])} #{e["type"]}: #{e["message"]}#{where}",
-                        [sub_stat_value_width, sub_stat_value_width + indent2.size],
-                        indent2, / |\/\/|\/|::|\.|-/)
+          message = e["message"]
+          if message && message.size > (exception_message_width - 3)
+            message = e["message"][0, exception_message_width - 3] + "..."
+          end
+          indent + "(#{e["count"]}) #{time_at(e["when"])} #{e["type"]}: #{message}\n" + indent2 + "#{e["where"]}"
         end.join("\n")
       end.join("\n" + indent)
     end