rboss 0.2.0 → 0.2.1

data/README.md

@@ -21,16 +21,16 @@ Simply do a "cd" to your JBoss Home and use it
 
 You can scan resources like: datasources, queues, connectors, webapps, ...
 
-    twiddle --datasources --webapps
+    twiddle --datasource --webapp
     twiddle --all
 
 If you don't need to scan for resources, you can specify them for monitoring:
 
-    twiddle --webapps jmx-console,admin-console
+    twiddle --webapp jmx-console,admin-console
 
 Combine with "watch" to get a simple and instantly monitoring:
 
-    watch --interval=1 twiddle --webapps jmx-console,admin-console
+    watch --interval=1 twiddle --webapp jmx-console,admin-console
 
 Retrieve property values with --get:
 

data/bin/twiddle

@@ -22,95 +22,84 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rboss'
+require_relative '../lib/rboss'
 require 'optparse'
 require 'yaml'
 
 params = {}
-resources = {}
-list_only = false
+mbeans = {}
+commands = {}
+no_details = false
 params[:jboss_home] = Dir.pwd unless ENV["JBOSS_HOME"]
 exec_file = nil
-eval_expression = nil
+defaults = JBoss::Twiddle::Monitor::defaults
 
 opts = OptionParser::new
 opts.on('-j', '--jboss-home PATH', 'Defines the JBOSS_HOME variable') do |home|
   params[:jboss_home] = home
 end
-opts.on('-s', '--jboss-server URL', 'Defines the JBoss server') do |server|
+opts.on('-s', '--server URL', 'Defines the JBoss server') do |server|
   params[:jboss_server] = server
 end
-opts.on('--jboss-host HOST', 'Defines the JBoss host') do |host|
+opts.on('--host HOST', 'Defines the JBoss host') do |host|
   params[:jboss_host] = host
 end
-opts.on('--jboss-port PORT', 'Defines the JBoss jnp port') do |port|
+opts.on('--port PORT', 'Defines the JBoss jnp port') do |port|
   params[:jboss_port] = port
 end
 opts.on('-e', '--exec-file PATH',
         'Defines the ruby file to exec using the vars twiddle and monitor') do |path|
   exec_file = File.expand_path path
 end
-opts.on('--eval EXPRESSION',
-        'Evaluates the given expression using the vars twiddle and monitor') do |expression|
-  eval_expression = expression
-end
-opts.on('--all', 'Shows all resources available') do
-  [
-    :server_info,
-    :deployments,
-    :datasources,
-    :webapps,
-    :connectors,
-    :queues,
-    :ejbs
-  ].each do |option|
-    resources[option] = :all
+
+opts.on('--all', "Detail all mapped mbeans") do
+  defaults.each do |mbean_id, mbean|
+    if mbean[:scan]
+      mbeans[mbean_id] = :all
+    elsif mbean[:detail]
+      mbeans[mbean_id] = true
+    end
   end
 end
-opts.on('--server-info', 'Shows server information') do
-  resources[:server_info] = true
-end
-opts.on('--deployments', 'Shows deployments on server') do
-  resources[:deployments] = true
-end
-opts.on('--connectors [name_a, name_b, name_c, ...]', Array,
-        'Defines the connectors to show or scan if not specified') do |connectors|
-  resources[:connectors] = connectors || :all
-end
-opts.on('--datasources [name_a, name_b, name_c, ...]', Array,
-        'Defines the datasources to show or scan if not specified') do |datasources|
-  resources[:datasources] = datasources || :all
-end
-opts.on('--ejbs [name_a, name_b, name_c, ...]', Array,
-        'Defines the EJBs to show or scan if not specified') do |ejbs|
-  resources[:ejbs] = ejbs || :all
-end
-opts.on('--queues [name_a, name_b, name_c, ...]', Array,
-        'Defines the JMS queues to show or scan if not specified') do |queues|
-  resources[:queues] = queues || :all
-end
-opts.on('--webapps [name_a, name_b, name_c, ...]', Array,
-        'Defines the webapps to show or scan if not specified') do |webapps|
-  resources[:webapps] = webapps || :all
-end
-opts.on('--system-properties [name_a, name_b, name_c, ...]', Array,
-        'Defines the System properties to show or scan if not specified') do |properties|
-  resources[:system_properties] = properties || :all
+
+defaults.each do |mbean_id, mbean|
+  command = mbean_id.to_s.gsub /_/, '-'
+  if mbean[:scan]
+    opts.on("--#{command} [name_a,name_b,...]", Array,
+            "Detail this mbeam based on the given names (no names for scan)") do |names|
+      mbeans[mbean_id] = names || :all
+    end
+  elsif mbean[:detail]
+    opts.on("--#{command}", "Detail this mbeam") do
+      mbeans[mbean_id] = true
+    end
+  end
 end
-opts.on('--set resource_type[:resource_name],property,value', Array,
+
+opts.on('--set mbean_id[:resource_name],property,value', Array,
         'Sets a value to a resource that the monitor knows') do |set|
-  resources[:set] = set
+  commands[:set] = set
 end
-opts.on('--get resource_type[:resource_name],property', Array,
+opts.on('--get mbean_id[:resource_name],property', Array,
         'Gets a value to a resource that the monitor knows') do |get|
-  resources[:get] = get
+  commands[:get] = get
 end
-opts.on('--invoke resource_type[:resource_name],method,[,args...]', Array,
+opts.on('--invoke mbean_id[:resource_name],method,[,args...]', Array,
         'Invokes a resoruce method') do |invoke|
-  resources[:invoke] = invoke
+  commands[:invoke] = invoke
 end
-opts.on('--list', 'Only lists the required info (datasources, queues, ...)') do
-  list_only = true
+opts.on("-l", "--list", "List the mbeans mappings") do
+  defaults.each do |mbean_id, mbean|
+    puts " - #{mbean_id}"
+    [:description, :pattern].each do |detail|
+      puts "   - #{detail} : #{mbean[detail]}"
+    end
+    puts
+  end
+  exit
+end
+opts.on('--no-detail', 'Do not detail mbeans that needs a name') do
+  no_details = true
 end
 opts.on('-u', '--jmx-user USER', 'Defines the JMX User') do |user|
   params[:jmx_user] = user
@@ -126,38 +115,36 @@ opts.parse!(ARGV) rescue abort 'Invalid Option! Use --help or -h for usage help.
 twiddle = JBoss::Twiddle::Invoker::new params
 monitor = twiddle.monitor
 
-if resources.empty? and not (exec_file or eval_expression)
+if mbeans.empty? and commands.empty? and not exec_file
   puts opts
   exit
 end
 
 eval File.read(exec_file), binding, exec_file if exec_file
 
-puts (eval eval_expression, binding) if eval_expression
-
 def extract resource
   mbean, name = resource.split(/:/)
 end
 
-if resources[:set]
-  array = resources[:set]
+if commands[:set]
+  array = commands[:set]
   raise "Wrong number of arguments" if array.size != 3
   mbean, name = extract array[0]
   puts twiddle.set :mbean => mbean.to_sym,
-              :name => name,
-              :property => array[1],
-              :value => array[2]
+                   :name => name,
+                   :property => array[1],
+                   :value => array[2]
 end
-if resources[:get]
-  array = resources[:get]
+if commands[:get]
+  array = commands[:get]
   raise "Wrong number of arguments" if array.size != 2
   mbean, name = extract array[0]
   puts twiddle.get :mbean => mbean.to_sym,
                    :name => name,
                    :property => array[1]
 end
-if resources[:invoke]
-  array = resources[:invoke]
+if commands[:invoke]
+  array = commands[:invoke]
   raise "Wrong number of arguments" if array.size < 2
   mbean, name = extract array[0]
   puts twiddle.invoke :mbean => mbean.to_sym,
@@ -166,108 +153,25 @@ if resources[:invoke]
                       :args => array[2..-1]
 end
 
-if resources[:server_info]
-  puts "Server Info:"
-  monitor.properties[:server].each do |property|
-    puts "  - #{monitor.server[property]}"
-  end
-  monitor.properties[:server_info].each do |property|
-    puts "  - #{monitor.server_info[property]}"
-  end
-end
-if resources[:system_properties]
-  puts "System Properties:"
-  properties = resources[:system_properties]
-  if properties == :all
-    properties = monitor.system_properties.showAll
-    puts properties
-  else
-    properties.each do |property|
-      puts "  - #{property}=#{monitor.system_properties.get(property)}"
-    end
-  end
-end
-if resources[:deployments]
-  puts "Deployments:"
-  monitor.deployments.each do |deployment|
-    puts "  - #{deployment}"
-  end
-end
-if resources[:connectors]
-  puts "Connectors:"
-  connectors = resources[:connectors]
-  connectors = monitor.connectors if connectors == :all
-  connectors.each do |connector|
-    monitor.with connector do
-      puts "  - #{connector}"
-      unless list_only
-        monitor.properties[:connector].each do |property|
-          puts "    - #{monitor.connector[property]}"
-        end
-        monitor.properties[:request].each do |property|
-          puts "    - #{monitor.request[property]}"
-        end
-      end
+mbeans.each do |mbean_id, resources|
+  puts "  - #{defaults[mbean_id][:description]}"
+  if resources.is_a? TrueClass
+    details = monitor.mbean(mbean_id).detail
+    details.each do |name, value|
+      puts "    - #{name}=#{value}"
     end
-  end
-end
-if resources[:datasources]
-  puts "Datasources:"
-  datasources = resources[:datasources]
-  datasources = monitor.datasources if datasources == :all
-  datasources.each do |datasource|
-    monitor.with datasource do
-      puts "  - #{datasource}"
-      unless list_only
-        monitor.properties[:datasource].each do |property|
-          puts "    - #{monitor.datasource[property]}"
-        end
-      end
+  elsif no_details
+    monitor.mbean(mbean_id).scan.each do |name|
+      puts "    - #{name}"
     end
-  end
-end
-if resources[:webapps]
-  puts "Webapps:"
-  webapps = resources[:webapps]
-  webapps = monitor.webapps if webapps == :all
-  webapps.each do |webapp|
-    monitor.with webapp do
-      puts "  - #{webapp}"
-      unless list_only
-        monitor.properties[:webapp].each do |property|
-          puts "    - #{monitor.webapp[property]}"
-        end
-      end
-    end
-  end
-end
-if resources[:ejbs]
-  puts "EJBs:"
-  ejbs = resources[:ejbs]
-  ejbs = monitor.ejbs if ejbs == :all
-  ejbs.each do |ejb|
-    monitor.with ejb do
-      puts "  - #{ejb}"
-      unless list_only
-        monitor.properties[:ejb].each do |property|
-          puts "    - #{monitor.ejb[property]}"
-        end
-      end
-    end
-  end
-end
-if resources[:queues]
-  puts "Queues:"
-  queues = resources[:queues]
-  queues = monitor.queues if queues == :all
-  queues.each do |queue|
-    monitor.with queue do
-      puts "  - #{queue}"
-      unless list_only
-        monitor.properties[:queue].each do |property|
-          puts "    - #{monitor.queue[property]}"
-        end
+  else
+    details = monitor.mbean(mbean_id).detail resources
+    details.each do |resource, detail|
+      puts "    - #{resource}"
+      detail.each do |name, value|
+        puts "      - #{name}=#{value}"
       end
     end
   end
 end
+

data/lib/rboss/twiddle/base_monitor.rb

@@ -21,14 +21,13 @@
 # THE SOFTWARE.
 
 require_relative 'monitor'
-require_relative 'scanner'
 require_relative 'twiddle'
 
 module JBoss
   module Twiddle
 
     class BaseMonitor
-      include JBoss::Twiddle::Monitor, JBoss::Twiddle::Scanner
+      include JBoss::Twiddle::Monitor
 
       def initialize twiddle
         @twiddle = twiddle

data/lib/rboss/twiddle/mbean.rb

@@ -26,12 +26,50 @@ module JBoss
   class MBean
 
     attr_reader :pattern
-    attr_accessor :resource, :twiddle
+    attr_accessor :resource, :twiddle, :description
+
+    @@__default__detail__resource__ = proc do |resources|
+      resouces = _parse_resource_ resources
+      details = {}
+      resouces.each do |resource|
+        with resource do
+          details[resource] = {}
+          @properties.each do |property|
+            details[resource][property] = self[property].value
+          end
+        end
+      end
+      details
+    end
+
+    @@__default__detail__ = proc do
+      details = {}
+      @properties.each do |property|
+        details[property] = self[property].value
+      end
+      details
+    end
 
     def initialize params
       @pattern = params[:pattern]
       @twiddle = params[:twiddle]
-      @env = @twiddle
+      @properties = params[:properties]
+      @description = params[:description]
+      if params[:scan]
+        (class << self
+          self
+        end).send :define_method, :scan, &params[:scan]
+      end
+      if params[:detail]
+        (class << self
+          self
+        end).send :define_method,
+                  :detail,
+                  &(params[:detail].is_a?(TrueClass) ?
+                    (params[:scan] ?
+                      @@__default__detail__resource__ : @@__default__detail__)
+                  : params[:detail])
+      end
     end
 
     def with resource
@@ -43,20 +81,24 @@ module JBoss
       self
     end
 
+    def resourced?
+      @pattern['#{resource}']
+    end
+
     def [] property
       resource = @resource
-      env = @env
       query = eval("\"#{pattern}\"")
       result = @twiddle.execute(:get, query, property)
+
       def result.value
         self.split(/=/)[1]
       end
+
       result
     end
 
     def []= property, value
       resource = @resource
-      env = @env
       query = eval("\"#{pattern}\"")
       @twiddle.execute :set, query, property, value
     end
@@ -67,7 +109,6 @@ module JBoss
 
     def _invoke_ method, *args, &block
       resource = @resource
-      env = @env
       query = eval("\"#{pattern} #{method}\"")
       return_value = @twiddle.execute :invoke, query, args
       if block_given?
@@ -76,6 +117,19 @@ module JBoss
       return_value
     end
 
+    def _query_ query, &block
+      result = @twiddle.execute(:query, query)
+      return [] unless result
+      result = result.split /\s+/
+      block ? result.collect(&block) : result
+    end
+
+    def _parse_resource_ resources
+      return scan if resources == :all
+      return [resources] unless resources.respond_to? :each
+      resources
+    end
+
   end
 
 end

data/lib/rboss/twiddle/monitor.rb

@@ -28,50 +28,113 @@ module JBoss
     module Monitor
 
       def defaults
-        {
+        @defaults ||= {
           :webapp => {
+            :description => 'Deployed webapps',
             :pattern => 'jboss.web:type=Manager,host=localhost,path=/#{resource}',
-            :properties => %W(activeSessions maxActive)
+            :properties => %W(activeSessions maxActive),
+            :scan => proc do
+              _query_ "jboss.web:type=Manager,*" do |path|
+                path.gsub! "jboss.web:type=Manager,path=/", ""
+                path.gsub! /,host=.+/, ''
+                path
+              end
+            end,
+            :detail => true
           },
           :web_deployment => {
+            :description => 'Deployed webapp control',
             :pattern => 'jboss.web.deployment:war=/#{resource}'
           },
           :connector => {
+            :description => 'JBossWeb connector',
             :pattern => 'jboss.web:type=ThreadPool,name=#{resource}',
-            :properties => %W(maxThreads currentThreadCount currentThreadsBusy)
+            :properties => %W(maxThreads currentThreadCount currentThreadsBusy),
+            :scan => proc do
+              _query_ "jboss.web:type=ThreadPool,*" do |path|
+                path.gsub "jboss.web:type=ThreadPool,name=", ""
+              end
+            end,
+            :detail => true
+          },
+          :engine => {
+            :description => 'JBossWeb engine',
+            :pattern => 'jboss.web:type=Engine',
+            :properties => %W(jvmRoute name defaultHost),
+            :detail => true
           },
           :server_info => {
+            :description => 'JBoss running info',
             :pattern => 'jboss.system:type=ServerInfo',
             :properties => %W(ActiveThreadCount MaxMemory FreeMemory AvailableProcessors
-                              HostAddress JavaVendor JavaVersion OSName OSArch)
+                              HostAddress JavaVendor JavaVersion OSName OSArch),
+            :detail => true
           },
           :server => {
+            :description => 'JBoss specifications',
             :pattern => 'jboss.system:type=Server',
-            :properties => %W(VersionNumber StartDate)
+            :properties => %W(VersionNumber StartDate),
+            :detail => true
           },
           :system_properties => {
+            :description => 'System properties',
             :pattern => 'jboss:name=SystemProperties,type=Service'
           },
           :request => {
+            :description => 'JBossWeb connector requests',
             :pattern => 'jboss.web:type=GlobalRequestProcessor,name=#{resource}',
-            :properties => %W(requestCount errorCount maxTime)
+            :properties => %W(requestCount errorCount maxTime),
+            :scan => proc do
+              _query_ "jboss.web:type=ThreadPool,*" do |path|
+                path.gsub "jboss.web:type=ThreadPool,name=", ""
+              end
+            end,
+            :detail => true
           },
           :datasource => {
+            :description => 'Datasource',
             :pattern => 'jboss.jca:service=ManagedConnectionPool,name=#{resource}',
-            :properties => %W(MinSize MaxSize AvailableConnectionCount InUseConnectionCount ConnectionCount)
+            :properties => %W(MinSize MaxSize AvailableConnectionCount
+                                InUseConnectionCount ConnectionCount),
+            :scan => proc do
+              _query_ "jboss.jca:service=ManagedConnectionPool,*" do |path|
+                path.gsub "jboss.jca:service=ManagedConnectionPool,name=", ""
+              end
+            end,
+            :detail => true
           },
           :queue => {
+            :description => 'JMS Queue',
             :pattern => 'jboss.messaging.destination:service=Queue,name=#{resource}',
             :properties => %W(Name JNDIName MessageCount DeliveringCount
-              ScheduledMessageCount MaxSize FullSize Clustered ConsumerCount)
+              ScheduledMessageCount MaxSize FullSize Clustered ConsumerCount),
+            :scan => proc do
+              _query_ "jboss.messaging.destination:service=Queue,*" do |path|
+                path.gsub "jboss.messaging.destination:service=Queue,name=", ""
+              end
+            end,
+            :detail => true
           },
           :ejb => {
+            :description => 'EJB',
             :pattern => 'jboss.j2ee:#{resource},service=EJB3',
-            :properties => %W(CreateCount RemoveCount CurrentSize AvailableCount)
+            :properties => %W(CreateCount RemoveCount CurrentSize AvailableCount),
+            :scan => proc do
+              result = _query_ "jboss.j2ee:*"
+              (result.find_all do |path|
+                path["service=EJB3"] && path["name="] && path["jar="]
+              end).collect do |path|
+                path.gsub("jboss.j2ee:", '').gsub(/,?service=EJB3/, '')
+              end
+            end,
+            :detail => true
           }
         }
+        @defaults
       end
 
+      module_function :defaults
+
       def properties mbean_id = nil
         @properties ||= {}
         return properties[mbean_id] if mbean_id
@@ -97,8 +160,7 @@ module JBoss
       end
 
       def monitor mbean_id, params
-        mbeans[mbean_id] = JBoss::MBean::new :pattern => params[:pattern], :twiddle => @twiddle
-        properties[mbean_id] = params[:properties]
+        mbeans[mbean_id] = JBoss::MBean::new params.merge(:twiddle => @twiddle)
       end
 
       def with resource
@@ -126,7 +188,7 @@ module JBoss
         mbean
       end
 
-      def method_missing(method, *args, &block)
+      def method_missing method, *args, &block
         mbean_id = method
         mbean = mbeans[mbean_id]
         resource = args[0] || @current_resource

data/lib/rboss/twiddle/twiddle.rb

@@ -58,7 +58,9 @@ module JBoss
       end
 
       def execute command, *arguments
-        `#{shell command, arguments}`.chomp
+        result = `#{shell command, arguments}`.chomp
+        return nil if result["ERROR [Twiddle] Command failure"]
+        result
       end
 
     end

data/lib/rboss/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module RBoss
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: rboss
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ataxexe
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-13 00:00:00 Z
+date: 2011-08-19 00:00:00 Z
 dependencies: []
 
 description: |-
@@ -67,7 +67,6 @@ files:
 - lib/rboss/twiddle/base_monitor.rb
 - lib/rboss/twiddle/mbean.rb
 - lib/rboss/twiddle/monitor.rb
-- lib/rboss/twiddle/scanner.rb
 - lib/rboss/twiddle/twiddle.rb
 - lib/rboss/utils.rb
 - lib/rboss/version.rb

data/lib/rboss/twiddle/scanner.rb

@@ -1,92 +0,0 @@
-#                         The MIT License
-#
-# Copyright (c) 2011 Marcelo Guimarães <ataxexe@gmail.com>
-#
-# 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 "set"
-
-module JBoss
-  module Twiddle
-    module Scanner
-
-      def webapps
-        _query_ "jboss.web:type=Manager,*" do |path|
-          path.gsub! "jboss.web:type=Manager,path=/", ""
-          path.gsub! /,host=.+/, ''
-          path
-        end
-      end
-
-      def datasources
-        _query_ "jboss.jca:service=ManagedConnectionPool,*" do |path|
-          path.gsub "jboss.jca:service=ManagedConnectionPool,name=", ""
-        end
-      end
-
-      def connectors
-        _query_ "jboss.web:type=ThreadPool,*" do |path|
-          path.gsub "jboss.web:type=ThreadPool,name=", ""
-        end
-      end
-
-      def queues
-        _query_ "jboss.messaging.destination:service=Queue,*" do |path|
-          path.gsub "jboss.messaging.destination:service=Queue,name=", ""
-        end
-      end
-
-      def ejbs
-        result = _query_ "jboss.j2ee:service=EJB3,*"
-        (result.find_all {|path| path["name="] && path["jar="]}).collect do |path|
-          path.gsub("jboss.j2ee:", '').gsub(/,?service=EJB3/, '')
-        end
-      end
-
-      def deployments
-        wars = _query_ "jboss.web.deployment:*" do |path|
-          path.gsub("jboss.web.deployment:", "").split(/,/).find {|p| p.start_with? "war="}
-        end
-        ears = _query_ "jboss.j2ee:*"
-        ears = (ears.find_all {|path| path["ear="] && path["jar="]}).collect do |path|
-          path.gsub("jboss.j2ee:",'').split(/,/).find {|p| p.start_with? "ear="}
-        end
-        result = Set::new
-        (wars + ears).each do |deployment|
-          result << deployment
-        end
-        result
-      end
-
-      def can_scan? resource
-        self.respond_to? resource.to_sym
-      end
-
-      private
-
-      def _query_ query, &block
-        result = @twiddle.execute(:query, query)
-        return [] if result["No MBean matches for query"]
-        result = result.split /\s+/
-        block ? result.collect(&block) : result
-      end
-
-    end
-  end
-end