right_agent 0.6.6 → 0.9.3

data/lib/right_agent/packets.rb

@@ -1,4 +1,4 @@
-# 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
@@ -49,6 +49,13 @@ module RightScale
     # Shard scope value meaning restrict sending request only to agents with no shard id
     GLOBAL = 0
 
+    # Instance variables that are not serialized because they are only used locally
+    NOT_SERIALIZED = ["received_at"]
+
+    # (Float) Time in seconds in Unix-epoch when message was received
+    attr_accessor :received_at
+
+    # (Integer) Size of packet in bytes
     attr_accessor :size
 
     def initialize
@@ -87,7 +94,11 @@ module RightScale
     def to_msgpack(*a)
       msg = {
         'msgpack_class' => self.class.name,
-        'data'          => instance_variables.inject({}) { |m, ivar| m[ivar.to_s.sub(/@/,'')] = instance_variable_get(ivar); m },
+        'data'          => instance_variables.inject({}) do |m, ivar|
+                             name = ivar.to_s.sub(/@/, '')
+                             m[name] = instance_variable_get(ivar) unless NOT_SERIALIZED.include?(name)
+                             m
+                           end,
         'size'          => nil
       }.to_msgpack(*a)
       @size = msg.size
@@ -111,7 +122,11 @@ module RightScale
 
       js = {
         'json_class' => class_name,
-        'data'       => instance_variables.inject({}) { |m, ivar| m[ivar.to_s.sub(/@/,'')] = instance_variable_get(ivar); m }
+        'data'       => instance_variables.inject({}) do |m, ivar|
+                          name = ivar.to_s.sub(/@/, '')
+                          m[name] = instance_variable_get(ivar) unless NOT_SERIALIZED.include?(name)
+                          m
+                        end
       }.to_json(*a)
       @size = js.size
       js = js.chop + ",\"size\":#{@size}}"
@@ -137,7 +152,11 @@ module RightScale
       v = __send__(version) if version
       v = (v && v != DEFAULT_VERSION) ? " v#{v}" : ""
       log_msg = "[#{name}#{v}]"
-      duration = ", #{enough_precision(@duration)} sec" if @duration && (filter.nil? || filter.include?(:duration))
+      duration = if @duration && (filter.nil? || filter.include?(:duration))
+        ", #{enough_precision(@duration)} sec"
+      elsif @received_at && (filter.nil? || filter.include?(:local_duration))
+        ", #{enough_precision(Time.now.to_f - @received_at)} sec"
+      end
       log_msg += " (#{@size.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")} bytes#{duration})" if @size && !@size.to_s.empty?
       log_msg
     end
@@ -175,6 +194,23 @@ module RightScale
       if id == modified_id then modified_id else "*#{modified_id}" end
     end
 
+    # Generate log friendly serialized identity for one or more ids
+    # Limit to 1000 bytes
+    #
+    # === Parameters
+    # ids(Array|String):: Serialized identity or array of serialized identities
+    #
+    # === Return
+    # (String):: Log friendly serialized identity
+    def ids_to_s(ids)
+      if ids.is_a?(Array)
+        s = ids.each { |i| id_to_s(i) }.join(', ')
+        s.size > 1000 ? "[#{s[0, 1000]}...]" : "[#{s}]"
+      else
+        id_to_s(ids)
+      end
+    end
+
     # Convert serialized AgentIdentity to compatible format
     #
     # === Parameters
@@ -209,17 +245,7 @@ module RightScale
     def trace
       audit_id = self.respond_to?(:payload) && payload.is_a?(Hash) && (payload['audit_id'] || payload[:audit_id])
       tok = self.respond_to?(:token) && token
-      tr = ''
-      if audit_id || tok
-        tr = '<'        
-        if audit_id 
-          tr += audit_id.to_s
-          tr += ':' if tok
-        end
-        tr += tok if tok
-        tr += '>'
-      end
-      tr  
+      tr = "<#{audit_id || nil}> <#{tok}>" 
     end
 
     # Retrieve protocol version of original creator of packet
@@ -266,7 +292,7 @@ module RightScale
     #   :reply_to(String):: Identity of the node that actor replies to, usually a mapper itself
     #   :selector(Symbol):: Selector used to route the request: :any or :all, defaults to :any,
     #     :all deprecated for version 13 and above
