[jboss-cvs] JBoss Profiler SVN: r537 - branches/JBossProfiler2/doc/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sun May 31 07:29:59 EDT 2009
Author: jesper.pedersen
Date: 2009-05-31 07:29:58 -0400 (Sun, 31 May 2009)
New Revision: 537
Modified:
branches/JBossProfiler2/doc/userguide/en/modules/reports.xml
Log:
documentation updates
Modified: branches/JBossProfiler2/doc/userguide/en/modules/reports.xml
===================================================================
--- branches/JBossProfiler2/doc/userguide/en/modules/reports.xml 2009-05-30 17:38:10 UTC (rev 536)
+++ branches/JBossProfiler2/doc/userguide/en/modules/reports.xml 2009-05-31 11:29:58 UTC (rev 537)
@@ -2,6 +2,15 @@
<chapter id="reports">
<title>Reports</title>
+ <para>The load command generates the reports that will provide you with the information about the application that you profiled.</para>
+
+ <programlisting>
+java -Xmx512m -Djboss-profiler-client.properties=jboss-profiler-client.properties \
+ -jar jboss-profiler-client.jar load 20070806144635343-20070806144638444.jps
+ </programlisting>
+
+ <para>The main report will be located in the generated directory as index.html.</para>
+
<para>The generated reports uses to following abbrevations for the headlines</para>
<table frame="all">
@@ -66,6 +75,28 @@
<para>Provides an overview of all reports.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Snapshot</para>
+ </listitem>
+ <listitem>
+ <para>Thread</para>
+ </listitem>
+ <listitem>
+ <para>Most Time (Top 10)</para>
+ </listitem>
+ <listitem>
+ <para>Hotspots (Top 10)</para>
+ </listitem>
+ <listitem>
+ <para>Allocation</para>
+ </listitem>
+ <listitem>
+ <para>Class</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Packages report -->
@@ -74,6 +105,19 @@
<para>List package information.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>%</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>Package</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Classes report -->
@@ -82,6 +126,19 @@
<para>List class information.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Class</para>
+ </listitem>
+ <listitem>
+ <para>Type</para>
+ </listitem>
+ <listitem>
+ <para>Time</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Methods report -->
@@ -90,6 +147,25 @@
<para>List method information.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>Avg</para>
+ </listitem>
+ <listitem>
+ <para>%</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Hotspots report -->
@@ -98,14 +174,49 @@
<para>List hotspots.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>Avg</para>
+ </listitem>
+ <listitem>
+ <para>%</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Caller report -->
<section id="callerreport">
<title>Caller report</title>
- <para>List callers.</para>
+ <para>List callers - the report is linked from the PerClass report.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Avg</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- Wait time report -->
@@ -114,22 +225,99 @@
<para>List the wait time.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Class</para>
+ </listitem>
+ <listitem>
+ <para>Type</para>
+ </listitem>
+ <listitem>
+ <para>Time</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- PerThread report -->
<section id="perthreadreport">
<title>PerThread report</title>
- <para>List the call strack for all threads.</para>
+ <para>List the call strack for a thread - the report is linked from
+ the Overview report.</para>
+ <para>Information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Thread</para>
+ </listitem>
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Ms (T)</para>
+ </listitem>
+ <listitem>
+ <para>Ms (N)</para>
+ </listitem>
+ <listitem>
+ <para>% (T)</para>
+ </listitem>
+ <listitem>
+ <para>% (N)</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
</section>
<!-- PerClass report -->
<section id="perclassreport">
<title>PerClass report</title>
- <para>List an overview of each class.</para>
+ <para>List an overview of a class.</para>
+ <para>Method information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>% (C)</para>
+ </listitem>
+ <listitem>
+ <para>% (T)</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Hotspot information:</para>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Count</para>
+ </listitem>
+ <listitem>
+ <para>Ms</para>
+ </listitem>
+ <listitem>
+ <para>Avg</para>
+ </listitem>
+ <listitem>
+ <para>%</para>
+ </listitem>
+ <listitem>
+ <para>Method</para>
+ </listitem>
+ </itemizedlist>
+
</section>
</chapter>
More information about the jboss-cvs-commits
mailing list