torquebox-backstage 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+* 0.3.0 - 2011-04-29
+  * you can now tail application and jboss logs
+  * added a dashboard
+  * updated to use the TorqueBox 1.0.0.Final gems
+  
 * 0.2.1 - 2011-04-27
   * The deployment descriptor name was changed from backstage-knob.yml to torquebox-backstage-knob.yml
-
+  
 * 0.2.0 - 2011-04-26
   * if the queue isn't available via jndi, just log an error instead of raising
   * updated to use the TorqueBox 1.0.0.CR2 gems

data/Gemfile

@@ -3,9 +3,10 @@ source :rubygems
 gem "sinatra", "1.1.2"
 gem "rack-flash"
 gem 'haml', '~>3.0'
-gem "jmx", '0.7'
+gem 'sass', '~>3.0'
+gem "tobias-jmx", '0.8'
 gem 'json'
-gem 'torquebox', '1.0.0.CR2'
+gem 'torquebox', '1.0.0'
 gem 'tobias-sinatra-url-for'
 gem 'rack-accept'
 

data/Gemfile.lock

@@ -3,12 +3,11 @@ GEM
   specs:
     diff-lcs (1.1.2)
     git (1.2.5)
-    haml (3.0.25)
+    haml (3.1.1)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    jmx (0.7)
     json (1.5.1-java)
     rack (1.2.2)
     rack-accept (0.4.3)
@@ -26,28 +25,30 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
+    sass (3.1.1)
     sinatra (1.1.2)
       rack (~> 1.1)
       tilt (~> 1.2)
     thor (0.14.6)
-    tilt (1.2.2)
+    tilt (1.3)
+    tobias-jmx (0.8)
     tobias-sinatra-url-for (0.2.1)
       sinatra (>= 0.9.1.1)
-    torquebox (1.0.0.CR2)
-      torquebox-base (= 1.0.0.CR2)
-      torquebox-messaging (= 1.0.0.CR2)
-      torquebox-naming (= 1.0.0.CR2)
-      torquebox-rake-support (= 1.0.0.CR2)
-      torquebox-vfs (= 1.0.0.CR2)
-      torquebox-web (= 1.0.0.CR2)
-    torquebox-base (1.0.0.CR2-java)
-    torquebox-messaging (1.0.0.CR2-java)
-      torquebox-base (= 1.0.0.CR2)
-      torquebox-naming (= 1.0.0.CR2)
-    torquebox-naming (1.0.0.CR2-java)
-    torquebox-rake-support (1.0.0.CR2)
-    torquebox-vfs (1.0.0.CR2-java)
-    torquebox-web (1.0.0.CR2-java)
+    torquebox (1.0.0)
+      torquebox-base (= 1.0.0)
+      torquebox-messaging (= 1.0.0)
+      torquebox-naming (= 1.0.0)
+      torquebox-rake-support (= 1.0.0)
+      torquebox-vfs (= 1.0.0)
+      torquebox-web (= 1.0.0)
+    torquebox-base (1.0.0-java)
+    torquebox-messaging (1.0.0-java)
+      torquebox-base (= 1.0.0)
+      torquebox-naming (= 1.0.0)
+    torquebox-naming (1.0.0-java)
+    torquebox-rake-support (1.0.0)
+    torquebox-vfs (1.0.0-java)
+    torquebox-web (1.0.0-java)
     watchr (0.7)
 
 PLATFORMS
@@ -56,14 +57,15 @@ PLATFORMS
 DEPENDENCIES
   haml (~> 3.0)
   jeweler
-  jmx (= 0.7)
   json
   rack-accept
   rack-flash
   rack-test
   rspec
+  sass (~> 3.0)
   sinatra (= 1.1.2)
   thor
+  tobias-jmx (= 0.8)
   tobias-sinatra-url-for
-  torquebox (= 1.0.0.CR2)
+  torquebox (= 1.0.0)
   watchr

data/README.md

@@ -100,7 +100,9 @@ Returns:
         "topics":"http://localhost:8080/backstage/topics?format=json",
         "message_processors":"http://localhost:8080/backstage/message_processors?format=json",
         "jobs":"http://localhost:8080/backstage/jobs?format=json",
-        "services":"http://localhost:8080/backstage/services?format=json"
+        "services":"http://localhost:8080/backstage/services?format=json",
+        "pools":"http://localhost:8080/backstage/pools?format=json",
+        "logs":"http://localhost:8080/backstage/logs?format=json"
       }
     }
 

