rboss 0.5.4 → 0.5.5

data/README.md

@@ -72,6 +72,90 @@ And used with -c or --config
 
     twiddle -c jon --server-config
 
+### Customizing MBeans
+
+Every time you run the twiddle command, this gem will load the ~/.rboss/twiddle.rb file,
+which can be used to customize the mbeans.
+
+    defaults = JBoss::Twiddle::Monitor.defaults
+    defaults[:logger] = {
+      :description => 'Logger Service',
+      :pattern => 'jboss.system:service=Logging,type=Logger'
+    }
+
+This will add a custom mbean whose identifier is 'logger'. From that, you can use the
+twiddle command on it.
+
+    twiddle --invoke logger debug,message
+
+If your mbean name depends on a resource name (like the connector mbean), you can use
+a '#{resource}' string to pass the resource in the command line.
+
+    defaults[:mymbean] => {
+      :description => 'My Custom MBean',
+      :pattern => 'jboss.custom:type=CustomMBean,name=#{resource}'
+    }
+
+Don't forget to use single quotes on that. The twiddle command will be:
+
+    twiddle --get mymbean:Name,MBeanProperty
+
+If this mbean is scannable, you can use a :scan key:
+
+    defaults[:mymbean] => {
+      :description => 'My Custom MBean',
+      :pattern => 'jboss.custom:type=CustomMBean,name=#{resource}',
+      :scan => proc do
+        # queries and pass each result do the block
+        query "jboss.custom:type=CustomMBean,*" do |path|
+          path.gsub "jboss.custom:type=CustomMBean,name=", ""
+        end
+      end
+    }
+
+Now you can scan for resources of your custom MBean by using:
+
+    twiddle --mymbean
+
+If your MBean has some properties that should appear in a table for instant monitoring,
+just add a :properties key:
+
+    defaults[:mymbean] => {
+      :description => 'My Custom MBean',
+      :pattern => 'jboss.custom:type=CustomMBean,name=#{resource}',
+      :properties => %W(activeCount currentFree maxAvailable),
+      :header => ['Active Count', 'Current Free', 'Max Available'],
+      :scan => proc do
+        # queries and pass each result do the block
+        query "jboss.custom:type=CustomMBean,*" do |path|
+          path.gsub "jboss.custom:type=CustomMBean,name=", ""
+        end
+      end
+    }
+
+If this MBean maps a component that can be monitored for health state, you can map the
+limits by using a :health key:
+
+    defaults[:mymbean] => {
+      :description => 'My Custom MBean',
+      :pattern => 'jboss.custom:type=CustomMBean,name=#{resource}',
+      :properties => %W(activeCount currentFree maxAvailable),
+      :header => ['Active Count', 'Current Free', 'Max Available'],
+      :health => {
+        :max => :max_available,
+        :using => :active_count #or use :free if you have the number of free resources
+      },
+      :scan => proc do
+        # queries and pass each result do the block
+        query "jboss.custom:type=CustomMBean,*" do |path|
+          path.gsub "jboss.custom:type=CustomMBean,name=", ""
+        end
+      end
+    }
+
+You can use the indexes of the values (in that case, 2 for :max and 0 for :using) or the
+header values in downcase and underscores.
+
 Using jboss-profile
 -----------
 
@@ -248,8 +332,6 @@ Use an array with the services to remove, the current supported are:
 
 Any slimmed service will be removed logically by using a ".rej" suffix in the files/directories.
 
-### Configuring connectors
-
 Tools
 -----------
 

data/bin/twiddle

@@ -85,6 +85,7 @@ opts.on('--all', "Detail all mapped mbeans") do
 end
 
 (defaults.sort_by { |k, v| k }).each do |mbean_id, mbean|
+  next if mbean[:properties] and not mbean[:scan] and mbean[:pattern]['#{resource}']
   command = mbean_id.to_s.gsub /_/, '-'
   if mbean[:scan]
     opts.on("--#{command} [name_a,name_b,...]", Array,

data/lib/rboss/twiddle/monitor.rb

@@ -89,6 +89,7 @@ module JBoss
             :description => 'JBoss Server specifications',
             :pattern => 'jboss.system:type=Server',
             :properties => %W(VersionName VersionNumber Version),
+            :layout => :vertical,
             :header => ['Version Name', 'Version Number', 'Version'],
           },
           :server_info => {

data/lib/rboss/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rboss
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors: