right_agent 0.5.1

data/lib/right_agent/scripts/log_level_manager.rb

@@ -0,0 +1,193 @@
+# === Synopsis:
+#   RightAgent Log Level Manager (rlog) - (c) 2009-2011 RightScale Inc
+#
+#   rlog is a command line tool for retrieving and setting the log level
+#   for a RightAgent
+#
+# === Examples:
+#   Retrieve log level for all configured agents:
+#     rlog
+#
+#   Retrieve log level for a specific agent:
+#     rlog AGENT
+#
+#   Set log level to debug for all configured agents:
+#     rlog [AGENT] --log-level debug
+#     rlog [AGENT] -l debug
+#
+#   Set log level to debug for a specific agent:
+#     rlog AGENT -l debug
+#
+# === Usage
+#    rs_set_log_level [AGENT] [--log-level, -l debug|info|warn|error|fatal]
+#
+#    options:
+#      --log-level, -l LVL  Set log level of agent
+#      --cfg-dir, -c DIR    Set directory containing configuration for all agents
+#      --verbose, -v        Display debug information
+#      --help:              Display help
+#
+#    No options prints the current agent log level
+#
+
+require 'rubygems'
+require 'optparse'
+require File.expand_path(File.join(File.dirname(__FILE__), 'usage'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'right_agent'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'actors', 'agent_manager'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'common_parser'))
+
+module RightScale
+
+  class LogLevelManager
+
+    # Convenience wrapper for creating and running log level manager
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      m = LogLevelManager.new
+      m.manage(m.parse_args)
+    end
+
+    # Handle log level request
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # true:: Always return true
+    def manage(options)
+      # Initialize configuration directory setting
+      AgentConfig.cfg_dir = options[:cfg_dir]
+
+      # Determine command
+      level = options[:level]
+      command = { :name => (level ? 'set_log_level' : 'get_log_level') }
+      command[:level] = level.to_sym if level
+
+      # Determine candidate agents
+      agent_names = if options[:agent_name]
+        [options[:agent_name]]
+      else
+        AgentConfig.cfg_agents
+      end
+      fail("No agents configured") if agent_names.empty?
+
+      # Perform command for each agent
+      count = 0
+      agent_names.each do |agent_name|
+        count += 1 if request_log_level(agent_name, command, options)
+      end
+      puts("No agents running") if count == 0
+      true
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Hash of options as defined by the command line
+    def parse_args
+      options = { :verbose => false }
+      options[:agent_name] = ARGV[0] unless ARGV[0] =~ /^-/
+
+      opts = OptionParser.new do |opts|
+
+        opts.on('-l', '--log-level LEVEL') do |l|
+          fail("Invalid log level '#{l}'") unless AgentManager::LEVELS.include?(l.to_sym)
+          options[:level] = l
+        end
+
+        opts.on("-c", "--cfg-dir DIR") do |d|
+          options[:cfg_dir] = d
+        end
+
+        opts.on('-v', '--verbose') do
+          options[:verbose] = true
+        end
+
+      end
+
+      opts.on_tail('--help') do
+         puts Usage.scan(__FILE__)
+         exit
+      end
+
+      begin
+        opts.parse!(ARGV)
+      rescue Exception => e
+        exit 0 if e.is_a?(SystemExit)
+        fail(e.message + "\nUse 'rlog --help' for additional information")
+      end
+      options
+    end
+
+    protected
+
+    # Send log level request to agent
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    # command(String):: Command request
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # (Boolean):: true if agent running, otherwise false
+    def request_log_level(agent_name, command, options)
+      res = false
+      config_options = AgentConfig.agent_options(agent_name)
+      unless config_options.empty?
+        listen_port = config_options[:listen_port]
+        fail("Could not retrieve #{agent_name} agent listen port") unless listen_port
+        client = CommandClient.new(listen_port, config_options[:cookie])
+        begin
+          client.send_command(command, options[:verbose]) do |level|
+            puts "Agent #{agent_name} log level: #{level.to_s.upcase}"
+          end
+          res = true
+        rescue Exception => e
+          puts "Command #{command.inspect} to #{agent_name} agent failed (#{e})"
+        end
+      end
+      res
+    end
+
+    # Print error on console and exit abnormally
+    #
+    # === Parameter
+    # message(String):: Error message, default to nil (no message printed)
+    # print_usage(Boolean):: Whether script usage should be printed, default to false
+    #
+    # === Return
+    # R.I.P. does not return
+    def fail(message = nil, print_usage = false)
+      puts "** #{message}" if message
+      puts Usage.scan(__FILE__) if print_usage
+      exit(1)
+    end
+
+  end
+
+end
+
+#
+# Copyright (c) 2009-2011 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.

