[jboss-svn-commits] JBL Code SVN: r30636 - labs/jbosstm/workspace/whitingjr/trunk/performance.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Mon Dec 14 11:43:16 EST 2009


Author: whitingjr
Date: 2009-12-14 11:43:16 -0500 (Mon, 14 Dec 2009)
New Revision: 30636

Modified:
   labs/jbosstm/workspace/whitingjr/trunk/performance/CONFIGURATION.txt
   labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt
   labs/jbosstm/workspace/whitingjr/trunk/performance/README.txt
Log:
Updated documentation.

Modified: labs/jbosstm/workspace/whitingjr/trunk/performance/CONFIGURATION.txt
===================================================================
--- labs/jbosstm/workspace/whitingjr/trunk/performance/CONFIGURATION.txt	2009-12-14 16:42:52 UTC (rev 30635)
+++ labs/jbosstm/workspace/whitingjr/trunk/performance/CONFIGURATION.txt	2009-12-14 16:43:16 UTC (rev 30636)
@@ -22,6 +22,6 @@
 src/test/resources/testsuite-integration-ejb3.xml - invoke_optional_write
 
 * Select an interesting method for analysis.
-src/main/resources/properties/database/<db-vendor>/db-profile.properties - db-vendor.method.xpaths
+src/main/resources/properties/database/<db-vendor>/db-profile.properties - <db-vendor>.db-vendor.method.xpaths
 build.properties - testcase.xpaths
  
\ No newline at end of file

Modified: labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt
===================================================================
--- labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt	2009-12-14 16:42:52 UTC (rev 30635)
+++ labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt	2009-12-14 16:43:16 UTC (rev 30636)
@@ -20,37 +20,39 @@
    The <dbvendor> directory name is used later in these configuration instructions 
    and executing the profiling.
    
-   Now configure the database connection details for the installation type.
-   You will find two properties files for each installation type. These allow multiple 
-   resources to be configured. Only two resources per vendor installation are supported.
+   Now configure the database connection details for the installation type. Each installation
+   supports two resources. The second resource is used for distributed transaction 
+   profiling.
    
-   For each database vendor three types of installation are supported. Embedded,
+   For each database vendor three (physical) types of installation are supported. Embedded,
    co-located and remote. The configuration details are repeated for each resource. 
-   This allows database by different vendors to be used concurrently. There is a  
-   common vendor properties file.
+   This allows profiling databases by different vendors to be run concurrently. There is a  
+   common vendor properties file per vendor. The resource specific version uses the vendor
+   version.
    ./src/main/resources/properties/database/<dbvendor>/db-profile.properties
-   each installation will have two files.
-   ./src/main/resources/properties/database/<dbvendor>/database-locations/<installation>/db-installation.properties
-   ./src/main/resources/properties/database/<dbvendor>/database-locations/<installation>/second-resource-installation.properties
-   By editing the 'db-vendor.method.xpaths.X' property you can select particular 
-   methods for summary information.
-
-   Configuring the profiled classes for each vendor requires identifying the package name 
-   in the driver library. It is recommended you use a generic name to ensure most coverage
-   of the driver libraries. for example, the MySQL driver package has two package domains
-   com.mysql and org.gjt
-   This package is added to the 'db-vendor-profiling' property in the database 
-   vendor common properties file. Multiple package names are supported using a comma
-   to separate each. Do not add a period and asterisk at the end. These are not required.
+   For each reasource are two configuration files. The first for connection details and
+   the second for the resource.
+   ./src/main/resources/properties/database/<dbvendor>/database-locations/<installation>/resource<A|B>/connection.properties
+   ./src/main/resources/properties/database/<dbvendor>/database-locations/<installation>/resource<A|B>/resource.properties
    
+   Configuring the JIP profiler to recognise classes for each vendor requires identifying 
+   the package name of the driver library. It is recommended you use a generic name to
+    ensure complete coverage of the driver libraries. for example, the MySQL driver package
+    has two package domains com.mysql and org.gjt
+   Multiple package names are supported using a comma to separate each. Do not add a
+   period and asterisk at the end. It is not required for the profiler to recognize the
+   package and it's contents recursively.
+   
    Select an appropriate class for controlling the database during setup. Some vendors
    support sequences whereas others do not. If a class has not been provided then
    implement one using existing classes as guideline. You will need to
    extend org.jboss.jbossts.performance.persistence.vendor.AbstractVendorControl
    The controlling of unique identities is handled by Hibernate. A technique for creating
-   identifiers independent of database vendor is used.
+   identifiers independent of database vendor is used. See the Hibernate support for the
+   database vendor type. The hibernate extension called SequenceStyleGenerator creates
+   identitiy for Entity classes.
    
-   By editing this property you will control which methods have summary information generated.
+   To control which methods have summary information generated edit the following property.
    ./build.properties - testcase.xpaths
    This property is a csv. Notice between the class and method is a ':' colon. Use this 
    instead of a period.

Modified: labs/jbosstm/workspace/whitingjr/trunk/performance/README.txt
===================================================================
--- labs/jbosstm/workspace/whitingjr/trunk/performance/README.txt	2009-12-14 16:42:52 UTC (rev 30635)
+++ labs/jbosstm/workspace/whitingjr/trunk/performance/README.txt	2009-12-14 16:43:16 UTC (rev 30636)
@@ -1,8 +1,24 @@
 JBossTM Performance profiling project: 
 
- This version is the first successful integration of a profiling tool with Caveat Emptor.
+Background
 
-   
+ This project integrates a profiling tool (JIP) with the sample Caveat Emptor application. The purpose
+ is quantifying the proportion of time necessary to use reliable state changes across multiple
+ resources versus unreliable state changes (failure intollerant).
+ 
+ The profiling tool out of the box is an open source project called Java Interactive Profiler (JIP).
+ Using JIP allows the freedom for distributing this project and trying the profiling framework 
+ without proprietary software. The JIP profiler provides adequate functionality for capturing 
+ data interactively and storing it in XML format for later analysis.
+ 
+ Using the TestNG framework allowed configuring the testing framework to warmup the
+ system being profiled without the profiler running.
+
+Additional information.
+
+ The project uses a combination of Ant, JIP and TestNG for executing test cases. To analyse
+ the profiling data XSL stylesheets are used to generate summary information.
+
 Release Notes:
 
 0.1 -  Includes proof of concept with a demonstration application.
@@ -25,10 +41,8 @@
 0.4    Added multi XA resource persistence configuration. 
 
 0.5    Supports filtering and merging of results into categories.
-         - Uses two properties for configuration.
+       Added support for using different profilers.
 
 Known issues:
 
 * Derby database implementation does not support relaxing integrety constraints. The sample data provided using DBUnit import needs constraints turning off. This makes Derby an unsuitable database to use with this performance framework.
-* MySQL does not provide complete XA spec support for distributed transactions.
-



More information about the jboss-svn-commits mailing list