JBoss.orgCommunity Documentation
This chapter explains how to start and use the tools framework and what tools are available.
There are currently two command-line editors for manipulating the ObjectStore. These tools are used to manipulate the lists of heuristic participants maintained by a transaction log. They allow a heuristic participant to be moved from that list back to the list of prepared participants so that transaction recovery may attempt to resolve them automatically.
Started by executing com.arjuna.ats.arjuna.tools.log.LogBrowser, this tool supports
the following options that can be provided on the command-line.
Table 5.1. LogEditor Options
| Option | Description |
|---|---|
-tx id | Specifies the transaction log to work on. |
-type name | The transaction type to work on. |
| -dump | Print out the contents of the log identified by the other options. |
-forget index | Move the specified target from the heuristic list to the prepared list. |
| -help | Print out the list of commands and options. |
The LogBrowser, invoked by calling com.arjuna.ats.arjuna.tools.log.LogBrowser, is
similar to the LogEditor, but allows multiple log instances to be manipulated. It presents a shell-like
interface, with the following options:
Table 5.2. LogBrowserOptions
| Option | Description |
|---|---|
ls [type] | List the logs for the specified type. If no type is specified, the editor must already be attached to the transaction type. |
select [type] | Browse a specific transaction type. If already attached to a transaction type, you are detached from that type first. |
attach log | Attach the console to the specified transaction log. If you are attached to another log, the command will fail. |
| detach | Detach the console from the current log. |
forget pid | Move the specified heuristic participant back to the |
delete pid | Delete the specified heuristic participant. The console must be attached. |
| types | List the supported transaction types. |
| quit | Exit the console tool. |
| help | Print out the supported commands. |
Transaction management is integrated into the admin console in the form of a JOPR plugin which is located in the install bin directory (jbossts-jopr-plugin.jar). Install it by copying to the admin console plugin directory ($JBOSS_HOME/common/deploy/admin-console.war/plugins).
There is a transaction statistics graphing tool which can run standalone or inside a jconsole tab (jconsole is a tool for managing JVMs and is distributed with the reference JDK):
The tool depends on the JFree graphing library. Download and unpack orson from http://www.jfree.org/orson. Set the env variable ORSON_HOME to the directory where you plan to unpack the downloaded zip. If you intend to use the tool with jconsole you will also need to put the JDK tools and jconsole jars on the classpath:
export CLASSPATH="$JDK_HOME/lib/tools.jar:$JDK_HOME/lib/jconsole.jar:$ORSON_HOME/orson-0.5.0.jar:$ORSON_HOME/lib/jfreechart-1.0.6.jar:$ORSON_HOME/lib/jcommon-1.0.10.jar:$INSTALL_ROOT/lib/narayana-jta.jar>"
java com.arjuna.ats.arjuna.tools.stats.TxPerfGraph
(note that standalone usage does not require the JDK tools and jconsole jars)