-    #   :target(String):: Target recipient
+    #   :target(String|Array):: Target recipient(s)
     #   :persistent(Boolean):: Indicates if this request should be saved to persistent storage
     #     by the AMQP broker
     #   :expires_at(Integer|nil):: Time in seconds in Unix-epoch when this request expires and
@@ -339,14 +365,14 @@ module RightScale
       log_msg = "#{super(filter, version)} #{trace} #{@type}"
       log_msg += " #{payload}" if payload
       log_msg += " from #{id_to_s(@from)}" if filter.nil? || filter.include?(:from)
-      log_msg += ", target #{id_to_s(@target)}" if @target && (filter.nil? || filter.include?(:target))
+      log_msg += ", target #{ids_to_s(@target)}" if @target && (filter.nil? || filter.include?(:target))
       log_msg += ", scope #{@scope.inspect}" if @scope && (filter.nil? || filter.include?(:scope))
       log_msg += ", fanout" if (filter.nil? || filter.include?(:fanout)) && fanout?
       log_msg += ", reply_to #{id_to_s(@reply_to)}" if @reply_to && (filter.nil? || filter.include?(:reply_to))
       log_msg += ", tags #{@tags.inspect}" if @tags && !@tags.empty? && (filter.nil? || filter.include?(:tags))
       log_msg += ", persistent" if @persistent && (filter.nil? || filter.include?(:persistent))
       log_msg += ", tries #{tries_to_s}" if @tries && !@tries.empty? && (filter.nil? || filter.include?(:tries))
-      log_msg += ", payload #{@payload.inspect}" if filter.nil? || filter.include?(:payload)
+      log_msg += ", payload #{@payload.inspect}" if filter && filter.include?(:payload)
       log_msg
     end
 
@@ -395,7 +421,7 @@ module RightScale
     #   :scope(Hash):: Define behavior that should be used to resolve tag based routing
     #   :token(String):: Generated request id that a mapper uses to identify replies
     #   :selector(Symbol):: Selector used to route the request: :any or :all, defaults to :any
-    #   :target(String):: Target recipient
+    #   :target(String|Array):: Target recipient(s)
     #   :persistent(Boolean):: Indicates if this request should be saved to persistent storage
     #     by the AMQP broker
     #   :confirm(Boolean):: Whether require confirmation response from mapper containing targets
@@ -403,8 +429,6 @@ module RightScale
     #   :expires_at(Integer|nil):: Time in seconds in Unix-epoch when this request expires and
     #      is to be ignored by the receiver; value 0 means never expire; defaults to 0
     #   :tags(Array(Symbol)):: List of tags to be used for selecting target for this request
-    #   :tries(Array):: List of tokens for previous attempts to send this request (only here
-    #     for consistency with Request)
     # version(Array):: Protocol version of the original creator of the packet followed by the
     #   protocol version of the packet contents to be used when sending
     # size(Integer):: Size of request in bytes used only for marshalling
@@ -473,12 +497,12 @@ module RightScale
       log_msg = "#{super(filter, version)} #{trace} #{@type}"
       log_msg += " #{payload}" if payload
       log_msg += " from #{id_to_s(@from)}" if filter.nil? || filter.include?(:from)
-      log_msg += ", target #{id_to_s(@target)}" if @target && (filter.nil? || filter.include?(:target))
+      log_msg += ", target #{ids_to_s(@target)}" if @target && (filter.nil? || filter.include?(:target))
       log_msg += ", scope #{@scope.inspect}" if @scope && (filter.nil? || filter.include?(:scope))
       log_msg += ", fanout" if (filter.nil? || filter.include?(:fanout)) && fanout?
       log_msg += ", tags #{@tags.inspect}" if @tags && !@tags.empty? && (filter.nil? || filter.include?(:tags))
       log_msg += ", persistent" if @persistent && (filter.nil? || filter.include?(:persistent))
-      log_msg += ", payload #{@payload.inspect}" if filter.nil? || filter.include?(:payload)
+      log_msg += ", payload #{@payload.inspect}" if filter && filter.include?(:payload)
       log_msg
     end
 