data/Rakefile

@@ -16,8 +16,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "torquebox-backstage"
   gem.homepage = "http://github.com/torquebox/backstage"
   gem.license = "MIT"
-  gem.summary = %Q{BackStage - Queue/Topic/Job viewer for TorqueBox}
-  gem.description = %Q{BackStage - Queue/Topic/Job viewer for TorqueBox}
+  gem.summary = %Q{BackStage - Queue/Topic/Job/etc viewer for TorqueBox}
+  gem.description = %Q{BackStage allows you to look behind the TorqueBox curtain, and view information about all of the components you have running. It includes support for remote code execution and log tailing to aid in debugging.}
   gem.email = "tcrawley@redhat.com"
   gem.authors = ["Tobias Crawley"]
   gem.files = FileList["[A-Z]*", 'backstage.rb', 'config.ru', 'bin/*.rb', "{config,lib,spec,views}/**/*"]

data/TODO

@@ -7,4 +7,4 @@ TODO
 * improve test coverage
 * add stats collection, with memory usage and other bits? ruby runtime stats?
 * link to app context (requires TB changes)
-* allow log tailing/download 
+* allow log download

data/TORQUEBOX_VERSION

@@ -1 +1 @@
-1.0.0.CR2
+1.0.0

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/backstage.rb

@@ -34,24 +34,26 @@ require 'apps'
 require 'destinations'
 require 'message_processors'
 require 'jobs'
+require 'logs'
 require 'services'
 
 
-puts "ENV['REQUIRE_AUTHENTICATION'] is not set, *disabling* authentication" unless ENV['REQUIRE_AUTHENTICATION'] 
+Backstage.logger.warn "ENV['REQUIRE_AUTHENTICATION'] is not set, *disabling* authentication" unless ENV['REQUIRE_AUTHENTICATION'] 
 
 module Backstage
   BACKSTAGE_VERSION = File.readlines( File.join( File.dirname( __FILE__ ), 'VERSION' ) ).first.strip
   TORQUEBOX_VERSION = File.readlines( File.join( File.dirname( __FILE__ ), 'TORQUEBOX_VERSION' ) ).first.strip
 
   class Application < Sinatra::Base
-    enable :logging, :sessions
+    enable :sessions
     use Rack::Accept
     use Rack::Flash
-
+    use Rack::CommonLogger, Backstage.logger
+    
     include Backstage::Authentication 
 
     set :views, Proc.new { File.join( File.dirname( __FILE__ ), "views" ) }
-
+    
     before do
       require_authentication if ENV['REQUIRE_AUTHENTICATION']
     end
