right_agent 0.14.0 → 0.16.2

data/README.rdoc

@@ -20,6 +20,8 @@ documentation.
 Also use the built-in issues tracker (https://github.com/rightscale/right_agent/issues)
 to report issues.
 
+Maintained by the RightScale Teal Team
+
 == Interface
 
 A RightAgent exposes its services via actors and methods that are invoked by requests

data/lib/right_agent/actors/agent_manager.rb

@@ -81,7 +81,7 @@ class AgentManager
   # === Return
   # (OperationResult):: Empty success result or error result with message
   def profile(options)
-    require 'memprof'
+    return error_result("The memprof gem is not available for profiling.  Please install memprof 0.3 manually") unless require_succeeds?('memprof')
 
     options = RightScale::SerializationHelper.symbolize_keys(options || {})
     if options[:start]

data/lib/right_agent/agent.rb

@@ -38,8 +38,8 @@ module RightScale
     # (Hash) Configuration options applied to the agent
     attr_reader :options
 
-    # (Dispatcher) Dispatcher for messages received
-    attr_reader :dispatcher
+    # (Hash) Dispatcher for each queue for messages received
+    attr_reader :dispatchers
 
     # (ActorRegistry) Registry for this agents actors
     attr_reader :registry
@@ -373,7 +373,7 @@ module RightScale
     def terminate(reason = nil, exception = nil, &block)
       block ||= DEFAULT_TERMINATE_BLOCK
       begin
-        @history.update("stop")
+        @history.update("stop") if @history
         Log.error("[stop] Terminating because #{reason}", exception, :trace) if reason
         if @terminating || @broker.nil?
           @terminating = true
@@ -381,7 +381,7 @@ module RightScale
           @termination_timer = nil
           Log.info("[stop] Terminating immediately")
           block.call
-          @history.update("graceful exit") if @broker.nil?
+          @history.update("graceful exit") if @history && @broker.nil?
         else
           @terminating = true
           @check_status_timer.cancel if @check_status_timer
@@ -417,7 +417,7 @@ module RightScale
         "version"         => AgentConfig.protocol_version,
         "brokers"         => @broker.stats(reset),
         "agent stats"     => agent_stats(reset),
-        "receive stats"   => @dispatcher.stats(reset),
+        "receive stats"   => dispatcher_stats(reset),
         "send stats"      => @sender.stats(reset),
         "last reset time" => @last_stat_reset_time.to_i,
         "stat time"       => now.to_i,
@@ -463,7 +463,7 @@ module RightScale
       stats
     end
 
-    # Reset cache statistics
+    # Reset agent statistics
     #
     # === Return
     # true:: Always return true
@@ -476,6 +476,14 @@ module RightScale
       true
     end
 
+    # Get dispatcher statistics
+    #
+    # === Return
+    # (Hash):: Current statistics
+    def dispatcher_stats(reset)
+      @dispatchers[@identity].stats(reset)
+    end
+
     # Set the agent's configuration using the supplied options
     #
     # === Parameters
@@ -539,7 +547,7 @@ module RightScale
     def start_service(&terminate_callback)
       begin
         @registry = ActorRegistry.new
-        @dispatcher = create_dispatcher
+        @dispatchers = create_dispatchers
         @sender = create_sender
         load_actors
         setup_traps
@@ -562,13 +570,14 @@ module RightScale
       true
     end
 
-    # Create dispatcher for handling incoming requests
+    # Create dispatcher per queue for use in handling incoming requests
     #
     # === Return
-    # (Dispatcher):: New dispatcher
-    def create_dispatcher
+    # [Hash]:: Dispatchers with queue name as key
+    def create_dispatchers
       cache = DispatchedCache.new(@identity) if @options[:dup_check]
-      Dispatcher.new(self, cache)
+      dispatcher = Dispatcher.new(self, cache)
+      @queues.inject({}) { |dispatchers, queue| dispatchers[queue] = dispatcher; dispatchers }
     end
 
     # Create manager for outgoing requests
@@ -720,9 +729,14 @@ module RightScale
     # true:: Always return true
     def dispatch_request(request, queue)
       begin
-        if result = @dispatcher.dispatch(request)
-          exchange = {:type => :queue, :name => "response", :options => {:durable => true, :no_declare => @options[:secure]}}
-          @broker.publish(exchange, result, :persistent => true, :mandatory => true, :log_filter => [:tries, :persistent, :duration])
+        if (dispatcher = @dispatchers[queue])
+          if (result = dispatcher.dispatch(request))
+            exchange = {:type => :queue, :name => request.reply_to, :options => {:durable => true, :no_declare => @options[:secure]}}
+            @broker.publish(exchange, result, :persistent => true, :mandatory => true, :log_filter => [:request_from, :tries, :persistent, :duration])
+          end
+        else
+          Log.error("Failed to dispatch request #{request.trace} from queue #{queue} because no dispatcher configured")
+          @request_failure_stats.update("NoConfiguredDispatcher")
         end
       rescue Dispatcher::DuplicateRequest
       rescue RightAMQP::HABrokerClient::NoConnectedBrokers => e

data/lib/right_agent/agent_config.rb

@@ -63,7 +63,7 @@ module RightScale
   module AgentConfig
 
     # Current agent protocol version
-    PROTOCOL_VERSION = 20
+    PROTOCOL_VERSION = 21
 
     # Current agent protocol version
     #

data/lib/right_agent/agent_identity.rb

@@ -97,13 +97,12 @@ module RightScale
     # (AgentIdentity):: Corresponding agent identity
     #
     # === Raise
-    # (RightScale::Exceptions::Argument):: Serialized agent identity is incorrect
+    # (RightScale::Exceptions::Argument):: Serialized agent identity is invalid
     def self.parse(serialized_id)
-      serialized_id = self.compatible_serialized(serialized_id)
-      prefix, agent_type, token, bid, separator = parts(serialized_id)
-      raise RightScale::Exceptions::Argument, "Invalid agent identity token" unless prefix && agent_type && token && bid
+      prefix, agent_type, token, bid, separator = parts(self.compatible_serialized(serialized_id))
+      raise RightScale::Exceptions::Argument, "Invalid agent identity: #{serialized_id.inspect}" unless prefix && agent_type && token && bid
       base_id = bid.to_i
-      raise RightScale::Exceptions::Argument, "Invalid agent identity token (Base ID)" unless base_id.to_s == bid
+      raise RightScale::Exceptions::Argument, "Invalid agent identity base ID: #{bid ? bid : bid.inspect}" unless base_id.to_s == bid
 
       AgentIdentity.new(prefix, agent_type, base_id, token, separator)
     end

data/lib/right_agent/agent_tag_manager.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009 RightScale Inc
+# Copyright (c) 2009-2013 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,7 +20,6 @@
 # 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 RightScale
 
   # Agent tags management
@@ -43,7 +42,7 @@ module RightScale
     #
     # === Return
     # true:: Always return true
-    def tags(options={})
+    def tags(options = {})
       do_query(nil, @agent.identity, options) do |result|
         if result.kind_of?(Hash)
           yield(result.size == 1 ? result.values.first['tags'] : [])
@@ -57,7 +56,7 @@ module RightScale
     # of the given tags.
     #
     # === Parameters
-    # tags(Array):: tags to query or empty
+    # tags(String, Array):: Tag or tags to query or empty
     # options(Hash):: Request options
     #   :raw(Boolean):: true to yield raw tag response instead of deserialized tags
     #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
@@ -68,14 +67,8 @@ module RightScale
     #
     # === Return
     # true:: Always return true
-    def query_tags(*tags)
-      if tags.last.respond_to?(:keys)
-        tags = tags[0..-2]
-        options = tags.last
-      else
-        options = {}
-      end
-
+    def query_tags(tags, options = {})
+      tags = ensure_flat_array_value(tags) unless tags.nil? || tags.empty?
       do_query(tags, nil, options) { |result| yield result }
     end
 
@@ -83,7 +76,7 @@ module RightScale
     # of the given tags. Yields the raw response (for responding locally).
     #
     # === Parameters
-    # tags(Array):: tags to query or empty
+    # tags(String, Array):: Tag or tags to query or empty
     # agent_ids(Array):: agent IDs to query or empty or nil
     # options(Hash):: Request options
     #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
@@ -93,15 +86,16 @@ module RightScale
     #
     # === Return
     # true:: Always return true
-    def query_tags_raw(tags, agent_ids = nil, options={})
-      options = options.merge(:raw=>true)
+    def query_tags_raw(tags, agent_ids = nil, options = {})
+      tags = ensure_flat_array_value(tags) unless tags.nil? || tags.empty?
+      options = options.merge(:raw => true)
       do_query(tags, agent_ids, options) { |raw_response| yield raw_response }
     end
 
     # Add given tags to agent
     #
     # === Parameters
-    # new_tags(Array):: Tags to be added
+    # new_tags(String, Array):: Tag or tags to be added
     #
     # === Block
     # A block is optional. If provided, should take one argument which will be set with the
@@ -109,14 +103,15 @@ module RightScale
     #
     # === Return
     # true always return true
-    def add_tags(*new_tags)
+    def add_tags(new_tags)
+      new_tags = ensure_flat_array_value(new_tags) unless new_tags.nil? || new_tags.empty?
       update_tags(new_tags, []) { |raw_response| yield raw_response if block_given? }
     end
 
     # Remove given tags from agent
     #
     # === Parameters
-    # old_tags(Array):: Tags to be removed
+    # old_tags(String, Array):: Tag or tags to be removed
     #
     # === Block
     # A block is optional. If provided, should take one argument which will be set with the
@@ -124,7 +119,8 @@ module RightScale
     #
     # === Return
     # true always return true
-    def remove_tags(*old_tags)
+    def remove_tags(old_tags)
+      old_tags = ensure_flat_array_value(old_tags) unless old_tags.nil? || old_tags.empty?
       update_tags([], old_tags) { |raw_response| yield raw_response if block_given? }
     end
 
@@ -171,7 +167,7 @@ module RightScale
     # === Return
     # true::Always return true
     def clear
-      update_tags([], tags) { |raw_response| yield raw_response }
+      update_tags([], @agent.tags) { |raw_response| yield raw_response }
     end
 
     private
@@ -183,10 +179,10 @@ module RightScale
     # Runs a tag query with an optional list of tags.
     #
     # === Parameters
-    # tags(Array):: tags to query or empty or nil
-    # agent_ids(Array):: agent IDs to query or empty or nil
+    # tags(Array):: Tags to query or empty or nil
+    # agent_ids(Array):: IDs of agents to query with empty or nil meaning all agents in deployment
     # options(Hash):: Request options
-    #   :raw(Boolean):: true to yield raw tag response instead of deserialized tags
+    #   :raw(Boolean):: true to yield raw tag response instead of unserialized tags
     #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
     #
     # === Block
@@ -195,7 +191,7 @@ module RightScale
     #
     # === Return
     # true:: Always return true
-    def do_query(tags = nil, agent_ids = nil, options={})
+    def do_query(tags = nil, agent_ids = nil, options = {})
       raw = options[:raw] || false
       timeout = options[:timeout]
 
@@ -241,4 +237,5 @@ module RightScale
   # to the old typename
   # TODO remove this alias for RightAgent 1.0
   AgentTagsManager = AgentTagManager
+
 end # RightScale

data/lib/right_agent/core_payload_types/executable_bundle.rb

@@ -123,7 +123,7 @@ module RightScale
     # === Return
     # desc(String):: Auditable description
     def to_s
-      desc = @executables.collect { |e| e.nickname }.join(', ') if @executables
+      desc = @executables.collect { |e| e.title }.join(', ') if @executables
       desc ||= 'empty bundle'
     end
   end

data/lib/right_agent/core_payload_types/recipe_instantiation.rb

@@ -62,5 +62,12 @@ module RightScale
       [ @nickname, @attributes, @id, @ready, @external_inputs, @input_flags ]
     end
 
+    # Human readable title
+    #
+    # === Return
+    # @return [String] title for display
+    def title
+      nickname
+    end
   end
 end

data/lib/right_agent/core_payload_types/right_script_instantiation.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2011 RightScale Inc
+# Copyright (c) 2009-2013 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -41,7 +41,7 @@ module RightScale
     # (Array) RightScript attachments URLs, array of RightScriptAttachment
     attr_accessor :attachments
     
-    # (Array) RightScripts required packages
+    # (String) RightScripts required packages as a space-delimited list of package names or empty
     attr_accessor :packages
 
     # (Integer) RightScript id
@@ -50,7 +50,7 @@ module RightScale
     # (Boolean) Whether script inputs are ready
     attr_accessor :ready
 
-    # (Array of SecureDocumentLocation) attributes that must be resolved by the instance
+    # (Hash) a map of input names to CredentialLocations which must be retrieved by the instance or nil or empty
     attr_accessor :external_inputs
 
     # (Hash) nil or Hash of input name to flags (array of string tokens) indicating additional
@@ -58,6 +58,9 @@ module RightScale
     # flag means true, absense means false.
     attr_accessor :input_flags
 
+    # (String) Displayable version for RightScript (revision, etc.) or nil
+    attr_accessor :display_version
+
     def initialize(*args)
       @nickname        = args[0] if args.size > 0
       @source          = args[1] if args.size > 1
@@ -68,12 +71,24 @@ module RightScale
       @ready           = args[6] if args.size > 6
       @external_inputs = args[7] if args.size > 7
       @input_flags     = args[8] if args.size > 8
+      @display_version = args[9] if args.size > 9
     end
     
     # Array of serialized fields given to constructor
     def serialized_members
-      [ @nickname, @source, @parameters, @attachments, @packages, @id, @ready, @external_inputs, @input_flags ]
+      [ @nickname, @source, @parameters, @attachments, @packages, @id, @ready, @external_inputs, @input_flags, @display_version ]
+    end
+
+    # Human readable title
+    #
+    # === Return
+    # @return [String] title for display
+    def title
+      if @display_version
+        "'#{nickname}' #{@display_version}"
+      else
+        nickname
+      end
     end
-    
   end
 end

data/lib/right_agent/exceptions.rb

@@ -22,9 +22,52 @@
 
 module RightScale
   class Exceptions
-    class Application < RuntimeError; end
+    # Capability not currently supported
+    class NotSupported < Exception; end
+
+    # Internal application error
+    class Application < RuntimeError
+      attr_reader :nested_exception
+      def initialize(message, nested_exception = nil)
+        @nested_exception = nested_exception
+        super(message)
+      end
+    end
+
+    # Invalid command or method argument
     class Argument < RuntimeError; end
+
+    # Agent command IO error
     class IO < RuntimeError; end
+
+    # Agent compute platform error
     class PlatformError < StandardError; end
+
+    # Cannot connect or lost connection to external resource
+    class ConnectivityFailure < RuntimeError
+      attr_reader :nested_exception
+      def initialize(message, nested_exception = nil)
+        @nested_exception = nested_exception
+        super(message)
+      end
+    end
+
+    # Request failed but potentially will succeed if retried
+    class RetryableError < RuntimeError
+      attr_reader :nested_exception
+      def initialize(message, nested_exception = nil)
+        @nested_exception = nested_exception
+        super(message)
+      end
+    end
+
+    # Database query failed
+    class QueryFailure < RuntimeError
+      attr_reader :nested_exception
+      def initialize(message, nested_exception = nil)
+        @nested_exception = nested_exception
+        super(message)
+      end
+    end
   end
 end

data/lib/right_agent/history.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2011 RightScale Inc
+# 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
@@ -20,6 +20,8 @@
 # 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 'fileutils'
+
 module RightScale
 
   # Agent history manager
@@ -44,6 +46,7 @@ module RightScale
     # true:: Always return true
     def update(event)
       @last_update = {:time => Time.now.to_i, :pid => @pid, :event => event}
+      FileUtils.mkdir_p(File.dirname(@history)) unless File.exists?(File.dirname(@history))
       File.open(@history, "a") { |f| f.puts @last_update.to_json }
       true
     end