data/lib/right_agent/platform/darwin.rb

@@ -63,15 +63,40 @@ module RightScale
         return nil
       end
 
-      # Path to directory containing generated agent configuration files
+      # Directory containing generated agent configuration files
+      # @deprecated
       def cfg_dir
-        '/etc/right_agent'
+        warn "cfg_dir is deprecated; please use right_agent_cfg_dir"
+        right_agent_cfg_dir
       end
 
+      # RightScale state directory for the current platform
+      # @deprecated
       def right_scale_state_dir
+        warn "right_scale_state_dir is deprecated; please use either right_scale_static_state_dir or right_agent_dynamic_state_dir"
+        right_scale_static_state_dir
+      end
+
+      # Directory containing generated agent configuration files
+      def right_agent_cfg_dir
+        '/etc/right_agent'
+      end
+
+      # Static (time-invariant) state that is common to all RightScale apps/agents
+      def right_scale_static_state_dir
         '/etc/rightscale.d'
       end
 
+      # Static (time-invariant) state that is specific to RightLink
+      def right_link_static_state_dir
+        '/etc/rightscale.d/right_link'
+      end
+
+      # Dynamic, persistent runtime state that is specific to RightLink
+      def right_link_dynamic_state_dir
+        '/var/lib/rightscale/right_link'
+      end
+
       def spool_dir
         '/var/spool'
       end
@@ -235,6 +260,12 @@ module RightScale
         return `ps -o rss= -p #{pid}`.to_i
       end
     end
+    
+    class Installer
+      def install(packages)
+        raise "not yet implemented"
+      end
+    end
 
   end # Platform
 

data/lib/right_agent/platform/linux.rb

@@ -114,15 +114,40 @@ module RightScale
         return nil
       end
 
-      # Path to directory containing generated agent configuration files
+      # Directory containing generated agent configuration files
+      # @deprecated
       def cfg_dir
-        '/etc/right_agent'
+        warn "cfg_dir is deprecated; please use right_agent_cfg_dir"
+        right_agent_cfg_dir
       end
 
+      # RightScale state directory for the current platform
+      # @deprecated
       def right_scale_state_dir
+        warn "right_scale_state_dir is deprecated; please use either right_scale_static_state_dir or right_agent_dynamic_state_dir"
+        right_scale_static_state_dir
+      end
+
+      # Directory containing generated agent configuration files
+      def right_agent_cfg_dir
+        '/var/lib/rightscale/right_agent'
+      end
+
+      # Static (time-invariant) state that is common to all RightScale apps/agents
+      def right_scale_static_state_dir
         '/etc/rightscale.d'
       end
 
+      # Static (time-invariant) state that is specific to RightLink
+      def right_link_static_state_dir
+        '/etc/rightscale.d/right_link'
+      end
+
+      # Dynamic, persistent runtime state that is specific to RightLink
+      def right_link_dynamic_state_dir
+        '/var/lib/rightscale/right_link'
+      end
+
       def spool_dir
         '/var/spool'
       end
@@ -417,6 +442,77 @@ module RightScale
         return `ps -o rss= -p #{pid}`.to_i
       end
     end
