You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jmeter-dev@jakarta.apache.org by se...@apache.org on 2009/05/19 17:50:21 UTC
svn commit: r776364 - in /jakarta/jmeter/trunk:
docs/usermanual/component_reference.html docs/usermanual/glossary.html
xdocs/usermanual/component_reference.xml xdocs/usermanual/glossary.xml
Author: sebb
Date: Tue May 19 15:50:20 2009
New Revision: 776364
URL: http://svn.apache.org/viewvc?rev=776364&view=rev
Log:
Documentation tweaks
Modified:
jakarta/jmeter/trunk/docs/usermanual/component_reference.html
jakarta/jmeter/trunk/docs/usermanual/glossary.html
jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml
jakarta/jmeter/trunk/xdocs/usermanual/glossary.xml
Modified: jakarta/jmeter/trunk/docs/usermanual/component_reference.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/usermanual/component_reference.html?rev=776364&r1=776363&r2=776364&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/usermanual/component_reference.html (original)
+++ jakarta/jmeter/trunk/docs/usermanual/component_reference.html Tue May 19 15:50:20 2009
@@ -6078,8 +6078,16 @@
<p>
-Listeners do not process sample data in non-GUI mode, but the raw data will be saved if an output
+
+<b>
+Listeners do
+<i>
+not
+</i>
+ process sample data in non-GUI mode, but the raw data will be saved if an output
file has been configured.
+</b>
+
In order to analyse the data generated by a non-GUI test run, you need to load the file into the appropriate
Listener.
@@ -6400,12 +6408,20 @@
<li>
-Median - plot the Median (midway value)
+Median - plot the
+<a href="glossary.html#Median">
+Median
+</a>
+ (midway value)
</li>
<li>
-Deviation - plot the Standard Deviation (a measure of the variation)
+Deviation - plot the
+<a href="glossary.html#StandardDeviation">
+Standard Deviation
+</a>
+ (a measure of the variation)
</li>
@@ -6430,12 +6446,26 @@
</font>
</td></tr>
<tr><td>
+
+
<p>
+
The Spline Visualizer provides a view of all sample times from the start
of the test till the end, regardless of how many samples have been taken. The spline
has 10 points, each representing 10% of the samples, and connected using spline
logic to show a single continuous line.
+
</p>
+
+
+<p>
+
+The graph is automatically scaled to fit within the window.
+This needs to be borne in mind when comparing graphs.
+
+</p>
+
+
<p><b>Control Panel</b></p>
<div align="center"><img width='581' height='440' src="../images/screenshots/spline_visualizer.png"></div>
</td></tr>
@@ -6627,7 +6657,11 @@
<p>
<table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td>
-Calculation of the Median and 90% Line (90
+Calculation of the
+<a href="glossary.html#Median">
+Median
+</a>
+ and 90% Line (90
<sup>
th
</sup>
@@ -6706,7 +6740,15 @@
<li>
-Throughput - Throughput measured in requests per second/minute/hour
+Throughput - the
+<a href="glossary.html#Throughput">
+Throughput
+</a>
+ is measured in requests per second/minute/hour.
+The time unit is chosen so that the displayed rate is at least 1.0.
+When the throughput is saved to a CSV file, it is expressed in requests/second,
+i.e. 30.0 requests/minute is saved as 0.5.
+
</li>
@@ -6719,7 +6761,7 @@
<p>
-Times are in milliseonds.
+Times are in milliseconds.
</p>
@@ -7238,7 +7280,11 @@
<li>
-Std. Dev. - the standard deviation of the sample elapsed time
+Std. Dev. - the
+<a href="glossary.html#StandardDeviation">
+Standard Deviation
+</a>
+ of the sample elapsed time
</li>
@@ -7248,7 +7294,15 @@
<li>
-Throughput - Throughput measured in requests per second/minute/hour
+Throughput - the
+<a href="glossary.html#Throughput">
+Throughput
+</a>
+ is measured in requests per second/minute/hour.
+The time unit is chosen so that the displayed rate is at least 1.0.
+When the throughput is saved to a CSV file, it is expressed in requests/second,
+i.e. 30.0 requests/minute is saved as 0.5.
+
</li>
@@ -7266,7 +7320,7 @@
<p>
-Times are in milliseonds.
+Times are in milliseconds.
</p>
@@ -7599,7 +7653,7 @@
Entries in the jmeter log file also include time-stamps.
The example "806 in 91.6s = 8.8/s" means that there were 806 samples recorded in 91.6 seconds,
and that works out at 8.8 samples per second.
-The Avg (Average), Min(imum) and Max(imum) times are in milliseonds.
+The Avg (Average), Min(imum) and Max(imum) times are in milliseconds.
"Err" means number of errors (also shown as percentage).
The last two lines will appear at the end of a test.
They will not be synchronised to the appropriate time boundary.
Modified: jakarta/jmeter/trunk/docs/usermanual/glossary.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/usermanual/glossary.html?rev=776364&r1=776363&r2=776364&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/usermanual/glossary.html (original)
+++ jakarta/jmeter/trunk/docs/usermanual/glossary.html Tue May 19 15:50:20 2009
@@ -218,6 +218,23 @@
<p>
+<a name="StandardDeviation">
+<b>
+Standard Deviation
+</b>
+</a>
+ is a measure of the variability
+of a data set. This is a standard statistical measure.
+See, for example:
+<a href="http://en.wikipedia.org/wiki/Standard_deviation">
+Standard Deviation
+</a>
+ entry at Wikipedia.
+
+</p>
+<p>
+
+
<a name="ThreadName">
The
<b>
@@ -280,7 +297,11 @@
</a>
is calculated as requests/unit of time.
The time is calculated from the start of the first sample to the end of the last sample.
-This includes any intervals between samples.
+This includes any intervals between samples, as it is supposed to represent the load on the server.
+<br>
+</br>
+
+The formula is: Throughput = (number of requests) / (total time).
</p>
</blockquote>
Modified: jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=776364&r1=776363&r2=776364&view=diff
==============================================================================
--- jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jakarta/jmeter/trunk/xdocs/usermanual/component_reference.xml Tue May 19 15:50:20 2009
@@ -1901,8 +1901,8 @@
Storing as CSV is the most efficient option, but is less detailed than XML (the other available option).
</p>
<p>
-Listeners do not process sample data in non-GUI mode, but the raw data will be saved if an output
-file has been configured.
+<b>Listeners do <i>not</i> process sample data in non-GUI mode, but the raw data will be saved if an output
+file has been configured.</b>
In order to analyse the data generated by a non-GUI test run, you need to load the file into the appropriate
Listener.
</p>
@@ -2005,8 +2005,8 @@
<ul>
<li>Data - plot the actual data values</li>
<li>Average - plot the Average</li>
- <li>Median - plot the Median (midway value)</li>
- <li>Deviation - plot the Standard Deviation (a measure of the variation)</li>
+ <li>Median - plot the <a href="glossary.html#Median">Median</a> (midway value)</li>
+ <li>Deviation - plot the <a href="glossary.html#StandardDeviation">Standard Deviation</a> (a measure of the variation)</li>
<li>Throughput - plot the number of samples per unit of time</li>
</ul>
<p>The individual figures at the bottom of the display are the current values.
@@ -2014,10 +2014,18 @@
</component>
<component name="Spline Visualizer" index="§-num;.3.4" width="581" height="440" screenshot="spline_visualizer.png">
-<description><p>The Spline Visualizer provides a view of all sample times from the start
+<description>
+<p>
+The Spline Visualizer provides a view of all sample times from the start
of the test till the end, regardless of how many samples have been taken. The spline
has 10 points, each representing 10% of the samples, and connected using spline
-logic to show a single continuous line.</p></description>
+logic to show a single continuous line.
+</p>
+<p>
+The graph is automatically scaled to fit within the window.
+This needs to be borne in mind when comparing graphs.
+</p>
+</description>
</component>
<component name="Assertion Results" index="§-num;.3.5" width="658" height="277" screenshot="assertion_results.png">
@@ -2102,7 +2110,7 @@
the Aggregate Report.
</p>
<note>
-Calculation of the Median and 90% Line (90<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>) values requires a lot of memory as details of every Sample have to be saved.
+Calculation of the <a href="glossary.html#Median">Median</a> and 90% Line (90<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>) values requires a lot of memory as details of every Sample have to be saved.
See the <complink name="Summary Report"/> for a similar Listener that does not need so much memory.
</note>
<ul>
@@ -2119,10 +2127,14 @@
<li>Min - The shortest time for the samples with the same label</li>
<li>Max - The longest time for the samples with the same label</li>
<li>Error % - Percent of requests with errors</li>
-<li>Throughput - Throughput measured in requests per second/minute/hour</li>
+<li>Throughput - the <a href="glossary.html#Throughput">Throughput</a> is measured in requests per second/minute/hour.
+The time unit is chosen so that the displayed rate is at least 1.0.
+When the throughput is saved to a CSV file, it is expressed in requests/second,
+i.e. 30.0 requests/minute is saved as 0.5.
+</li>
<li>Kb/sec - The throughput measured in Kilobytes per second</li>
</ul>
-<p>Times are in milliseonds.</p>
+<p>Times are in milliseconds.</p>
</description>
<div align="center">
<p>
@@ -2295,13 +2307,17 @@
<li>Average - The average elapsed time of a set of results</li>
<li>Min - The lowest elapsed time for the samples with the same label</li>
<li>Max - The longest elapsed time for the samples with the same label</li>
-<li>Std. Dev. - the standard deviation of the sample elapsed time</li>
+<li>Std. Dev. - the <a href="glossary.html#StandardDeviation">Standard Deviation</a> of the sample elapsed time</li>
<li>Error % - Percent of requests with errors</li>
-<li>Throughput - Throughput measured in requests per second/minute/hour</li>
+<li>Throughput - the <a href="glossary.html#Throughput">Throughput</a> is measured in requests per second/minute/hour.
+The time unit is chosen so that the displayed rate is at least 1.0.
+When the throughput is saved to a CSV file, it is expressed in requests/second,
+i.e. 30.0 requests/minute is saved as 0.5.
+</li>
<li>Kb/sec - The throughput measured in Kilobytes per second</li>
<li>Avg. Bytes - average size of the sample response in bytes. (in JMeter 2.2 it wrongly showed the value in kB)</li>
</ul>
-<p>Times are in milliseonds.</p>
+<p>Times are in milliseconds.</p>
</description>
<div align="center">
<p>
@@ -2415,7 +2431,7 @@
Entries in the jmeter log file also include time-stamps.
The example "806 in 91.6s = 8.8/s" means that there were 806 samples recorded in 91.6 seconds,
and that works out at 8.8 samples per second.
-The Avg (Average), Min(imum) and Max(imum) times are in milliseonds.
+The Avg (Average), Min(imum) and Max(imum) times are in milliseconds.
"Err" means number of errors (also shown as percentage).
The last two lines will appear at the end of a test.
They will not be synchronised to the appropriate time boundary.
Modified: jakarta/jmeter/trunk/xdocs/usermanual/glossary.xml
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/xdocs/usermanual/glossary.xml?rev=776364&r1=776363&r2=776364&view=diff
==============================================================================
--- jakarta/jmeter/trunk/xdocs/usermanual/glossary.xml (original)
+++ jakarta/jmeter/trunk/xdocs/usermanual/glossary.xml Tue May 19 15:50:20 2009
@@ -64,6 +64,12 @@
</p>
<p>
+<a name="StandardDeviation"><b>Standard Deviation</b></a> is a measure of the variability
+of a data set. This is a standard statistical measure.
+See, for example: <a href="http://en.wikipedia.org/wiki/Standard_deviation">Standard Deviation</a> entry at Wikipedia.
+</p>
+
+<p>
<a name="ThreadName">The <b>Thread Name</b></a> as it appears in Listeners and logfiles
is derived from the Thread Group name and the thread within the group.<br/>
The name has the format
@@ -86,7 +92,8 @@
<p>
<a name="Throughput"><b>Throughput</b></a> is calculated as requests/unit of time.
The time is calculated from the start of the first sample to the end of the last sample.
-This includes any intervals between samples.
+This includes any intervals between samples, as it is supposed to represent the load on the server.<br/>
+The formula is: Throughput = (number of requests) / (total time).
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org