[jboss-cvs] JBoss Profiler SVN: r536 - in branches/JBossProfiler2/doc: userguide/en/modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sat May 30 13:38:10 EDT 2009
Author: jesper.pedersen
Date: 2009-05-30 13:38:10 -0400 (Sat, 30 May 2009)
New Revision: 536
Modified:
branches/JBossProfiler2/doc/developerguide/en/modules/coding.xml
branches/JBossProfiler2/doc/userguide/en/modules/ant.xml
branches/JBossProfiler2/doc/userguide/en/modules/client.xml
branches/JBossProfiler2/doc/userguide/en/modules/configuration.xml
branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml
branches/JBossProfiler2/doc/userguide/en/modules/reports.xml
Log:
documentation updates
Modified: branches/JBossProfiler2/doc/developerguide/en/modules/coding.xml
===================================================================
--- branches/JBossProfiler2/doc/developerguide/en/modules/coding.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/developerguide/en/modules/coding.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -45,41 +45,43 @@
<section id="cip">
<title>Component identification plugins</title>
+ <para>Component identification plugins must implement the following interface</para>
+
<programlisting>
-Component identification plugins must implement the following interface
+org.jboss.profiler.shared.Plugin
+ </programlisting>
- org.jboss.profiler.shared.Plugin
+ <para>and contain a default constructor.</para>
-and contain a default constructor.
+ <para>Furthermore the plugin must be enabled in both the agent and the client using
+ the "plugins" configuration parameter.</para>
-Furthermore the plugin must be enabled in both the agent and the client using
-the "plugins" configuration parameter.
- </programlisting>
-
</section>
<section id="aj">
<title>Agent Jobs</title>
- <programlisting>
-Agent jobs are tasks that the agent can execute at a specific time and interval.
+ <para>Agent jobs are tasks that the agent can execute at a specific time and interval.</para>
-The jobs can be used to profile your application at a certain time where you think
-there may be a performance problem.
+ <para>The jobs can be used to profile your application at a certain time where you think
+ there may be a performance problem.</para>
-Current job types include:
+ <para>Current job types include:</para>
- Start profiling: org.jboss.profiler.agent.jobs.StartProfiling
- Stop profiling: org.jboss.profiler.agent.jobs.StopProfiling
+ <programlisting>
+Start profiling: org.jboss.profiler.agent.jobs.StartProfiling
+Stop profiling: org.jboss.profiler.agent.jobs.StopProfiling
+ </programlisting>
-A job must extend the following class:
+ <para>A job must extend the following class:</para>
- org.jboss.profiler.agent.jobs.Job
+ <programlisting>
+org.jboss.profiler.agent.jobs.Job
+ </programlisting>
-and contain a default constructor.
+ <para>and contain a default constructor.</para>
-Warning: The jobs override the current settings used in agent.
- </programlisting>
+ <para>Warning: The jobs override the current settings used in agent.</para>
</section>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/ant.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/ant.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/userguide/en/modules/ant.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -2,9 +2,6 @@
<chapter id="ant">
<title>Apache Ant integration</title>
- <para>JBoss Tattletale uses 2 spaces for indentation with curly brakets on the same line
- as the class or the statement.</para>
-
<programlisting>
Profiler Ant tasks:
-------------------
Modified: branches/JBossProfiler2/doc/userguide/en/modules/client.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/client.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/userguide/en/modules/client.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -2,6 +2,11 @@
<chapter id="client">
<title>Command line client</title>
+ <para>The suite features a command line client where you are able to control
+ the operation of the agent as well as generating the profiling reports.</para>
+
+ <section>
+ <title>Overview</title>
<programlisting>
Usage: Client [-h host] [-p port] <command>
startProfiler : Start the profiler
@@ -22,62 +27,225 @@
Host defaults to 'localhost'.
Port defaults to '5400'.
+ </programlisting>
-The default extension for the generated snapshot is JBoss Profiler Snapshot (.JPS).
+ <para>The default extension for the generated snapshot is JBoss Profiler Snapshot (.JPS).</para>
+ </section>
-Examples:
+ <section>
+ <title>Commands</title>
-Client startProfiler
-Client stopProfiler
-Client snapshot
-Client getSnapshot 1
-Client listSnapshots
-Client clearSnapshots
-Client gc
-Client enable
-Client disable
-Client load 20070806144635343-20070806144638444.jps
-Client load 20070806144635343/
-Client save 1
-Client save 1 mysnapshot.jps
-Client diff oldsnapshot.jps newsnapshot.jps
-Client add org.jboss.profiler.test.* public
-Client remove org.jboss.profiler.test.*
-Client list
- </programlisting>
+ <section id="startcmd">
+ <title>startProfiler</title>
+ <para>Start the profiler.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar startProfiler
+ </programlisting>
+ </section>
- <programlisting>
-jboss-profiler-client.properties:
----------------------------------
-protocol Protocol to use
- [socket|rmi|http] default: socket
+ <section id="stopcmd">
+ <title>stopProfiler</title>
+ <para>Stop the profiler.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar stopProfiler
+ </programlisting>
+ </section>
-host The host name
- default: localhost
+ <section id="snapshotcmd">
+ <title>snapshot</title>
+ <para>Take a snapshot.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar snapshot
+ </programlisting>
+ </section>
-port The port number
- default: 5400
+ <section id="getsnapshotcmd">
+ <title>getSnapshot</title>
+ <para>Get a snapshot.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar getSnapshot 1
+ </programlisting>
+ </section>
-threshold Method threshold in ms
- default: 1.0
+ <section id="listsnapshotscmd">
+ <title>listSnapshots</title>
+ <para>List available snapshots.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar listSnapshots
+ </programlisting>
+ </section>
-plugin.<number> Plugin to load
- class
- f.ex: plugin.1=org.jboss.profiler.plugins.Hibernate
- </programlisting>
+ <section id="clearsnapshotscmd">
+ <title>clearSnapshots</title>
+ <para>Clear all snapshots.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar clearSnapshots
+ </programlisting>
+ </section>
- <section id="runcmd">
- <title>Running the client</title>
+ <section id="gccmd">
+ <title>gc</title>
+ <para>Trigger garbage collection.</para>
<programlisting>
java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
- -jar jboss-profiler-client.jar load file.jps
+ -jar jboss-profiler-client.jar gc
</programlisting>
+ </section>
- <para>Output: Directory with analysis reports</para>
+ <section id="enablecmd">
+ <title>enable</title>
+ <para>Enable the profiler.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar enable
+ </programlisting>
</section>
+ <section id="disablecmd">
+ <title>disable</title>
+ <para>Disable the profiler.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar disable
+ </programlisting>
+ </section>
+
+ <section id="loadcmd">
+ <title>load</title>
+ <para>Load a snapshot from either a file or a directory. This command will generate
+ all the reports.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar load 20070806144635343-20070806144638444.jps
+ </programlisting>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar load 20070806144635343/
+ </programlisting>
+ </section>
+
+ <section id="savecmd">
+ <title>save</title>
+ <para>Save a snapshot to its default name or the specified name.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar save 1
+ </programlisting>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar save 1 mysnapshot.jps
+ </programlisting>
+ </section>
+
+ <section id="diffcmd">
+ <title>diff</title>
+ <para>Compare two snapshots.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar diff oldsnapshot.jps newsnapshot.jps
+ </programlisting>
+ </section>
+
+ <section id="addcmd">
+ <title>add</title>
+ <para>Add classes that should be profiled.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar add org.jboss.profiler.test.* public
+ </programlisting>
+ </section>
+
+ <section id="removecmd">
+ <title>remove</title>
+ <para>Remove classes that should not be profiled anymore.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar remove org.jboss.profiler.test.*
+ </programlisting>
+ </section>
+
+ <section id="listcmd">
+ <title>list</title>
+ <para>List classes being profiled.</para>
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar list
+ </programlisting>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Configuration</title>
+
+ <para>The configuration of the command client is done in</para>
+
+ <programlisting>
+jboss-profiler-client.properties
+ </programlisting>
+
+ <table frame="all">
+ <title>JBoss Profiler command line client configuration</title>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry align="left">Key</entry>
+ <entry align="left">Value</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>protocol</entry>
+ <entry>
+ <para>Protocol to use.</para>
+ <para>[socket|rmi|http] default: socket.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>host</entry>
+ <entry>
+ <para>The host name.</para>
+ <para>Default: localhost.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>port</entry>
+ <entry>
+ <para>The port number.</para>
+ <para>Default: 5400.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>threshold</entry>
+ <entry>
+ <para>Method threshold in ms.</para>
+ <para>Default: 1.0.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>plugin.<number></entry>
+ <entry>
+ <para>Plugin to load.</para>
+ <para>Class</para>
+ <para>plugin.1=org.jboss.profiler.plugins.Hibernate</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
<section id="runexample">
<title>Running the example</title>
+ <para>The example in the SVN repository can be run with:</para>
<programlisting>
java -javaagent:jboss-profiler.jar=remote=no \
-Djboss-profiler.properties=jboss-profiler.properties \
Modified: branches/JBossProfiler2/doc/userguide/en/modules/configuration.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/configuration.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/userguide/en/modules/configuration.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -14,7 +14,7 @@
<title>JBoss Profiler configuration</title>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1"/>
- <colspec colname="c2" colwidth="4*"/>
+ <colspec colname="c2" colwidth="3*"/>
<thead>
<row>
<entry align="left">Key</entry>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/userguide/en/modules/jbossas.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -2,11 +2,16 @@
<chapter id="jbossas">
<title>JBoss Application Server</title>
+ <section>
+ <title>Communicator MBean</title>
+
+ <para>Configuration can be found in</para>
+
<programlisting>
-Communicator MBean:
--------------------
-Configuration can be found in jboss-profiler.sar/META-INF/jboss-service.xml
+jboss-profiler.sar/META-INF/jboss-service.xml
+ </programlisting>
+ <programlisting>
Socket Should socket communication be enabled ?
[true|false] default: true
@@ -26,10 +31,15 @@
default: 5402
</programlisting>
- <programlisting>
-Twiddle:
---------
-Information:
+ </section>
+
+ <section>
+ <title>Twiddle</title>
+
+ <section>
+ <title>Information</title>
+
+ <programlisting>
./twiddle.sh get 'org.jboss.profiler:service=Profiler' Running
./twiddle.sh get 'org.jboss.profiler:service=Profiler' Enabled
./twiddle.sh get 'org.jboss.profiler:service=Profiler' Memory
@@ -40,8 +50,13 @@
./twiddle.sh get 'org.jboss.profiler:service=Profiler' JMX
./twiddle.sh get 'org.jboss.profiler:service=Profiler' RMI
./twiddle.sh get 'org.jboss.profiler:service=Profiler' CORBA
+ </programlisting>
-Operations:
+ </section>
+
+ <section>
+ <title>Operations</title>
+ <programlisting>
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' startProfiler
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' stopProfiler
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' enableProfiler
@@ -50,6 +65,8 @@
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' addClasses org.jboss.test.* public
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' removeClasses org.jboss.test.*
./twiddle.sh invoke 'org.jboss.profiler:service=Profiler' listClasses
- </programlisting>
+ </programlisting>
+ </section>
+ </section>
</chapter>
Modified: branches/JBossProfiler2/doc/userguide/en/modules/reports.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/reports.xml 2009-05-29 17:29:59 UTC (rev 535)
+++ branches/JBossProfiler2/doc/userguide/en/modules/reports.xml 2009-05-30 17:38:10 UTC (rev 536)
@@ -64,54 +64,72 @@
<section id="overviewreport">
<title>Overview report</title>
+ <para>Provides an overview of all reports.</para>
+
</section>
<!-- Packages report -->
<section id="packagesreport">
<title>Packages report</title>
+ <para>List package information.</para>
+
</section>
<!-- Classes report -->
<section id="classesreport">
<title>Classes report</title>
+ <para>List class information.</para>
+
</section>
<!-- Methods report -->
<section id="methodsreport">
<title>Methods report</title>
+ <para>List method information.</para>
+
</section>
<!-- Hotspots report -->
<section id="hotspotsreport">
<title>Hotspots report</title>
+ <para>List hotspots.</para>
+
</section>
<!-- Caller report -->
<section id="callerreport">
<title>Caller report</title>
+ <para>List callers.</para>
+
</section>
<!-- Wait time report -->
<section id="waittimereport">
<title>Wait time report</title>
+ <para>List the wait time.</para>
+
</section>
<!-- PerThread report -->
<section id="perthreadreport">
<title>PerThread report</title>
+ <para>List the call strack for all threads.</para>
+
</section>
<!-- PerClass report -->
<section id="perclassreport">
<title>PerClass report</title>
+ <para>List an overview of each class.</para>
+
</section>
</chapter>
More information about the jboss-cvs-commits
mailing list