+    
+    class Installer
+      # The output generated by the Installer class
+      attr_accessor :output
+      
+      @output = ""
+      
+      class PackageNotFound < Exception; end
+      class PackageManagerNotFound < Exception; end
+      
+      # Does this machine have aptitude
+      #
+      # === Return
+      # true:: If aptitude is available in the expected directory
+      # false:: Otherwise
+      def aptitude?
+        File.executable? '/usr/bin/apt-get'
+      end
+      
+      # Does this machine have yum
+      #
+      # === Return
+      # true:: If yum is available in the expected directory
+      # false:: Otherwise
+      def yum?
+        File.executable? '/usr/bin/yum'
+      end
+      
+      # Does this machine have zypper
+      #
+      # === Return
+      # true:: If zypper is available in the expected directory
+      # false:: Otherwise
+      def zypper?
+        File.executable? '/usr/bin/zypper'
+      end
+      
+      # Install packages based on installed package manager
+      #
+      # === Parameters
+      # command_name(Array):: Array of packages names to be installed
+      #
+      # === Return
+      # true:: If installations of all packages was successfull
+      # false:: Otherwise
+      def install(packages)
+        return true if packages.empty?
+        
+        packages = packages.uniq.join(' ')
+        failed_packages = []
+        
+        if yum?
+          command = "yum install -y #{packages} 2>&1"
+          regex   = /No package (.*) available\./
+        elsif aptitude?
+          ENV['DEBIAN_FRONTEND'] = "noninteractive"
+          command = "apt-get install -y #{packages} 2>&1"
+          regex = /E: Couldn't find package (.*)/
+        elsif zypper?
+          command = "zypper --no-gpg-checks -n #{packages} 2>&1"
+          regex = /Package '(.*)' not found\./
+        else
+          raise PackageManagerNotFound, "No package manager binary (apt, yum, zypper) found in /usr/bin"
+        end
+        
+        @output = `#{command}`
+        @output.scan(regex) { |package| failed_packages << package.first }
+        raise PackageNotFound, "The following packages were not available: #{failed_packages.join(', ')}" unless failed_packages.empty?
+        return true
+      end
+    end
 
   end # Platform
 

data/lib/right_agent/platform/windows.rb

@@ -60,7 +60,6 @@ module RightScale
 
     attr_reader :flavor, :release
 
-    # TODO Initialize flavor and release (need to run on windows to finalize)
     def init
       getversionex = Win32API.new("kernel32", "GetVersionEx", 'P', 'L')
       osversioninfo = [
@@ -74,6 +73,8 @@ module RightScale
 
       raise 'Failed to detect Windows version' if 0 == getversionex.call(osversioninfo)  # zero is failure
       version = osversioninfo.unpack('LLLLLZ128') # 'Z' means ASCIIZ string
+      @flavor = 'windows'  # there can be only one
+      @release = "#{version[1]}.#{version[2]}.#{version[3]}"
     end
 
     class Filesystem
@@ -136,15 +137,39 @@ module RightScale
       end
 
       # Directory containing generated agent configuration files
+      # @deprecated
       def cfg_dir
-        return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'right_agent'))
+        warn "cfg_dir is deprecated; please use right_agent_cfg_dir"
+        right_agent_cfg_dir
       end
 
       # RightScale state directory for the current platform
+      # @deprecated
       def right_scale_state_dir
+        warn "right_scale_state_dir is deprecated; please use either right_scale_static_state_dir or right_agent_dynamic_state_dir"
+        right_scale_static_state_dir
+      end
+
+      # Directory containing generated agent configuration files
+      def right_agent_cfg_dir
+        return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'right_agent'))
+      end
+
+      # Static (time-invariant) state that is common to all RightScale apps/agents
+      def right_scale_static_state_dir
         return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'rightscale.d'))
       end
 
+      # Static (time-invariant) state that is specific to RightLink
+      def right_link_static_state_dir
+        return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'rightscale.d', 'right_link'))
+      end
+
+      # Dynamic, persistent runtime state that is specific to RightLink
+      def right_link_dynamic_state_dir
+        return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'right_link'))
+      end
+
       # Spool directory for the current platform
       def spool_dir
         return pretty_path(File.join(Dir::COMMON_APPDATA, 'RightScale', 'spool'))
@@ -950,7 +975,9 @@ EOF
         escaped = []
         [shell_script_file_path, arguments].flatten.each do |arg|
           value = arg.to_s
