[jboss-svn-commits] JBL Code SVN: r14730 - labs/jbossesb/trunk/product/tools/console.

[jboss-svn-commits at lists.jboss.org]

Author: tcunning
Date: 2007-08-29 08:51:00 -0400 (Wed, 29 Aug 2007)
New Revision: 14730

Added:
   labs/jbossesb/trunk/product/tools/console/MANAGEMENT-README.txt
Log:
bug:JBESB-925
Add readme for management/monitoring console


Added: labs/jbossesb/trunk/product/tools/console/MANAGEMENT-README.txt
===================================================================
--- labs/jbossesb/trunk/product/tools/console/MANAGEMENT-README.txt	                        (rev 0)
+++ labs/jbossesb/trunk/product/tools/console/MANAGEMENT-README.txt	2007-08-29 12:51:00 UTC (rev 14730)
@@ -0,0 +1,53 @@
+JBossESB Management/Monitoring Console :
+The JBossESB monitoring console gathers information on the performance of
+different ESB services that are deployed and keeps historical state information
+of settings over a period of time.
+
+To run with hsqldb:
+
+1) cd tools/console/management-esb
+2) ant deploy
+3) Point your browser to http://localhost:8080/jbossesb
+
+
+Alternative database usage :
+By default, the monitoring/management console uses hsqldb as a back-end
+database.    It has also been tested with Oracle and MySQL, but could be
+extended to use any other JDBC/hibernate-supported database.
+
+In the management-esb directory there is a db.properties file.    In order
+to change the database from hsqldb to mysql or oracle, edit this file and
+change the db property to "mysql" or "oracle".
+
+Next, change the management-esb/src/main/resources/<db>/management-ds.xml
+file so that the settings match the datasource for your database. 
+
+JBoss ships with hsqldb.jar in the server/<instance>/lib directory.    In
+order to use a different database as a back-end, please also the JDBC driver
+into the server/<instance>/lib directory of your application server.
+
+For MySQL, it may be necessary to create the database "statistics" before 
+deploying if you have not edited the management-ds.xml file.
+
+
+Collection Periods :
+
+The period of time in between collections is by default 10 minutes, but
+can be set to any period of minutes that is desired.     The default
+collection period can be changed at build time by changing the
+pollMinuteFrequency property in management-esb/db.properties, or 
+by changing the PollMinuteFrequency property in the 
+jboss.esb:service=DataFilerScheduler MBean in the management console 
+or in jmx-console.  
+
+
+Incorporating custom MBeans into monitoring :
+The JBossESB management/monitoring console is extensible to any set of
+custom MBeans you may want to deploy into JBoss ESB.   The MBeans that it
+shows and keeps data on are MBeans that are from a particular domain and
+match a particular key pattern.       If you have a set of MBeans that you 
+would like to insert, you could insert their domain and key pattern into
+
+management-esb/src/main/resources/<db>/insert_rows.sql 
+
+and the information would be recorded during every collection period.