data/lib/right_agent/scripts/stats_manager.rb

@@ -0,0 +1,256 @@
+# === Synopsis:
+#   RightAgent Statistics Manager (rstat) - (c) 2010-2011 RightScale Inc
+#
+#   rstat is a command line tool for displaying operation statistics for RightAgents
+#
+# === Examples:
+#   Retrieve statistics for all locally running agents:
+#     rstat
+#
+#   Retrieve statistics for an agent named AGENT:
+#     rstat AGENT
+#
+#   Retrieve statistics for an agent in JSON format:
+#     rstat AGENT --json
+#     rstat AGENT --j
+#
+# === Usage:
+#    rstat [AGENT] [options]
+#
+#    Options:
+#      --reset, -r        As part of gathering the stats from an agent also reset the stats
+#      --timeout, -t SEC  Override default timeout in seconds to wait for a response from an agent
+#      --json, -j         Display the stats data in JSON format
+#      --cfg-dir, -c DIR  Set directory containing configuration for all agents
+#      --help             Display help
+
+require 'rubygems'
+require 'optparse'
+require File.expand_path(File.join(File.dirname(__FILE__), 'usage'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'right_agent'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'common_parser'))
+
+module RightScale
+
+  class StatsManager
+
+    include StatsHelper
+
+    # Default time to wait for a response from an agent
+    DEFAULT_TIMEOUT = 5
+
+    # Create and run manager
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      m = StatsManager.new
+      m.manage(m.parse_args)
+    end
+
+    # Initialize manager
+    def initialize
+      @command_serializer = Serializer.new
+    end
+
+    # Handle stats request
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # true:: Always return true
+    def manage(options)
+      init_log
+      AgentConfig.cfg_dir = options[:cfg_dir]
+      options[:timeout] ||= DEFAULT_TIMEOUT
+      request_stats(options)
+    rescue Exception => e
+      fail("#{e}\n#{e.backtrace.join("\n")}") unless e.is_a?(SystemExit)
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Parsed options
+    def parse_args
+      options = {:reset => false}
+      options[:agent_name] = ARGV[0] unless ARGV[0] =~ /^-/
+
+      opts = OptionParser.new do |opts|
+        parse_other_args(opts, options)
+
+        opts.on('-r', '--reset') do
+          options[:reset] = true
+        end
+
+        opts.on('-t', '--timeout SEC') do |sec|
+          options[:timeout] = sec
+        end
+
+        opts.on('-j', '--json') do
+          options[:json] = true
+        end
+
+        opts.on("-c", "--cfg-dir DIR") do |d|
+          options[:cfg_dir] = d
+        end
+
+        opts.on_tail('--help') do
+          puts Usage.scan(__FILE__)
+          exit
+        end
+
+      end
+
+      begin
+        opts.parse(ARGV)
+      rescue Exception => e
+        exit 0 if e.is_a?(SystemExit)
+        fail(e.message + "\nUse 'rstat --help' for additional information")
+      end
+
+      options
+    end
+
+    # Request and display statistics for agents
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # true:: Always return true
+    def request_stats(options)
+      # Determine candidate agents
+      agent_names = if options[:agent_name]
+        [options[:agent_name]]
+      else
+        AgentConfig.cfg_agents
+      end
+      fail("No agents configured") if agent_names.empty?
+
+      # Request stats from agents
+      count = 0
+      agent_names.each do |agent_name|
+        begin
+          count += 1 if request_agent_stats(agent_name, options)
+        rescue Exception => e
+          $stderr.puts "Command to #{agent_name} agent failed (#{e})" unless e.is_a?(SystemExit)
+        end
+      end
+      $stderr.puts("No agents running") if count == 0
+    end
+
+    # Request and display statistics for agent
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # (Boolean):: true if agent running, otherwise false
+    def request_agent_stats(agent_name, options)
+      res = false
+      config_options = AgentConfig.agent_options(agent_name)
+      unless config_options.empty? || (listen_port = config_options[:listen_port]).nil?
+        client = CommandClient.new(listen_port, config_options[:cookie])
+        command = {:name => :stats, :reset => options[:reset]}
+        begin
+          client.send_command(command, options[:verbose], options[:timeout]) { |r| display(agent_name, r, options) }
+          res = true
+        rescue Exception => e
+          msg = "Could not retrieve #{agent_name} agent stats: #{e}"
+          msg += "\n" + e.backtrace.join("\n") unless e.message =~ /Timed out/
+          fail(msg)
+        end
+      end
+      res
+    end
+
+    protected
+
+    # Initialize logging
+    #
+    # === Return
+    # true:: Always return true
+    def init_log
+      Log.program_name = "stats_manager"
+      Log.log_to_file_only(true)
+      Log.init("stats_manager", Platform.filesystem.temp_dir, :print => true)
+      true
+    end
+
+    # Parse other arguments unique to given stats manager
+    #
+    # === Parameters
+    # opts(OptionParser):: Options parser with options to be parsed
+    # options(Hash):: Storage for options that are parsed
+    #
+    # === Return
+    # true:: Always return true
+    def parse_other_args(opts, options)
+      true
+    end
+
+    # Display stats returned from an agent in human readable or JSON format
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    # result(String):: Result packet in JSON format containing stats or error
+    # options(Hash):: Command line options:
+    #   :json(Boolean):: Whether to display in JSON format
+    #
+    # === Return
+    # true:: Always return true
+    def display(agent_name, result, options)
+      result = RightScale::OperationResult.from_results(@command_serializer.load(result))
+      if options[:json]
+        $stdout.puts result.content.to_json
+      else
+        if result.respond_to?(:success?) && result.success?
+          $stdout.puts "\n#{stats_str(result.content)}\n"
+        else
+          $stderr.puts "\nCould not retrieve #{agent_name} agent stats: #{result.inspect}"
+        end
+      end
+      true
+    end
+
+    # Print failure message and exit abnormally
+    #
+    # === Parameters
+    # message(String):: Failure message
+    # print_usage(Boolean):: Whether to display usage information
+    #
+    # === Return
+    # exits the program
+    def fail(message, print_usage = false)
+      $stderr.puts "** #{message}"
+      puts Usage.scan(__FILE__) if print_usage
+      exit(1)
+    end
+
+  end
+end
+
+#
+# Copyright (c) 2009-2011 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.

data/lib/right_agent/scripts/usage.rb

@@ -0,0 +1,58 @@
+#
+# Copyright (c) 2009-2011 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.
+
+# Scans the 'usage' for a given file and returns the resulting String.
+#
+# Note : no formatting occurs. Rdoc is nice as is.
+#
+
+module Usage
+
+  # Scans the given file from its usage (the top comment block) and
+  # returns it
+  #
+  # === Parameters
+  # file(String)::
+  #   path to file to read
+  #
+  # === Return
+  # String::
+  #   the usage as found in the file
+  #
+  def self.scan(file)
+
+    lines = File.readlines(file)  # Display usage from the given file
+    result = []
+
+    while line = lines.shift
+      if m = line.match(/^ *#(.*)$/)
+        result << m[1]
+      else
+        break unless result.empty?
+      end
+    end
+
+    result.join("\n")
+  end
+
+end
+