-          escaped << (value.index(' ') ? "'#{value.gsub("'", "''")}'" : value)
+          # note that literal ampersand must be quoted on the powershell command
+          # line because it otherwise means 'execute what follows'.
+          escaped << ((value.index(' ') || value.index('&')) ? "'#{value.gsub("'", "''")}'" : value)
         end
 
         # resolve lines before & after script.
@@ -1082,7 +1109,11 @@ EOF
       # the UTC timestamp at which the system was booted
       def booted_at
         begin
-          wmic_output = `echo | wmic OS Get LastBootUpTime`
+          Dir.mktmpdir do |temp_dir_path|
+            Dir.chdir(temp_dir_path) do
+              wmic_output = `echo | wmic OS Get LastBootUpTime`
+            end
+          end
 
           match = /(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\.\d{6}([+-]\d{3})/.match(wmic_output)
 
@@ -1213,8 +1244,12 @@ EOF
         return process_memory_counters[12..16].unpack("L")[0] / 1024  # bytes to KB
       end
     end
-
-    protected
+    
+    class Installer
+      def install(packages)
+        raise ::RightScale::Win32Error.new("Not implemented yet")
+      end
+    end
 
     # internal class for querying OS version, etc.
     class OSInformation

data/lib/right_agent/platform.rb

@@ -54,7 +54,7 @@ module RightScale
   #  - .flavor
   #  - .release
   #  - .linux?
-  #  - .mac?
+  #  - .darwin?
   #  - .windows?
   #  - .ec2?
   #  - .rackspace?
@@ -241,6 +241,14 @@ module RightScale
     def process
       platform_service(:process)
     end
+    
+    # Installer information object
+    #
+    # === Return
+    # (Object):: Platform-specific installer information object
+    def installer
+      platform_service(:installer)
+    end
 
     private
 
@@ -251,6 +259,7 @@ module RightScale
       @shell      = nil
       @ssh        = nil
       @controller = nil
+      @installer  = nil
 
       @ec2        = nil
       @rackspace  = nil
@@ -293,7 +302,7 @@ module RightScale
     # Retrieve platform specific service implementation
     #
     # === Parameters
-    # name(Symbol):: Service name, one of :filesystem, :shell, :ssh, :controller
+    # name(Symbol):: Service name, one of :filesystem, :shell, :ssh, :controller, :installer
     #
     # === Return
     # res(Object):: Service instance

data/lib/right_agent/scripts/agent_controller.rb

@@ -334,7 +334,8 @@ module RightScale
       EM.error_handler do |e|
         Log.error("EM block execution failed with exception", e, :trace)
         Log.error("\n\n===== Exiting due to EM block exception =====\n\n")
-        EM.stop
+        # Cannot rely on EM.stop at this point, so exit to give chance for monit restart
+        exit(1)
       end
 
       EM.run do

data/lib/right_agent/scripts/agent_deployer.rb

@@ -289,8 +289,8 @@ module RightScale
       cfg[:prefetch]           = options[:prefetch] || 1
       cfg[:heartbeat]          = options[:heartbeat] if options[:heartbeat]
       cfg[:time_to_live]       = options[:time_to_live] || 60
-      cfg[:retry_timeout]      = options[:retry_timeout] || 2 * 60
-      cfg[:retry_interval]     = options[:retry_interval] || 15
+      cfg[:retry_timeout]      = options[:retry_timeout] || 60
+      cfg[:retry_interval]     = options[:retry_interval] || 5
       cfg[:ping_interval]      = options[:ping_interval] ||= 4 * 60 * 60
       cfg[:check_interval]     = options[:check_interval] if options[:check_interval]
       cfg[:reconnect_interval] = options[:reconnect_interval] if options[:reconnect_interval]

data/lib/right_agent/scripts/stats_manager.rb

@@ -38,8 +38,6 @@ module RightScale
 
   class StatsManager
 
-    include StatsHelper
-
     # Default time to wait for a response from an agent
     DEFAULT_TIMEOUT = 5
 
@@ -185,6 +183,7 @@ module RightScale
       Log.program_name = "stats_manager"
       Log.log_to_file_only(true)
       Log.init("stats_manager", Platform.filesystem.temp_dir, :print => true)
+      RightSupport::Log::Mixin.default_logger = Log
       true
     end
 
@@ -207,6 +206,10 @@ module RightScale
     # result(String):: Result packet in JSON format containing stats or error
     # options(Hash):: Command line options:
     #   :json(Boolean):: Whether to display in JSON format
+    #   :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
     # true:: Always return true
@@ -216,7 +219,8 @@ module RightScale
         $stdout.puts result.content.to_json
       else
         if result.respond_to?(:success?) && result.success?
-          $stdout.puts "\n#{stats_str(result.content)}\n"
+          stats = RightSupport::Stats.stats_str(result.content, options)
+          $stdout.puts "\n#{stats}\n"
         else
           $stderr.puts "\nCould not retrieve #{agent_name} agent stats: #{result.inspect}"
         end