mstover1 02/03/02 11:32:12
Modified: xdocs/usermanual build-web-test-plan.xml
component_reference.xml intro.xml test_plan.xml
Removed: xdocs/usermanual assertion.xml ftp-config.xml
http-config.xml jdbc-config.xml listener.xml
timer.xml
Log:
Updating documentation
Revision Changes Path
1.6 +68 -69 jakarta-jmeter/xdocs/usermanual/build-web-test-plan.xml
Index: build-web-test-plan.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/build-web-test-plan.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- build-web-test-plan.xml 19 Nov 2001 17:41:24 -0000 1.5
+++ build-web-test-plan.xml 2 Mar 2002 19:32:12 -0000 1.6
@@ -8,78 +8,78 @@
<body>
<section name="5. Building a Web Test Plan" anchor="building">
-<p>In this section, you will learn how to create a basic
-<a href="build-test-plan.html">Test Plan</a> to test a Web site. You will
-create five users that send requests to two pages on the Jakarta Web site.
-Also, you will tell the users to run their tests twice. So, the total number of
-requests is (5 users) x (2 requests) x (repeat 2 times) = 20 HTTP requests. To
-construct the Test Plan, you will use the following elements:
-<a href="thread-group.html">Thread Group</a>,
-<a href="gen-controller.html#http_request">HTTP Request</a>,
-<a href="http-config.html#request_defaults">HTTP Request Defaults</a>, and
-<a href="listener.html#file_reporter">File Reporter</a>.</p>
+<p>In this section, you will learn how to create a basic
+<a href="build-test-plan.html">Test Plan</a> to test a Web site. You will
+create five users that send requests to two pages on the Jakarta Web site.
+Also, you will tell the users to run their tests twice. So, the total number of
+requests is (5 users) x (2 requests) x (repeat 2 times) = 20 HTTP requests. To
+construct the Test Plan, you will use the following elements:
+<a href="test_plan.html#thread_group">Thread Group</a>,
+<complink name="HTTP Request"/>,
+<complink name="HTTP Request Defaults"/>, and
+<complink name="File Reporter"/>.</p>
-<p>For a more advanced Test Plan, see
+<p>For a more advanced Test Plan, see
<a href="build-adv-web-test-plan.html">Building an Advanced Web Test Plan</a>.</p>
</section>
<!--
<p>After starting JMeter, you see three items in the tree: Root (the parent of
-all tree elements), Test Plan (you place all of your elements here), and
+all tree elements), Test Plan (you place all of your elements here), and
WorkBench (a temporary place to store your elements while constructing a Test
Plan).</p>-->
<section name="5.1 Adding Users" anchor="adding_users">
-<p>The first step you want to do with every JMeter Test Plan is to add a
-<a href="thread-group.html">Thread Group</a> element. The Thread Group tells
-JMeter the number of users you want to simulate, how often the users should send
+<p>The first step you want to do with every JMeter Test Plan is to add a
+<a href="test_plan.html#thread_group">Thread Group</a> element. The Thread Group
tells
+JMeter the number of users you want to simulate, how often the users should send
requests, and the how many requests they should send.</p>
-<p>Go ahead and add the ThreadGroup element by first selecting the Test Plan,
+<p>Go ahead and add the ThreadGroup element by first selecting the Test Plan,
and then from the Edit menu, select Add --> ThreadGroup.</p>
<p>
<table border="1" cellspacing="0" cellpadding="5">
- <tr><td><b>TIP:</b> You can also access the Edit menu by selecting an element
+ <tr><td><b>TIP:</b> You can also access the Edit menu by selecting an element
and then clicking your right mouse button.</td></tr>
</table>
</p>
-<p>You should now see the Thread Group element under Test Plan. If you do not
-see the element, then "expand" the Test Plan tree by double-clicking on the
-Test Plan element.</p>
-
-<p>Next, you need to modify the default properties. Select the Thread Group
element
-in the tree, if you have not already selected it. You should now see the Thread
-Group Control Panel in the right section of the JMeter window (see Figure 5.1
+<p>You should now see the Thread Group element under Test Plan. If you do not
+see the element, then "expand" the Test Plan tree by double-clicking on the
+Test Plan element.</p>
+
+<p>Next, you need to modify the default properties. Select the Thread Group element
+in the tree, if you have not already selected it. You should now see the Thread
+Group Control Panel in the right section of the JMeter window (see Figure 5.1
below)</p>
<p><img src="../images/screenshots/webtest/threadgroup.gif" width="555"
height="297"></img>
-<br>Figure 5.1. Thread Group with Default Values</br></p>
+<br>Figure 5.1. Thread Group with Default Values</br></p>
-<p>Start by providing a more descriptive name for our Thread Group. In the name
-field, enter Jakarta Users.</p>
+<p>Start by providing a more descriptive name for our Thread Group. In the name
+field, enter Jakarta Users.</p>
-<p>Next, increase the number of users (called threads) to 5.</p>
+<p>Next, increase the number of users (called threads) to 5.</p>
-<p>In the next field, the Ramp-Up Period, leave the the default value of 0
-seconds. This property tells JMeter how long to delay between starting each
-user. For example, if you enter a Ramp-Up Period of 5 seconds, JMeter will
-finish starting all of your users by the end of the 5 seconds. So, if we have
-5 users and a 5 second Ramp-Up Period, then the delay between starting users
-would be 1 second (5 users / 5 seconds = 1 user per second). If you set the
+<p>In the next field, the Ramp-Up Period, leave the the default value of 0
+seconds. This property tells JMeter how long to delay between starting each
+user. For example, if you enter a Ramp-Up Period of 5 seconds, JMeter will
+finish starting all of your users by the end of the 5 seconds. So, if we have
+5 users and a 5 second Ramp-Up Period, then the delay between starting users
+would be 1 second (5 users / 5 seconds = 1 user per second). If you set the
value to 0, then JMeter will immediately start all of your users.</p>
-<p>Finally, clear the checkbox labeled "Forever", and enter a value of 2 in
-the Loop Count field. This property tells JMeter how many times to repeat your
-test. If you enter a loop count value of 0, then JMeter will run your test only
-once. To have JMeter repeatedly run your Test Plan, select the Forever
-checkbox.</p>
+<p>Finally, clear the checkbox labeled "Forever", and enter a value of 2 in
+the Loop Count field. This property tells JMeter how many times to repeat your
+test. If you enter a loop count value of 0, then JMeter will run your test only
+once. To have JMeter repeatedly run your Test Plan, select the Forever
+checkbox.</p>
<p>
<table border="1" cellspacing="0" cellpadding="5">
- <tr><td><b>NOTE:</b> In most applications, you have to manually accept
-changes you make in a Control Panel. However, in JMeter, the Control Panel
+ <tr><td><b>NOTE:</b> In most applications, you have to manually accept
+changes you make in a Control Panel. However, in JMeter, the Control Panel
automatically accepts your changes as you make them. If you change the
name of an element, the tree will be updated with the new text after you
leave the Control Panel (for example, when selecting another tree
element).</td></tr>
@@ -89,7 +89,7 @@
<p>See Figure 5.2 for the completed Jakarta Users Thread Group.</p>
<p><img src="../images/screenshots/webtest/threadgroup2.gif" width="555"
height="297"></img>
-<br>Figure 5.2. Jakarta Users Thread Group</br></p>
+<br>Figure 5.2. Jakarta Users Thread Group</br></p>
</section>
@@ -99,17 +99,16 @@
for your HTTP requests. And then, in section 5.3, you will add HTTP Request
elements which use some of the default settings you specified here.</p>
-<p>Begin by selecting the Jakarta Users element. From the Edit menu, choose
+<p>Begin by selecting the Jakarta Users element. From the Edit menu, choose
Add --> Config Element --> HTTP Request Defaults. Then, select this new
element to view its Control Panel (see Figure 5.3).</p>
<p><img src="../images/screenshots/webtest/http-defaults1.gif" width="633"
height="326"></img>
-<br>Figure 5.3. HTTP Request Defaults</br></p>
+<br>Figure 5.3. HTTP Request Defaults</br></p>
<p>
-Like most JMeter elements, the
-<a href="http-config.html#request_defaults">HTTP Request Defaults</a> Control
-Panel has a name field that you can modify. In this example, leave this field with
+Like most JMeter elements, the <complink name="HTTP Request Defaults"/> Control
+Panel has a name field that you can modify. In this example, leave this field with
the default value.</p>
<p>Skip to the next field, which is the Web Server's Server Name/IP. For the
@@ -128,15 +127,15 @@
<p>See Figure 5.4 for the completed HTTP Request Defaults element</p>
<p><img src="../images/screenshots/webtest/http-defaults2.gif" width="633"
height="326"></img>
-<br>Figure 5.4. HTTP Defaults for our Test Plan</br></p>
+<br>Figure 5.4. HTTP Defaults for our Test Plan</br></p>
</section>
<section name="5.3 Adding HTTP Requests" anchor="adding_requests">
-<p>In our Test Plan, we need to make two HTTP requests. The first one is for the
-Jakarta home page (http://jakarta.apache.org/), and the second one is for the
+<p>In our Test Plan, we need to make two HTTP requests. The first one is for the
+Jakarta home page (http://jakarta.apache.org/), and the second one is for the
Project Guidelines page (http://jakarta.apache.org/site/guidelines.html).</p>
<p>
@@ -146,9 +145,9 @@
</table>
</p>
-<p>Start by adding the first <a href="gen-controller.html#4.2.1.2">HTTP Request</a>
-to the Jakarta Users element (Add --> Generative Controller --> HTTP
Request).
-Then, select the HTTP Request element in the tree and edit the following properties
+<p>Start by adding the first <complink name="HTTP Request"/>
+to the Jakarta Users element (Add --> Generative Controller --> HTTP Request).
+Then, select the HTTP Request element in the tree and edit the following properties
(see Figure 5.5):
<ol>
<li>Change the Name field to "Home Page".</li>
@@ -159,9 +158,9 @@
</p>
<p><img src="../images/screenshots/webtest/http-request1.gif" width="633"
height="326"></img>
-<br>Figure 5.5. HTTP Request for Jakarta Home Page</br></p>
+<br>Figure 5.5. HTTP Request for Jakarta Home Page</br></p>
-<p>Next, add the second HTTP Request and edit the following properties (see
+<p>Next, add the second HTTP Request and edit the following properties (see
Figure 5.56:
<ol>
<li>Change the Name field to "Project Guidelines".</li>
@@ -170,44 +169,44 @@
</p>
<p><img src="../images/screenshots/webtest/http-request2.gif" width="633"
height="326"></img>
-<br>Figure 5.6. HTTP Request for Jakarta Project Guidelines Page</br></p>
+<br>Figure 5.6. HTTP Request for Jakarta Project Guidelines Page</br></p>
</section>
<section name="5.4 Adding a File Reporter to Store the Test Results"
anchor="adding_file_reporter">
-<p>The final element you need to add to your Test Plan is a
-<a href="listener.html#file_reporter">File Reporter Listener</a>. This element is
+<p>The final element you need to add to your Test Plan is a
+<complink name="File Reporter"/> Listener. This element is
responsible for storing all of the results of your HTTP requests in a file.</p>
-<p>Select the Jakarta Users element and add a File Reporter (Add --> Listener
+<p>Select the Jakarta Users element and add a File Reporter (Add --> Listener
--> File Reporter). Next, you need to specify a directory and filename of the
output file. You can either type it into the filename field, or select the
Browse button and browse to a directory and then enter a filename. Leave
all of the other fields with their default values (see Figure 5.7).</p>
<p><img src="../images/screenshots/webtest/file-reporter.gif" width="633"
height="340"></img>
-<br>Figure 5.7. File Reporter Listener</br></p>
+<br>Figure 5.7. File Reporter Listener</br></p>
</section>
<section name="5.5 Saving the Test Plan" anchor="saving">
-<p>Although it is not required, we recommend that you save the Test Plan to a
+<p>Although it is not required, we recommend that you save the Test Plan to a
file before running it. To save the Test Plan, select the Test Plan element
in the tree. Then, select Save As from the File menu.</p>
<p>
<table border="1" cellspacing="0" cellpadding="5">
- <tr><td><b>NOTE:</b> JMeter allows you to save the entire Test Plan tree or
+ <tr><td><b>NOTE:</b> JMeter allows you to save the entire Test Plan tree or
only a portion of it. JMeter uses the currently selected tree element
-and saves all elements located in that particular "branch" of the tree.
-Because you want to save all of the elements, you must select the Test Plan
+and saves all elements located in that particular "branch" of the tree.
+Because you want to save all of the elements, you must select the Test Plan
element before selecting File --> Save As.</td></tr>
</table>
</p>
<p>
<table border="1" cellspacing="0" cellpadding="5">
- <tr><td><b>TIP:</b> You can also access the Save As menu item by selecting an
+ <tr><td><b>TIP:</b> You can also access the Save As menu item by selecting an
element and then clicking your right mouse button.</td></tr>
</table>
</p>
@@ -215,8 +214,8 @@
</section>
<section name="5.6 Running the Test Plan" anchor="running">
-<p>Before running the Test Plan, You have to manually open the File Reporter
-output file. Select the File Reporter tree element, and select the Open button,
+<p>Before running the Test Plan, You have to manually open the File Reporter
+output file. Select the File Reporter tree element, and select the Open button,
which is located at the bottom of the Control Panel.</p>
<p>From the Run menu, select Run.</p>
@@ -229,7 +228,7 @@
</table>
</p>
-<p>Once JMeter has finished running your Test Plan, select Stop from the
+<p>Once JMeter has finished running your Test Plan, select Stop from the
Run menu.</p>
<p>Next, you need to close the File Reporter output file. Select
the File Reporter tree element, and select the Close button on the
@@ -238,7 +237,7 @@
editor (see Figure 5.8). The format is [URL][space][Response time in
milliseconds].</p>
<p><img src="../images/screenshots/webtest/file-reporter-results.gif" width="432"
height="396"></img>
-<br>Figure 5.8. Test Plan Results</br></p>
+<br>Figure 5.8. Test Plan Results</br></p>
</section>
1.7 +21 -21 jakarta-jmeter/xdocs/usermanual/component_reference.xml
Index: component_reference.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/component_reference.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- component_reference.xml 1 Mar 2002 00:09:06 -0000 1.6
+++ component_reference.xml 2 Mar 2002 19:32:12 -0000 1.7
@@ -42,19 +42,19 @@
also lets you control whether or not JMeter parses HTML files for images and
Java applets and sends HTTP requests to retrieve them.</p>
<p>If you are going to send multiple requests to the same web server, consider
- using an <a href="http-config.html#request_defaults">HTTP Request Defaults</a>
+ using an <complink name="HTTP Request Defaults"/>
Configuration Element so you do not have to enter the same information for each
HTTP Request controller.</p>
<p>Or, instead of manually adding HTTP Request controllers, you may want to use
- JMeter's <a href="http-config.html#proxy_server">HTTP Proxy Server</a> to
create
+ JMeter's <complink name="HTTP Proxy Server"/> to create
them. This can save you time if you have a lot of HTTP requests or requests
with many
parameters.</p>
<p>If the request requires a login authorization, you will also have to add an
- <a href="http-config.html#auth_manager">HTTP Authorization Manager</a>
+ <complink name="HTTP Authorization Manager"/>
Configuration Element. And, if the request uses cookies, then you will also
need an
- <a href="http-config.html#cookie_manager">HTTP Cookie Manager</a>. You can
+ <complink name="HTTP Cookie Manager"/>. You can
add either of these elements to the Thread Group or the HTTP Request. If you
have
more than one HTTP Request that needs authorizations or cookies, then add the
elements to the Thread Group. That way, all HTTP Request controllers will
share the
@@ -92,15 +92,15 @@
</properties>
<links>
- <link href="assertion.html">Assertion</link>
+ <link href="test_plan.html#assertions">Assertion</link>
<link href="build-web-test-plan.html">Building a Web Test Plan</link>
<link href="build-adv-web-test-plan.html">Building an Advanced Web Test
Plan</link>
- <link href="http-config.html#auth_manager">HTTP Authorization Manager</link>
- <link href="http-config.html#cookie_manager">HTTP Cookie Manager</link>
- <link href="http-config.html#header_manager">HTTP Header Manager</link>
- <link href="http-config.html#html_link_parser">HTTP HTML Link Parser</link>
- <link href="http-config.html#proxy_server">HTTP Proxy Server</link>
- <link href="http-config.html#request_defaults">HTTP Request Defaults</link>
+ <complink name="HTTP Authorization Manager"/>
+ <complink name="HTTP Cookie Manager"/>
+ <complink name="HTTP Header Manager"/>
+ <complink name="HTML Link Parser"/>
+ <complink name="HTTP Proxy Server"/>
+ <complink name="HTTP Request Defaults"/>
<link href="build-adv-web-test-plan.html#url_rewriting">HTTP Requests and
Session ID's: URL Rewriting</link>
</links>
@@ -111,9 +111,9 @@
<description><p>This controller lets you send an JDBC Request (an SQL query) to a
database.</p>
<p>If you are going to send multiple requests to the same database, consider
using one or more of the Defaults Configuration Elements:
-<a href="jdbc-config.html#login">Login</a>,
-<a href="jdbc-config.html#conn_pool">Connection Pool</a>,
-<a href="jdbc-config.html#sql_query">SQL Query</a>.
+<complink name="JDBC Database Login Defaults"/>,
+<complink name="JDBC Database Connection Pool Defaults"/>,
+<complink name="JDBC SQL Query Defaults"/>.
This way, you do not have to enter the same information for each JDBC Request
controller.</p></description>
@@ -137,11 +137,11 @@
</properties>
<links>
- <link href="assertion.html">Assertion</link>
+ <link href="test_plan.html#assertions">Assertion</link>
<link href="build-db-test-plan.html">Building a Database Test Plan</link>
- <link href="jdbc-config.html#login">JDBC Database Login Defaults</link>
- <link href="jdbc-config.html#conn_pool">JDBC Database Connection Pool
Defaults</link>
- <link href="jdbc-config.html#sql_query">JDBC SQL Query Defaults</link>
+ <complink name="JDBC Database Login Defaults"/>
+ <complink name="JDBC Database Connection Pool Defaults"/>
+ <complink name="JDBC SQL Query Defaults"/>
</links>
</component>
@@ -266,7 +266,7 @@
</description>
<links>
- <link href="#html_link_parser">HTML Link Parser</link>
+ <complink name="HTML Link Parser"/>
</links>
</component>
@@ -698,9 +698,9 @@
<properties>
<property name="Name" required="No">Descriptive name for this timer that is
shown in the tree. </property>
- <property name="Random Delay Maximum" required="No">Maxium random number of
milliseconds to
+ <property name="Random Delay Maximum" required="Yes">Maxium random number of
milliseconds to
pause.</property>
- <property name="Constant Delay Offset" required="No">Numer of milliseconds to
pause in addition
+ <property name="Constant Delay Offset" required="Yes">Numer of milliseconds to
pause in addition
to the random delay.</property>
</properties>
1.7 +1 -1 jakarta-jmeter/xdocs/usermanual/intro.xml
Index: intro.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/intro.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- intro.xml 24 Feb 2002 18:40:30 -0000 1.6
+++ intro.xml 2 Mar 2002 19:32:12 -0000 1.7
@@ -19,7 +19,7 @@
overall performance under different load types.</p>
<p>
Additionally, JMeter can help you regression test your application by letting you
create
-test scripts with <a href="assertion.html">assertions</a> to validate that your
application is returning the
+test scripts with <a href="test_plan.html#assertions">assertions</a> to validate
that your application is returning the
results you expect. For maximum flexibility, JMeter lets you create these
assertions using
regular expressions.</p>
1.3 +12 -12 jakarta-jmeter/xdocs/usermanual/test_plan.xml
Index: test_plan.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/test_plan.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- test_plan.xml 28 Feb 2002 22:51:42 -0000 1.2
+++ test_plan.xml 2 Mar 2002 19:32:12 -0000 1.3
@@ -70,7 +70,7 @@
results of your requests to disk.</p>
<p>If you are interested in having JMeter perform basic validation on
-the response of your request, add an <a href="assertion.html">Assertion</a> to
+the response of your request, add an <a href="#assertions">Assertion</a> to
the Request controller. For example, in stress testing a web application, the
server
may return a successful "HTTP Response" code, but the page may have errors on it or
may be missing sections. You could add assertions to check for certain HTML tags,
@@ -100,7 +100,7 @@
<ul>
<li>Once Only Controller</li>
<ul>
- <li>Login Request (an <a
href="component_reference.html#http_request">HTTP Generative Controller</a>)</li>
+ <li>Login Request (an <complink name="HTTP Request"/>)</li>
</ul>
<li>Load Search Page (HTTP Generative Controller)</li>
<li>Interleave Controller</li>
@@ -118,7 +118,7 @@
<p>The first thing about this test is that the login request will be executed only
the first time through. Subsequent iterations will skip it. This is due to the
-effects of the <a href="component_referenct.html#once_only_controller">Once Only
Controller</a>.</p>
+effects of the <complink name="Once Only Controller"/>.</p>
<p>After the login, the next Generative Controller loads the search page (imagine a
web application where the user logs in, and then goes to a search page to do a
search). This
@@ -127,13 +127,13 @@
<p>After loading the search page, we want to do a search. Actually, we want to do
two different searches. However, we want to re-load the search page itself between
each search. We could do this by having 4 simple HTTP request elements (load
search,
-search "A", load search, search "B"). Instead, we use the <a
href="component_reference.html#interleave_controller">Interleave
-Controller</a> which passes on one child request each time through the test. It
keeps the
+search "A", load search, search "B"). Instead, we use the <complink
name="Interleave
+Controller"/> which passes on one child request each time through the test. It
keeps the
ordering (ie - it doesn't pass one on at random, but "remembers" its place) of its
child elements. Interleaving 2 child requests may be overkill, but there could
easily have
been 8, or 20 child requests.</p>
-<p>Note the <a href="component_reference.html#http_default_request">HTTP default
request</a> that
+<p>Note the <complink name="HTTP Request Defaults"/> that
belongs to the Interleave Controller. Imagine that "Search A" and "Search B" share
the same PATH info (an HTTP request specification includes domain, port, method,
protocol,
path, and arguments, plus other optional items). This makes sense - both are
search requests,
@@ -154,8 +154,8 @@
test your application on a different server simply by changing one field in your
Test Plan.
Otherwise, you'd have to edit each and every Generative Controller.</p>
-<p>The last element is a <a href="component_reference.html#cookie_manager">Cookie
-Manager</a>. A Cookie Manager should be added to all web tests - otherwise JMeter
will
+<p>The last element is a <complink name="HTTP Cookie
+Manager"/>. A Cookie Manager should be added to all web tests - otherwise JMeter
will
ignore cookies. By adding it at the Thread Group level, we ensure that all HTTP
requests
will share the same cookies.</p>
@@ -165,12 +165,12 @@
<subsection name="4.3 Listeners" anchor="listeners">
<p>Listeners provide access to the information JMeter gathers about the test cases
while
-JMeter runs. The simplest listener, the <a
href="component_reference.html#graph_results">Graph
-Results</a> listener plots the response times on a graph. Listeners usually
provide a
+JMeter runs. The simplest listener, the <complink name="Graph
+Results"/> listener plots the response times on a graph. Listeners usually provide
a
graphical view of the data that JMeter generates.</p>
-<p>An exception to this is the <a href="component_reference.html#file_reporter">File
-Reporter</a>, which, as you might expect, logs the result data to a file. </p>
+<p>An exception to this is the <complink name="File
+Reporter"/>, which, as you might expect, logs the result data to a file. </p>
<p>Listeners can only be added to a Thread Group, and they only collect information
specific to that Thread Group. If you have 3 Thread Groups and a listener attached
to
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