@@ -60,7 +62,7 @@ module Backstage
       content_type :json
 
       {
-        :collections => [:pools, :apps, :queues, :topics, :message_processors, :jobs, :services].inject({}) do |collections, collection|
+        :collections => [:pools, :apps, :queues, :topics, :message_processors, :jobs, :services, :logs].inject({}) do |collections, collection|
           collections[collection] = json_url_for( collection_path( collection ) )
           collections
         end
@@ -68,7 +70,11 @@ module Backstage
     end
     
     get '/' do
-      redirect_to collection_path( :apps ) 
+      if html_requested?
+        haml :'dashboard/index'
+      else
+        redirect_to '/url'
+      end
     end
 
     get '/css/style.css' do

data/config/torquebox.yml

@@ -1,5 +1,6 @@
 web:
   context: /backstage
+  static: public
 
 tasks:
   Backgroundable:

data/lib/apps/models/app.rb

@@ -27,7 +27,24 @@ module Backstage
     def self.to_hash_attributes
       super + [:name, :environment_name, :root_path, :deployed_at]
     end
+
+    def has_logs?
+      File.directory?( log_dir )
+    end
     
+    def logs
+      logs = Log.all( log_dir )
+      logs.each { |log| log.parent = self }
+      logs
+    end
+
+    def log_dir
+      log_dir = File.join( root_path, 'logs' )
+      log_dir = File.join( Backstage.jboss_log_dir, name ) if !File.directory?( log_dir ) && Backstage.jboss_log_dir
+      log_dir = File.join( root_path, 'log' ) unless File.directory?( log_dir )
+
+      log_dir
+    end
   end
 end
 

data/lib/apps/routes.rb

@@ -14,5 +14,33 @@
 # limitations under the License.
 #
 
-Backstage::Application.resource :app
+module Backstage
+  class Application < Sinatra::Base
+    resource :app
+
+    get "/app/:name/logs" do
+      @parent = App.find( Util.decode_name( params[:name] ) )
+      @collection = @parent.logs
+      if html_requested?
+        haml :'logs/index'
+      else
+        content_type :json
+        collection_to_json( @collection )
+      end
+    end
+
+     get "/app/:name/log/:id" do
+      @parent = App.find( Util.decode_name( params[:name] ) )
+      @object = Log.find( Util.decode_name( params[:id] ) )
+      @object.parent = @parent
+                          
+      if html_requested?
+        haml :'logs/show'
+      else
+        object_to_json( @object )
+      end
+    end
+
+  end
+end
 

data/lib/destinations/models/destination.rb

@@ -43,8 +43,8 @@ module Backstage
         yield message
       end
     rescue Exception => ex
-      puts "WARNING - failed to access messages for queue #{jndi_name}: #{ex}"
-      puts ex.backtrace.join( "\n" )
+      Backstage.logger "WARNING - failed to access messages for queue #{jndi_name}: #{ex}"
+      Backstage.logger ex
     end
     
     def display_name
@@ -72,6 +72,16 @@ module Backstage
       name =~ %r{/queues/torquebox/(.*)} ? $1 : 'n/a'
     end
 
+    def pause
+      super
+      self
+    end
+
+    def resume
+      super
+      self
+    end
+
     def status
       mbean.paused ? 'Paused' : 'Running'
     end

data/lib/destinations/routes.rb

@@ -38,7 +38,19 @@ module Backstage
         object_to_json( @object )
       end
     end
-    
+
+    # we can't implement move until we figure out how to get the
+    # actual HQ internal message id on the client side
+    # post "/queue/:name/message/:id/move" do
+    #   @destination = Queue.find( Util.decode_name( params[:name] ) )
+    #   @destination.mbean.move_message( params[:id], params[:queue])
+    #   if html_requested?
+    #     haml :'messages/show'
+    #   else
+    #     object_to_json( @destination )
+    #   end
+    # end
+
   end
 end
 

data/lib/has_mbean.rb

@@ -16,6 +16,7 @@
 
 module Backstage
   module HasMBean
+    include Comparable
     java_import javax.management.ObjectName
 
     def self.included(base)
@@ -27,6 +28,10 @@ module Backstage
       self.mbean_name = mbean_name
       self.mbean = mbean
     end
+
+    def <=>(other)
+      full_name <=> other.full_name
+    end
     
     def full_name
       mbean_name.to_s
@@ -44,7 +49,7 @@ module Backstage
       end
 
       def all(filter_string = filter)
-        jmx_server.query_names( filter_string ).collect { |name| new( name, jmx_server[name] ) }
+        jmx_server.query_names( filter_string ).collect { |name| new( name, jmx_server[name] ) }.sort
       end
 
       def find(name)

data/lib/helpers.rb

@@ -13,14 +13,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
+require 'logger'
 require 'util'
 require 'authentication'
 require 'sinatra/url_for'
 
 module Backstage
-  class Application < Sinatra::Base
+  def self.jboss_log_dir
+    java.lang.System.get_property( 'jboss.server.log.dir' )
+  end
+
+  def self.jboss_app_name
+    App.find( "torquebox.apps:app=torquebox-backstage" ) ? 'torquebox-backstage' : 'backstage'
+  end
+
+  def self.logger
+    return @logger if @logger
     
+    # log to <jboss log dir>/torquebox/<RACK_ENV>.log if you can,
+    # otherwise do <app dir>/log/<RACK_ENV>.log
+    if Backstage.jboss_log_dir && File.directory?( Backstage.jboss_log_dir )
+      log_dir = File.join( Backstage.jboss_log_dir, Backstage.jboss_app_name )
+    else
+      log_dir = File.join( File.dirname( __FILE__ ), '..', 'log' )
+    end
+    FileUtils.mkdir_p( log_dir )
+    
+    @logger = Logger.new( File.join( log_dir, "#{ENV['RACK_ENV']}.log" ) )
+  end
+  
+  class Application < Sinatra::Base
+
     helpers do
       include Backstage::Authentication
       include Sinatra::UrlForHelper
@@ -29,7 +52,7 @@ module Backstage
         options[:format] = 'json'
         url_for( fragment, :full, options )
       end
-      
+
       def object_path(object)
         object_action_or_collection_path(*(object.association_chain << nil))
       end
@@ -45,7 +68,7 @@ module Backstage
       end
       alias_method :object_action_path, :object_action_or_collection_path
       alias_method :collection_path, :object_action_or_collection_path
-      
+
       def redirect_to(location)
         redirect url_for(location, :full)
       end
@@ -59,15 +82,15 @@ module Backstage
         dom_class << 'status' << value.downcase if name.to_s.downcase == 'status' # hack
         "<tr class='data-row'><td class='label'>#{name}</td><td class='#{dom_class.join(' ')}'>#{value}</td></tr>"
       end
-      
+
       def simple_class_name(object)
         object.class.name.split( "::" ).last.underscore
       end
-      
+
       def truncate(text, length = 30)
         text.length > length ? text[0...length] + '...' : text
       end
-      
+
       def class_for_body
         klass = request.path_info.split('/').reverse.select { |part| part =~ /^[A-Za-z_]*$/ }
         klass.empty? ? 'root' : klass
@@ -85,21 +108,24 @@ module Backstage
       def html_requested?
         params[:format] != 'json' && env['rack-accept.request'].media_type?( 'text/html' )
       end
-      
+
       def collection_to_json( collection )
         JSON.generate( collection.collect { |object| object_to_hash( object ) } )
       end
 
       def object_to_json(object)
-        JSON.generate( object_to_hash( object ) )  
+        JSON.generate( object_to_hash( object ) )
       end
-      
+
       def object_to_hash(object)
         response = object.to_hash
-        response[:actions] = object.available_actions.inject({}) do |actions, action|
-          actions[action] = json_url_for( object_action_path( response[:resource], action ) )
-          actions
+        if object.respond_to?( :available_actions )
+          response[:actions] = object.available_actions.inject({}) do |actions, action|
+            actions[action] = json_url_for( object_action_path( response[:resource], action ) )
+            actions
+          end
         end
+        
         response.each do |key, value|
           if value.kind_of?( Resource )
             response[key] = json_url_for( object_path( value ) )
@@ -115,10 +141,57 @@ module Backstage
         response
       end
 
+      def human_size(size)
+        if size > 1024
+          size = size.to_f
+          if size > 1024*1024
+            size /= 1024*1024
+            suffix = 'Mb'
+          elsif size > 1024
+            size /= 1024
+            suffix = 'kb'
+          end
+          size = size.round( 2 )
+        else
+          suffix = 'b'
+        end
+
+        "#{size} #{suffix}"
+      end
+
+      def torquebox_version_info
+        versions = []
+        torquebox = JMX::MBeanServer.new[javax.management.ObjectName.new( 'torquebox:type=system' )]
+        versions << ['Version', torquebox.version]
+        versions << ['Build Number', torquebox.build_number]
+        versions << ['Revision', torquebox.revision]
+        versions
+      end
+
+      def hornetq_version_info
+        versions = []
+        hornetq = JMX::MBeanServer.new[javax.management.ObjectName.new( 'org.hornetq:module=Core,type=Server' )]
+        versions << ['Version', hornetq.version]
+        versions << ['Clustered', hornetq.clustered]
+        versions
+      end
+
+      def jboss_version_info
+        versions = []
+        jboss = JMX::MBeanServer.new[javax.management.ObjectName.new( 'jboss.system:type=Server' )]
+        versions << ['Version', jboss.version]
+        versions
+      end
     end
   end
 end
 
+class Object
+  def blank?
+    nil? or (respond_to?( :empty? ) and empty?)
+  end
+end
+
 class String
   def classify
     if self =~ %r{/}
@@ -133,11 +206,11 @@ class String
   def constantize
     eval( classify )
   end
-  
+
   def underscore
     gsub(/([a-zA-Z])([A-Z])/, '\1_\2').downcase
   end
-  
+
   def humanize
     split( '_' ).collect( &:capitalize ).join( ' ' )
   end
@@ -147,3 +220,7 @@ class String
     "#{self}s"
   end
 end
+
+class Logger
+  alias_method :write, :<<
+end