You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by fs...@apache.org on 2016/09/08 18:23:05 UTC
svn commit: r1759880 - /jmeter/trunk/xdocs/usermanual/build-test-plan.xml
Author: fschumacher
Date: Thu Sep 8 18:23:05 2016
New Revision: 1759880
URL: http://svn.apache.org/viewvc?rev=1759880&view=rev
Log:
Markup changes.
Modified:
jmeter/trunk/xdocs/usermanual/build-test-plan.xml
Modified: jmeter/trunk/xdocs/usermanual/build-test-plan.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/build-test-plan.xml?rev=1759880&r1=1759879&r2=1759880&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/build-test-plan.xml (original)
+++ jmeter/trunk/xdocs/usermanual/build-test-plan.xml Thu Sep 8 18:23:05 2016
@@ -37,23 +37,23 @@ controllers, listeners, timers, assertio
<subsection name="§-num;.1 Adding and Removing Elements" anchor="add_remove">
<p>Adding <a href="test_plan.html">elements to a test plan</a> can be done by right-clicking on an element in the
-tree, and choosing a new element from the "add" list. Alternatively, elements can
-be loaded from file and added by choosing the "merge" or "open" option.</p>
+tree, and choosing a new element from the "<code>add</code>" list. Alternatively, elements can
+be loaded from file and added by choosing the "<code>merge</code>" or "<code>open</code>" option.</p>
<p>To remove an element, make sure the element is selected, right-click on the element,
-and choose the "remove" option.</p>
+and choose the "<code>remove</code>" option.</p>
</subsection>
<subsection name="§-num;.2 Loading and Saving Elements" anchor="load_save">
<p>To load an element from file, right click on the existing tree elements to which
-you want to add the loaded element, and select the "merge" option. Choose the file where
+you want to add the loaded element, and select the "<code>merge</code>" option. Choose the file where
your elements are saved. JMeter will merge the elements into the tree.</p>
-<p>To save tree elements, right click on an element and choose the "Save Selection As …" option.
+<p>To save tree elements, right click on an element and choose the "<code>Save Selection As …</code>" option.
JMeter will save the element selected, plus all child elements beneath it. In this way,
you can save test tree fragments and individual elements for later use.</p>
-<note>By default, the workbench is not automatically saved with the test plan, but it can be saved by checking "Save Workbench" option on Workbench element.</note>
+<note>By default, the workbench is not automatically saved with the test plan, but it can be saved by checking "<code>Save Workbench</code>" option on Workbench element.</note>
</subsection>
<subsection name="§-num;.3 Configuring Tree Elements" anchor="config_element">
@@ -66,24 +66,25 @@ configured for an element depends on wha
<subsection name="§-num;.4 Saving the Test Plan" anchor="saving">
<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 "Save" or "Save Test Plan As …" from the
+file before running it. To save the Test Plan, select "<code>Save</code>" or "<code>Save Test Plan As …</code>" from the
File menu (with the latest release, it is no longer necessary to select the
Test Plan element first).</p>
<note>JMeter allows you to save the entire Test Plan tree or
only a portion of it. To save only the elements located in a particular "branch"
of the Test Plan tree, select the Test Plan element in the tree from which to start
-the "branch", and then click your right mouse button to access the "Save Selection As …" menu item.
-Alternatively, select the appropriate Test Plan element and then select "Save Selection As …" from
+the "branch", and then click your right mouse button to access the "<code>Save Selection As …</code>" menu item.
+Alternatively, select the appropriate Test Plan element and then select "<code>Save Selection As …</code>" from
the Edit menu.
</note>
</subsection>
<subsection name="§-num;.5 Running a Test Plan" anchor="run">
-<p>To run your test plan, choose "Start" (Control + r) from the "Run" menu item.
+<p>To run your test plan, choose "<code>Start</code>" (<keycombo><keysym>Control</keysym><keysym>r</keysym></keycombo>)
+from the "<code>Run</code>" menu item.
When JMeter is running, it shows a small green box at the right hand end of the section just under the menu bar.
-You can also check the "Run" menu.
-If "Start" is disabled, and "Stop" is enabled,
+You can also check the "<code>Run</code>" menu.
+If "<code>Start</code>" is disabled, and "<code>Stop</code>" is enabled,
then JMeter is running your test plan (or, at least, it thinks it is).</p>
<p>
The numbers to the left of the green box are the number of active threads / total number of threads.
@@ -96,33 +97,34 @@ These only apply to a locally run test;
<p>
There are two types of stop command available from the menu:
<ul>
-<li>Stop (Control + '.') - stops the threads immediately if possible.
+<li><code>Stop</code> (<keycombo><keysym>Control</keysym><keysym>.</keysym></keycombo>) - stops the threads immediately if possible.
Many samplers are Interruptible which means that active samples can be terminated early.
The stop command will check that all threads have stopped within the default timeout, which is 5000 ms = 5 seconds.
[This can be changed using the JMeter property <code>jmeterengine.threadstop.wait</code>]
If the threads have not stopped, then a message is displayed.
The Stop command can be retried, but if it fails, then it is necessary to exit JMeter to clean up.
</li>
-<li>Shutdown (Control + ',')- requests the threads to stop at the end of any current work.
+<li><code>Shutdown</code> (<keycombo><keysym>Control</keysym><keysym>,</keysym></keycombo>) - requests the
+threads to stop at the end of any current work.
Will not interrupt any active samples.
The modal shutdown dialog box will remain active until all threads have stopped.</li>
</ul>
-If Shutdown is taking too long. Close the Shutdown dialog box and select Run/Stop, or just press Control + '.'.
+If Shutdown is taking too long. Close the Shutdown dialog box and select <code>Run</code>/<code>Stop</code>, or just press <keycombo><keysym>Control</keysym><keysym>.</keysym></keycombo>.
</p>
<p>
-When running JMeter in non-GUI mode, there is no Menu, and JMeter does not react to keystrokes such as Control + '.'.
-So JMeter non-GUI mode will listen for commands on a specific port (default 4445, see the JMeter property <code>jmeterengine.nongui.port</code>).
+When running JMeter in non-GUI mode, there is no Menu, and JMeter does not react to keystrokes such as <keycombo><keysym>Control</keysym><keysym>.</keysym></keycombo>.
+So JMeter non-GUI mode will listen for commands on a specific port (default <code>4445</code>, see the JMeter property <code>jmeterengine.nongui.port</code>).
JMeter supports automatic choice of an alternate port if the default port is being used
(for example by another JMeter instance). In this case, JMeter will try the next higher port, continuing until
-it reaches the JMeter property <code>jmeterengine.nongui.maxport</code>) which defaults to 4455.
+it reaches the JMeter property <code>jmeterengine.nongui.maxport</code>) which defaults to <code>4455</code>.
If <code>maxport</code> is less than or equal to <code>port</code>, port scanning will not take place.
<br></br>
The chosen port is displayed in the console window.
<br/>
The commands currently supported are:
<ul>
-<li>Shutdown - graceful shutdown</li>
-<li>StopTestNow - immediate shutdown</li>
+<li><code>Shutdown</code> - graceful shutdown</li>
+<li><code>StopTestNow</code> - immediate shutdown</li>
</ul>
These commands can be sent by using the <code>shutdown[.cmd|.sh]</code> or <code>stoptest[.cmd|.sh]</code> script
respectively. The scripts are to be found in the JMeter <code>bin</code> directory.
@@ -132,8 +134,8 @@ The commands will only be accepted if th
<subsection name="§-num;.7 Error reporting" anchor="error_reporting">
<p>
-JMeter reports warnings and errors to the jmeter.log file, as well as some information on the test run itself.
-JMeter shows the number of warnings/errors found in jmeter.log file next to the warning icon (triangle) at the right hand end of its window.
+JMeter reports warnings and errors to the <code>jmeter.log</code> file, as well as some information on the test run itself.
+JMeter shows the number of warnings/errors found in <code>jmeter.log</code> file next to the warning icon (triangle) at the right hand end of its window.
Click on the warning icon to show the jmeter.log file at the bottom of JMeter's window.
Just occasionally there may be some errors that JMeter is unable to trap and log; these will appear on the command console.
If a test is not behaving as you expect, please check the log file in case any errors have been reported (e.g. perhaps a syntax error in a function call).