You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by mi...@apache.org on 2017/09/17 18:22:18 UTC
svn commit: r1808646 [22/22] - in /jmeter/trunk: docs/ docs/css/
docs/images/screenshots/ docs/images/screenshots/changes/3.3/
docs/images/screenshots/jdbc-config/ docs/localising/ docs/usermanual/
src/core/org/apache/jmeter/util/ xdocs/
Modified: jmeter/trunk/docs/usermanual/remote-test.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/remote-test.html?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/remote-test.html (original)
+++ jmeter/trunk/docs/usermanual/remote-test.html Sun Sep 17 18:22:16 2017
@@ -1,11 +1,199 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
-<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-15"><title>Apache JMeter
+<html lang="en">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
+<title>Apache JMeter
-
- User's Manual: Remote (Distributed) Testing</title><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"><link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png"><link rel="icon" href="../images/favicon.png"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="../images/mstile-144x144.png"><meta name="theme-color" content="#ffffff"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!--
+ User's Manual: Remote (Distributed) Testing</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css">
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css">
+<link rel="stylesheet" type="text/css" href="../css/new-style.css">
+<link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png">
+<link rel="icon" href="../images/favicon.png">
+<meta name="msapplication-TileColor" content="#ffffff">
+<meta name="msapplication-TileImage" content="../images/mstile-144x144.png">
+<meta name="theme-color" content="#ffffff">
+</head>
+<body role="document">
+<a href="#content" class="hidden">Main content</a>
+<div class="header">
+<!--
APACHE LOGO
- --><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
+ -->
+<div>
+<a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a>
+</div>
+<!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li>
<li><a href="../usermanual/best-practices.html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log
Sampler</a></li><li><a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><
/ul></li></ul></div><div class="main" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="listeners.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="generating-dashboard.html">Next ></a></li></ul><div class="section"><h1>14. Remote Testing</h1>
+ -->
+<div>
+<a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a>
+</div>
+<div class="banner">
+<a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a>
+<div class="clear"></div>
+</div>
+</div>
+<div class="nav">
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">About</div>
+<ul>
+<li>
+<a href="../index.html">Overview</a>
+</li>
+<li>
+<a href="http://www.apache.org/licenses/">License</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Download</div>
+<ul>
+<li>
+<a href="../download_jmeter.cgi">Download Releases</a>
+</li>
+<li>
+<a href="../changes.html">Release Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Documentation</div>
+<ul>
+<li>
+<a href="../usermanual/get-started.html">Get Started</a>
+</li>
+<li>
+<a href="../usermanual/index.html">User Manual</a>
+</li>
+<li>
+<a href="../usermanual/best-practices.html">Best Practices</a>
+</li>
+<li>
+<a href="../usermanual/component_reference.html">Component Reference</a>
+</li>
+<li>
+<a href="../usermanual/functions.html">Functions Reference</a>
+</li>
+<li>
+<a href="../usermanual/properties_reference.html">Properties Reference</a>
+</li>
+<li>
+<a href="../changes_history.html">Change History</a>
+</li>
+<li>
+<a href="../api/index.html">Javadocs</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter">JMeter Wiki</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Tutorials</div>
+<ul>
+<li>
+<a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a>
+</li>
+<li>
+<a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Community</div>
+<ul>
+<li>
+<a href="../issues.html">Issue Tracking</a>
+</li>
+<li>
+<a href="http://www.apache.org/security/">Security</a>
+</li>
+<li>
+<a href="../mail.html">Mailing Lists</a>
+</li>
+<li>
+<a href="../svnindex.html">Source Repositories</a>
+</li>
+<li>
+<a href="../building.html">Building and Contributing</a>
+</li>
+<li>
+<a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Foundation</div>
+<ul>
+<li>
+<a href="http://www.apache.org/">The Apache Software Foundation (ASF)</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="main" id="content">
+<div class="social-media">
+<ul class="social-media-links">
+<li class="twitter">
+<a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a>
+</li>
+<li class="github">
+<a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a>
+</li>
+</ul>
+</div>
+<ul class="pagelinks">
+<li>
+<a href="listeners.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="generating-dashboard.html">Next ></a>
+</li>
+</ul>
+<div class="section">
+<h1>13. Remote Testing</h1>
+
<p>In the event that your JMeter client machine is unable, performance-wise, to simulate
enough users to stress your server or is limited at network level, an option exists to control multiple, remote JMeter
@@ -15,21 +203,31 @@ instance of the JMeter client can contro
all the data from them. This offers the following features:
<ul>
+
<li>Saving of test samples to the local machine </li>
+
<li>Management of multiple JMeterEngines from a single machine </li>
+
<li>No need to copy the test plan to each server - the client sends it to all the servers</li>
+
</ul>
+
</p>
-<div class="clear"></div><div class="note">
+
+<div class="clear"></div>
+<div class="note">
Note: The same test plan is run by all the servers.
JMeter does not distribute the load between servers, each runs the full test plan.
So if you set 1000 Threads and have 6 JMeter server, you end up injecting 6000 Threads.
-</div><div class="clear"></div>
+</div>
+<div class="clear"></div>
+
<p>
However, remote mode does use more resources than running the same number of non-GUI tests independently.
If many server instances are used, the client JMeter can become overloaded, as can the client network connection.
This has been improved by switching to Stripped modes (see below) but you should always check that your client is not overloaded.
</p>
+
<p>Note that while you can execute the JMeterEngine on your application
server, you need to be mindful of the fact that this will be adding processing
overhead on the application server and thus your testing results will be
@@ -40,14 +238,23 @@ results without impacting the performanc
itself.
</p>
-<p><b>Step 0: Configure the nodes</b></p>
+
+<p>
+<b>Step 0: Configure the nodes</b>
+</p>
+
<p>
Make sure that all the nodes (client and servers) :
<ul>
- <li>are running exactly the same version of JMeter.</li>
- <li>are using the same version of Java on all systems. Using different versions of Java may work but is discouraged.</li>
+
+<li>are running exactly the same version of JMeter.</li>
+
+<li>are using the same version of Java on all systems. Using different versions of Java may work but is discouraged.</li>
+
</ul>
+
</p>
+
<p>
If the test uses any data files, <b>note that these are not sent across by the client so
make sure that these are available in the appropriate directory on each server</b>.
@@ -58,89 +265,159 @@ Alternatively use different content in a
(e.g. if each server must use unique ids, divide these between the data files)
</p>
-<p><b>Step 1: Start the servers </b></p>
+
+<p>
+<b>Step 1: Start the servers </b>
+</p>
+
<p>To run JMeter in remote node, start the JMeter server component on all machines you wish to run on by running
the <span class="code">JMETER_HOME/bin/jmeter-server</span> (unix) or <span class="code">JMETER_HOME/bin/jmeter-server.bat</span> (windows) script.</p>
+
<p>Note that there can only be one JMeter server on each node unless different RMI ports are used.</p>
+
<p>Since JMeter 2.3.1, the JMeter server application starts the RMI registry itself;
there is no need to start RMI registry separately.
To revert to the previous behaviour, define the JMeter property <pre class="source">server.rmi.create=false</pre> on the server host systems.
</p>
+
<p>
By default, RMI uses a dynamic port for the JMeter server engine. This can cause problems for firewalls,
so with you can define the JMeter property <span class="code">server.rmi.localport</span>
to control this port number.
If this is non-zero, it will be used as the local port number for the server engine.
</p>
-<p><b>Step 2: Add the server IP to your client's Properties File</b></p>
+
+<p>
+<b>Step 2: Add the server IP to your client's Properties File</b>
+</p>
+
<p>Edit the properties file <i>on the controlling JMeter machine</i>. In <span class="code">JMETER_HOME/bin/jmeter.properties</span>,
find the property named, "<span class="code">remote_hosts</span>", and
add the value of your running JMeter server's IP address. Multiple such servers can be added, comma-delimited.</p>
+
<p>Note that you can use the <span class="code">-R</span> <a href="get-started.html#override">command line option</a>
instead to specify the remote host(s) to use. This has the same effect as using <span class="code">-r</span> and <span class="code">-Jremote_hosts={serverlist}</span>.
- E.g. </p><pre class="source">jmeter -Rhost1,127.0.0.1,host2</pre>
+ E.g. </p>
+<pre class="source">jmeter -Rhost1,127.0.0.1,host2</pre>
+
<p>If you define the JMeter property <span class="code">server.exitaftertest=true</span>, then the server will exit after it runs a single test.
See also the <span class="code">-X</span> flag (described below)
</p>
-<p><b>Step 3a: Start the JMeter Client from a GUI client to check configuration</b></p>
+
+<p>
+<b>Step 3a: Start the JMeter Client from a GUI client to check configuration</b>
+</p>
+
<p>Now you are ready to start the controlling JMeter client. For MS-Windows, start the client with the script "<span class="code">bin/jmeter.bat</span>". For UNIX,
use the script "<span class="code">bin/jmeter</span>". You will notice that the Run menu contains two new sub-menus: "Remote Start" and "Remote Stop"
(see figure 1). These menus contain the client that you set in the properties file. Use the remote start and stop instead of the
normal JMeter start and stop menu items.</p>
-<figure><a href="../images/screenshots/remote/run-menu00.png"><img src="../images/screenshots/remote/run-menu00.png" width="487" height="295" alt="Figure 1 - Run Menu"></a><figcaption>Figure 1 - Run Menu</figcaption></figure>
-<p><b>Step 3b: Start the JMeter from a non-GUI Client</b></p>
+<figure>
+<a href="../images/screenshots/remote/run-menu00.png"><img src="../images/screenshots/remote/run-menu00.png" width="487" height="295" alt="Figure 1 - Run Menu"></a>
+<figcaption>Figure 1 - Run Menu</figcaption>
+</figure>
+
+
+<p>
+<b>Step 3b: Start the JMeter from a non-GUI Client</b>
+</p>
+
<p>
GUI mode should only be used for debugging, as a better alternative, you should start the test on remote server(s) from a non-GUI (command-line) client.
The command to do this is:</p>
+
<pre class="source">
jmeter -n -t script.jmx -r
</pre>
+
<p>or</p>
+
<pre class="source">
jmeter -n -t script.jmx -R server1,server2,…
</pre>
+
<p>
Other flags that may be useful:
</p>
+
<dl>
-<dt><span class="code">-Gproperty=value</span></dt><dd>define a property in all the servers (may appear more than once)</dd>
-<dt><span class="code">-X</span></dt><dd>Exit remote servers at the end of the test.</dd>
+
+<dt>
+<span class="code">-Gproperty=value</span>
+</dt>
+<dd>define a property in all the servers (may appear more than once)</dd>
+
+<dt>
+<span class="code">-X</span>
+</dt>
+<dd>Exit remote servers at the end of the test.</dd>
+
</dl>
+
<p>
The first example will start the test on whatever servers are defined in the JMeter property <span class="code">remote_hosts</span>;<br>
The second example will define <span class="code">remote_hosts</span> from the list of servers and then start the test on the remote servers.
<br>
The command-line client will exit when all the remote servers have stopped.
</p>
-<div class="subsection"><h2 id="detail_instructions">14.1 Doing it Manually<a class="sectionlink" href="#detail_instructions" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="detail_instructions">13.1 Doing it Manually<a class="sectionlink" href="#detail_instructions" title="Link to here">¶</a>
+</h2>
+
<p>In some cases, the jmeter-server script may not work for you (if you are using an OS platform not anticipated by the JMeter developers).
Here is how to start the JMeter servers (step 1 above) with a more manual process:</p>
-<p><b>Step 1a: Start the RMI Registry</b></p>
+
+<p>
+<b>Step 1a: Start the RMI Registry</b>
+</p>
+
<p>
Since JMeter 2.3.1, the RMI registry is started by the JMeter server, so this section does not apply in the normal case.
To revert to the previous behaviour, define the JMeter property <span class="code">server.rmi.create=false</span> on the server host systems
and follow the instructions below.
</p>
+
<p>JMeter uses Remote Method Invocation (RMI) as the remote communication mechanism. Therefore, you need
to run the RMI Registry application (which is named, "<span class="code">rmiregistry</span>") that comes with the JDK and is located in the "<span class="code">bin</span>"
directory. Before running <span class="code">rmiregistry</span>, make sure that the following jars are in your system classpath:
<ul>
- <li><span class="code">JMETER_HOME/lib/ext/ApacheJMeter_core.jar</span></li>
- <li><span class="code">JMETER_HOME/lib/jorphan.jar</span></li>
- <li><span class="code">JMETER_HOME/lib/logkit-2.0.jar</span></li>
+
+<li>
+<span class="code">JMETER_HOME/lib/ext/ApacheJMeter_core.jar</span>
+</li>
+
+<li>
+<span class="code">JMETER_HOME/lib/jorphan.jar</span>
+</li>
+
+<li>
+<span class="code">JMETER_HOME/lib/logkit-2.0.jar</span>
+</li>
+
</ul>
The
rmiregistry application needs access to certain JMeter classes. Run <span class="code">rmiregistry</span> with no parameters. By default the
application listens to port <span class="code">1099</span>.</p>
-<p><b>Step 1b: Start the JMeter Server</b></p>
+
+<p>
+<b>Step 1b: Start the JMeter Server</b>
+</p>
+
<p>Once the RMI Registry application is running, start the JMeter Server.
Use the "<span class="code">-s</span>" option with the jmeter startup script ("<span class="code">jmeter -s</span>").</p>
+
<p>Steps 2 and 3 remain the same.</p>
+
</div>
-<div class="subsection"><h2 id="tips">14.2 Tips<a class="sectionlink" href="#tips" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="tips">13.2 Tips<a class="sectionlink" href="#tips" title="Link to here">¶</a>
+</h2>
+
<p>
JMeter/RMI requires a connection from the client to the server. This will use the port you chose, default <span class="code">1099</span>.<br>
JMeter/RMI also requires a reverse connection in order to return sample results from the server to the client.<br>
@@ -150,9 +427,12 @@ If there are any firewalls or other netw
you will need to make sure that they are set up to allow the connections through.
If necessary, use monitoring software to show what traffic is being generated.
</p>
+
<p>If you're running Suse Linux, these tips may help. The default installation may enable the firewall. In that case,
remote testing will not work properly. The following tips were contributed by Sergey Ten.</p>
+
<p>If you see connections refused, turn on debugging by passing the following options.</p>
+
<pre class="source">
rmiregistry -J-Dsun.rmi.log.debug=true \
-J-Dsun.rmi.server.exceptionTrace=true \
@@ -161,42 +441,65 @@ rmiregistry -J-Dsun.rmi.log.debug=true \
-J-Dsun.rmi.transport.logLevel=verbose \
-J-Dsun.rmi.transport.tcp.logLevel=verbose \
</pre>
+
<p>Since JMeter 2.3.1, the RMI registry is started by the server; however the options can still be passed in from the JMeter command line.
For example: "<span class="code">jmeter -s -Dsun.rmi.loader.logLevel=verbose</span>" (i.e. omit the <span class="code">-J</span> prefixes).
Alternatively the properties can be defined in the <span class="code">system.properties</span> file.
</p>
+
<p>The solution to the problem is to remove the loopbacks <span class="code">127.0.0.1</span> and <span class="code">127.0.0.2</span> from <span class="code">/etc/hosts</span>.
What happens is <span class="code">jmeter-server</span> can't connect to rmiregistry if <span class="code">127.0.0.2</span> loopback is not available.
Use the following settings to fix the problem.</p>
+
<p> Replace</p>
+
<pre class="source">`dirname $0`/jmeter -s "$@"</pre>
+
<p> With</p>
+
<pre class="source">
HOST="-Djava.rmi.server.hostname=[computer_name][computer_domain] \
-Djava.security.policy=`dirname $0`/[policy_file]" \
`dirname $0`/jmeter $HOST -s "$@"
</pre>
+
<p>Also create a policy file and add <span class="code">[computer_name][computer_domain]</span> line to <span class="code">/etc/hosts</span>.</p>
+
<p>In order to better support SSH-tunneling of the RMI communication channels used
in remote testing, since JMeter 2.6:</p>
+
<ul>
+
<li>a new property "<span class="code">client.rmi.localport</span>" can be set to control the RMI port used by the RemoteSampleListenerImpl</li>
+
<li>To support tunneling RMI traffic over an SSH tunnel as the remote endpoint using a port on the local machine,
loopback interface is now allowed to be used if it has been specified directly using the Java System Property
"<span class="code">java.rmi.server.hostname</span>" parameter.</li>
+
</ul>
+
</div>
-<div class="subsection"><h2 id="portchange">14.3 Using a different port<a class="sectionlink" href="#portchange" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="portchange">13.3 Using a different port<a class="sectionlink" href="#portchange" title="Link to here">¶</a>
+</h2>
+
<p>By default, JMeter uses the standard RMI port <span class="code">1099</span>. It is possible to change this. For this to work successfully,
all the following need to agree:</p>
+
<ul>
+
<li>On the server, start <span class="code">rmiregistry</span> using the new port number</li>
+
<li>On the server, start JMeter with the property <span class="code">server_port</span> defined</li>
+
<li>On the client, update the <span class="code">remote_hosts</span> property to include the new remote <span class="code">host:port</span> settings</li>
+
</ul>
-<p>Since Jmeter 2.1.1, the jmeter-server scripts provide support for changing the port.
+
+<p>Since JMeter 2.1.1, the jmeter-server scripts provide support for changing the port.
For example, assume you want to use port <span class="code">1664</span> (perhaps <span class="code">1099</span> is already used).</p>
On Windows (in a DOS box)
<pre class="source">
@@ -212,12 +515,18 @@ $ SERVER_PORT=1664 jmeter-server [other
In both cases, the script starts rmiregistry on the specified port,
and then starts JMeter in server mode, having defined the "<span class="code">server_port</span>" property.
</p>
+
<p>
The chosen port will be logged in the server <span class="code">jmeter.log</span> file (<span class="code">rmiregistry</span> does not create a log file).
</p>
+
</div>
-<div class="subsection"><h2 id="sendermode">14.4 Using a different sample sender<a class="sectionlink" href="#sendermode" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="sendermode">13.4 Using a different sample sender<a class="sectionlink" href="#sendermode" title="Link to here">¶</a>
+</h2>
+
<p>
Listeners in the test plan send their results back to the client JMeter which writes the results to the specified files
By default, samples are sent back synchronously as they are generated.
@@ -225,38 +534,105 @@ This can affect the maximum throughput o
continue.
There are some JMeter properties that can be set to alter this behaviour.
</p>
+
<dl>
-<dt><span class="code">mode</span></dt><dd>sample sending mode - default is <span class="code">StrippedBatch</span> since 2.9. This should be set on the client node.
+
+<dt>
+<span class="code">mode</span>
+</dt>
+<dd>sample sending mode - default is <span class="code">StrippedBatch</span> since 2.9. This should be set on the client node.
<dl>
- <dt><span class="code">Standard</span></dt><dd>send samples synchronously as soon as they are generated</dd>
- <dt><span class="code">Hold</span></dt><dd>hold samples in an array until the end of a run. This may use a lot of memory on the server and is discouraged.</dd>
- <dt><span class="code">DiskStore</span></dt><dd>store samples in a disk file (under <span class="code">java.io.temp</span>) until the end of a run.
+
+<dt>
+<span class="code">Standard</span>
+</dt>
+<dd>send samples synchronously as soon as they are generated</dd>
+
+<dt>
+<span class="code">Hold</span>
+</dt>
+<dd>hold samples in an array until the end of a run. This may use a lot of memory on the server and is discouraged.</dd>
+
+<dt>
+<span class="code">DiskStore</span>
+</dt>
+<dd>store samples in a disk file (under <span class="code">java.io.temp</span>) until the end of a run.
The serialised data file is deleted on JVM exit.</dd>
- <dt><span class="code">StrippedDiskStore</span></dt><dd>remove responseData from successful samples, and use DiskStore sender to send them.</dd>
- <dt><span class="code">Batch</span></dt><dd>send saved samples when either the count (<span class="code">num_sample_threshold</span>) or time (<span class="code">time_threshold</span>) exceeds a threshold,
+
+<dt>
+<span class="code">StrippedDiskStore</span>
+</dt>
+<dd>remove responseData from successful samples, and use DiskStore sender to send them.</dd>
+
+<dt>
+<span class="code">Batch</span>
+</dt>
+<dd>send saved samples when either the count (<span class="code">num_sample_threshold</span>) or time (<span class="code">time_threshold</span>) exceeds a threshold,
at which point the samples are sent synchronously.
The thresholds can be configured on the server using the following properties:
<dl>
- <dt><span class="code">num_sample_threshold</span></dt><dd>number of samples to accumulate, default <span class="code">100</span></dd>
- <dt><span class="code">time_threshold</span></dt><dd>time threshold, default 60000 ms = 60 seconds</dd>
- </dl>
+
+<dt>
+<span class="code">num_sample_threshold</span>
+</dt>
+<dd>number of samples to accumulate, default <span class="code">100</span>
+</dd>
+
+<dt>
+<span class="code">time_threshold</span>
+</dt>
+<dd>time threshold, default 60000 ms = 60 seconds</dd>
+
+</dl>
See also the Asynch mode, described below.</dd>
- <dt><span class="code">Statistical</span></dt><dd>send a summary sample when either the count or time exceeds a threshold.
+
+<dt>
+<span class="code">Statistical</span>
+</dt>
+<dd>send a summary sample when either the count or time exceeds a threshold.
The samples are summarised by thread group name and sample label.
The following fields are accumulated:
<ul>
- <li><span class="code">elapsed time</span></li>
- <li><span class="code">latency</span></li>
- <li><span class="code">bytes</span></li>
- <li><span class="code">sample count</span></li>
- <li><span class="code">error count</span></li>
- </ul>
+
+<li>
+<span class="code">elapsed time</span>
+</li>
+
+<li>
+<span class="code">latency</span>
+</li>
+
+<li>
+<span class="code">bytes</span>
+</li>
+
+<li>
+<span class="code">sample count</span>
+</li>
+
+<li>
+<span class="code">error count</span>
+</li>
+
+</ul>
Other fields that vary between samples are lost.
</dd>
- <dt><span class="code">Stripped</span></dt><dd>remove responseData from successful samples</dd>
- <dt><span class="code">StrippedBatch</span></dt><dd>remove responseData from successful samples, and use Batch sender to send them.</dd>
- <dt><span class="code">Asynch</span></dt><dd>samples are temporarily stored in a local queue. A separate worker thread sends the samples.
+
+<dt>
+<span class="code">Stripped</span>
+</dt>
+<dd>remove responseData from successful samples</dd>
+
+<dt>
+<span class="code">StrippedBatch</span>
+</dt>
+<dd>remove responseData from successful samples, and use Batch sender to send them.</dd>
+
+<dt>
+<span class="code">Asynch</span>
+</dt>
+<dd>samples are temporarily stored in a local queue. A separate worker thread sends the samples.
This allows the test thread to continue without waiting for the result to be sent back to the client.
However, if samples are being created faster than they can be sent, the queue will eventually fill up,
and the sampler thread will block until some samples can be drained from the queue.
@@ -264,57 +640,121 @@ There are some JMeter properties that ca
The queue size can be adjusted by setting the JMeter property
<span class="code">asynch.batch.queue.size</span> (default <span class="code">100</span>) on the server node.
</dd>
- <dt><span class="code">StrippedAsynch</span></dt><dd>remove responseData from successful samples, and use Async sender to send them.</dd>
- <dt><span class="code">Custom implementation</span></dt><dd>set the mode parameter to your custom sample sender class name.
+
+<dt>
+<span class="code">StrippedAsynch</span>
+</dt>
+<dd>remove responseData from successful samples, and use Async sender to send them.</dd>
+
+<dt>
+<span class="code">Custom implementation</span>
+</dt>
+<dd>set the mode parameter to your custom sample sender class name.
This must implement the interface <span class="code">SampleSender</span> and have a constructor which takes a single
parameter of type <span class="code">RemoteSampleListener</span>.
</dd>
- </dl>
- </dd>
+
+</dl>
+
+</dd>
+
</dl>
-<div class="clear"></div><div class="note"><span class="code">Stripped</span> mode family strips <span class="code">responseData</span> so this means that some Elements that rely
+
+<div class="clear"></div>
+<div class="note">
+<span class="code">Stripped</span> mode family strips <span class="code">responseData</span> so this means that some Elements that rely
on the previous <span class="code">responseData</span> being available will not work.<br>
This is not really a problem as there is always a more efficient way to implement this feature.
-</div><div class="clear"></div>
+</div>
+<div class="clear"></div>
+
<p>The following properties apply to the <span class="code">Batch</span> and <span class="code">Statistical</span> modes:</p>
- <dl>
- <dt><span class="code">num_sample_threshold</span></dt><dd>number of samples in a batch (default <span class="code">100</span>)</dd>
- <dt><span class="code">time_threshold</span></dt><dd>number of milliseconds to wait (default 60 seconds)</dd>
- </dl>
+
+<dl>
+
+<dt>
+<span class="code">num_sample_threshold</span>
+</dt>
+<dd>number of samples in a batch (default <span class="code">100</span>)</dd>
+
+<dt>
+<span class="code">time_threshold</span>
+</dt>
+<dd>number of milliseconds to wait (default 60 seconds)</dd>
+
+</dl>
+
</div>
-<div class="subsection"><h2 id="retries">14.5 Dealing with nodes that failed starting<a class="sectionlink" href="#retries" title="Link to here">¶</a></h2>
- <p>
+
+<div class="subsection">
+<h2 id="retries">13.5 Dealing with nodes that failed starting<a class="sectionlink" href="#retries" title="Link to here">¶</a>
+</h2>
+
+<p>
For large-scale tests there is a chance that some part of remote servers will be unavailable or down.
For example, when you use automation script to allocate many cloud machines and use them as generators,
some of requested machines might fail booting because of cloud's issues.
Since JMeter 2.13 there are new properties to control this behaviour.
</p>
- <p>
+
+<p>
First what you might want is to retry initialization attempts in hope that failed nodes just slightly delayed their boot.
To enable retries, you should set <span class="code">client.tries</span> property to total number of connection attempts.
By default it does only one attempt. To control retry delay, set the <span class="code">client.retries_delay</span> property
to number of milliseconds to sleep between attempts.
</p>
- <p>
+
+<p>
Finally, you might still want to run the test with those generators that succeeded initialization and skipping failed nodes.
To enable that, set the <span class="code">client.continue_on_fail=true</span> property.
</p>
+
</div>
-</div><ul class="pagelinks"><li><a href="listeners.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="generating-dashboard.html">Next ></a></li></ul><div class="share-links">
+
+</div>
+<ul class="pagelinks">
+<li>
+<a href="listeners.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="generating-dashboard.html">Next ></a>
+</li>
+</ul>
+<div class="share-links">
Share this page:
- <ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
+ <ul>
+<li class="fb">
+<a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a>
+</li>
+<li class="twitter">
+<a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a>
+</li>
+<li class="gplus">
+<a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a>
+</li>
+</ul>
+</div>
+</div>
+<div class="footer">
+<div class="copyright">
Copyright ©
1999 –
2017
, Apache Software Foundation
- </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
+ </div>
+<div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
feather, and the Apache JMeter logo are
trademarks of the
Apache Software Foundation.
- </div></div><script>(function(){
+ </div>
+</div>
+<script>(function(){
// fill in the current location into social links on this page.
"use strict";
var as = document.getElementsByTagName('a');
@@ -328,4 +768,6 @@ This is not really a problem as there is
as[i].href = href + encodeURIComponent(loc);
}
}
- })();</script></body></html>
\ No newline at end of file
+ })();</script>
+</body>
+</html>
Modified: jmeter/trunk/docs/usermanual/test_plan.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/test_plan.html?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/test_plan.html (original)
+++ jmeter/trunk/docs/usermanual/test_plan.html Sun Sep 17 18:22:16 2017
@@ -1,19 +1,212 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
-<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-15"><title>Apache JMeter
+<html lang="en">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
+<title>Apache JMeter
-
- User's Manual: Elements of a Test Plan</title><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"><link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png"><link rel="icon" href="../images/favicon.png"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="../images/mstile-144x144.png"><meta name="theme-color" content="#ffffff"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!--
+ User's Manual: Elements of a Test Plan</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css">
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css">
+<link rel="stylesheet" type="text/css" href="../css/new-style.css">
+<link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png">
+<link rel="icon" href="../images/favicon.png">
+<meta name="msapplication-TileColor" content="#ffffff">
+<meta name="msapplication-TileImage" content="../images/mstile-144x144.png">
+<meta name="theme-color" content="#ffffff">
+</head>
+<body role="document">
+<a href="#content" class="hidden">Main content</a>
+<div class="header">
+<!--
APACHE LOGO
- --><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
+ -->
+<div>
+<a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a>
+</div>
+<!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li>
<li><a href="../usermanual/best-practices.html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log
Sampler</a></li><li><a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><
/ul></li></ul></div><div class="main" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="build-test-plan.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-web-test-plan.html">Next ></a></li></ul><div class="section"><h1>3. Elements of a Test Plan</h1>
+ -->
+<div>
+<a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a>
+</div>
+<div class="banner">
+<a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a>
+<div class="clear"></div>
+</div>
+</div>
+<div class="nav">
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">About</div>
+<ul>
+<li>
+<a href="../index.html">Overview</a>
+</li>
+<li>
+<a href="http://www.apache.org/licenses/">License</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Download</div>
+<ul>
+<li>
+<a href="../download_jmeter.cgi">Download Releases</a>
+</li>
+<li>
+<a href="../changes.html">Release Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Documentation</div>
+<ul>
+<li>
+<a href="../usermanual/get-started.html">Get Started</a>
+</li>
+<li>
+<a href="../usermanual/index.html">User Manual</a>
+</li>
+<li>
+<a href="../usermanual/best-practices.html">Best Practices</a>
+</li>
+<li>
+<a href="../usermanual/component_reference.html">Component Reference</a>
+</li>
+<li>
+<a href="../usermanual/functions.html">Functions Reference</a>
+</li>
+<li>
+<a href="../usermanual/properties_reference.html">Properties Reference</a>
+</li>
+<li>
+<a href="../changes_history.html">Change History</a>
+</li>
+<li>
+<a href="../api/index.html">Javadocs</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter">JMeter Wiki</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Tutorials</div>
+<ul>
+<li>
+<a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a>
+</li>
+<li>
+<a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Community</div>
+<ul>
+<li>
+<a href="../issues.html">Issue Tracking</a>
+</li>
+<li>
+<a href="http://www.apache.org/security/">Security</a>
+</li>
+<li>
+<a href="../mail.html">Mailing Lists</a>
+</li>
+<li>
+<a href="../svnindex.html">Source Repositories</a>
+</li>
+<li>
+<a href="../building.html">Building and Contributing</a>
+</li>
+<li>
+<a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Foundation</div>
+<ul>
+<li>
+<a href="http://www.apache.org/">The Apache Software Foundation (ASF)</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="main" id="content">
+<div class="social-media">
+<ul class="social-media-links">
+<li class="twitter">
+<a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a>
+</li>
+<li class="github">
+<a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a>
+</li>
+</ul>
+</div>
+<ul class="pagelinks">
+<li>
+<a href="build-test-plan.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="build-web-test-plan.html">Next ></a>
+</li>
+</ul>
+<div class="section">
+<h1>3. Elements of a Test Plan</h1>
+
<p>
This section describes the different parts of a test plan.
</p>
+
<p>
A minimal test will consist of the Test Plan, a Thread Group and one or more Samplers.
</p>
-<div class="subsection"><h2 id="test_plan">3.0 Test Plan<a class="sectionlink" href="#test_plan" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="test_plan">3.0 Test Plan<a class="sectionlink" href="#test_plan" title="Link to here">¶</a>
+</h2>
+
<p>The Test Plan object has a checkbox called "<span class="code">Functional Testing</span>". If selected, it
will cause JMeter to record the data returned from the server for each sample. If you have
selected a file in your test listeners, this data will be written to file. This can be useful if
@@ -21,11 +214,18 @@ you are doing a small run to ensure that
is returning the expected results. The consequence is that the file will grow huge quickly, and
JMeter's performance will suffer. This option should be off if you are doing stress-testing (it
is off by default). </p>
+
<p>If you are not recording the data to file, this option makes no difference.</p>
+
<p>You can also use the <span class="code">Configuration</span> button on a listener to decide what fields to save.</p>
+
</div>
-<div class="subsection"><h2 id="thread_group">3.1 Thread Group<a class="sectionlink" href="#thread_group" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="thread_group">3.1 Thread Group<a class="sectionlink" href="#thread_group" title="Link to here">¶</a>
+</h2>
+
<p>Thread group elements are the beginning points of any test plan.
All controllers and samplers must be under a thread group.
Other elements, e.g. Listeners, may be placed directly under the test plan,
@@ -33,31 +233,42 @@ in which case they will apply to all the
As the name implies, the thread group
element controls the number of threads JMeter will use to execute your test. The
controls for a thread group allow you to:
-<ul><li>Set the number of threads</li>
+<ul>
+<li>Set the number of threads</li>
+
<li>Set the ramp-up period</li>
+
<li>Set the number of times to execute the test</li>
-</ul></p>
+
+</ul>
+</p>
+
<p>Each thread will execute the test plan in its entirety and completely independently
of other test threads. Multiple threads are used to simulate concurrent connections
to your server application.</p>
+
<p>The ramp-up period tells JMeter how long to take to "ramp-up" to the full number of
threads chosen. If 10 threads are used, and the ramp-up period is 100 seconds, then
JMeter will take 100 seconds to get all 10 threads up and running. Each thread will
start 10 (100/10) seconds after the previous thread was begun. If there are 30 threads
and a ramp-up period of 120 seconds, then each successive thread will be delayed by 4 seconds.</p>
+
<p>Ramp-up needs to be long enough to avoid too large a work-load at the start
of a test, and short enough that the last threads start running before
the first ones finish (unless one wants that to happen).
</p>
+
<p>
Start with Ramp-up = number of threads and adjust up or down as needed.
</p>
+
<p>By default, the thread group is configured to loop once through its elements.</p>
+
<p>Thread Group also provides a <b>scheduler</b>.
Click the checkbox at the bottom of the Thread Group panel to enable/disable extra fields
in which you can enter the duration of test, the startup delay, the start and end times of the run.
@@ -71,16 +282,23 @@ Start with Ramp-up = number of threads a
When the test is started, JMeter will wait if necessary until the start-time has been reached.
At the end of each cycle, JMeter checks if the end-time has been reached, and if so, the run is stopped,
otherwise the test is allowed to continue until the iteration limit is reached.</p>
- </p>
+
+</p>
+
</div>
-<div class="subsection"><h2 id="controllers">3.2 Controllers<a class="sectionlink" href="#controllers" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="controllers">3.2 Controllers<a class="sectionlink" href="#controllers" title="Link to here">¶</a>
+</h2>
+
<p>
JMeter has two types of Controllers: Samplers and Logical Controllers.
These drive the processing of a test.
</p>
+
<p>Samplers tell JMeter to send requests to a server. For
example, add an HTTP Request Sampler if you want JMeter
to send an HTTP request. You can also customize a request by adding one
@@ -88,45 +306,66 @@ or more Configuration Elements to a Samp
information, see
<a href="#samplers">Samplers</a>.</p>
+
<p>Logical Controllers let you customize the logic that JMeter uses to
decide when to send requests. For example, you can add an Interleave
Logic Controller to alternate between two HTTP Request Samplers.
For more information, see <a href="#logic_controller">Logical Controllers</a>.</p>
+
</div>
-<div class="subsection"><h2 id="samplers">3.2.1 Samplers<a class="sectionlink" href="#samplers" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="samplers">3.2.1 Samplers<a class="sectionlink" href="#samplers" title="Link to here">¶</a>
+</h2>
+
<p>
Samplers tell JMeter to send requests to a server and wait for a response.
They are processed in the order they appear in the tree.
Controllers can be used to modify the number of repetitions of a sampler.
</p>
+
<p>
JMeter samplers include:
<ul>
- <li>FTP Request</li>
- <li>HTTP Request (can be used for SOAP or REST Webservice also)</li>
- <li>JDBC Request</li>
- <li>Java object request</li>
- <li>JMS request</li>
- <li>JUnit Test request</li>
- <li>LDAP Request</li>
- <li>Mail request</li>
- <li>OS Process request</li>
- <li>TCP request</li>
+
+<li>FTP Request</li>
+
+<li>HTTP Request (can be used for SOAP or REST Webservice also)</li>
+
+<li>JDBC Request</li>
+
+<li>Java object request</li>
+
+<li>JMS request</li>
+
+<li>JUnit Test request</li>
+
+<li>LDAP Request</li>
+
+<li>Mail request</li>
+
+<li>OS Process request</li>
+
+<li>TCP request</li>
+
</ul>
Each sampler has several properties you can set.
You can further customize a sampler by adding one or more Configuration Elements to the Test Plan.
</p>
+
<p>If you are going to send multiple requests of the same type (for example,
HTTP Request) to the same server, consider using a Defaults Configuration
Element. Each controller has one or more Defaults elements (see below). </p>
+
<p>Remember to add a Listener to your test plan to view and/or store the
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="#assertions">Assertion</a> to
the sampler. For example, in stress testing a web application, the server
@@ -135,10 +374,18 @@ may be missing sections. You could add a
common error strings, and so on. JMeter lets you create these assertions using regular
expressions.</p>
-<p><a href="component_reference.html#samplers">JMeter's built-in samplers</a></p>
+
+<p>
+<a href="component_reference.html#samplers">JMeter's built-in samplers</a>
+</p>
+
</div>
-<div class="subsection"><h2 id="logic_controller">3.2.2 Logic Controllers<a class="sectionlink" href="#logic_controller" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="logic_controller">3.2.2 Logic Controllers<a class="sectionlink" href="#logic_controller" title="Link to here">¶</a>
+</h2>
+
<p>Logic Controllers let you customize the logic that JMeter uses to
decide when to send requests.
Logic Controllers can change the order of requests coming from their
@@ -146,41 +393,68 @@ child elements. They can modify the req
requests, etc.
</p>
+
<p>To understand the effect of Logic Controllers on a test plan, consider the
following test tree:</p>
+
<p>
+
<ul>
+
<li>Test Plan</li>
- <ul>
- <li>Thread Group</li>
- <ul>
- <li>Once Only Controller</li>
- <ul>
- <li>Login Request (an <a href="../usermanual/component_reference.html#HTTP_Request">HTTP Request</a>)</li>
- </ul>
- <li>Load Search Page (HTTP Sampler)</li>
- <li>Interleave Controller</li>
- <ul>
- <li>Search "A" (HTTP Sampler)</li>
- <li>Search "B" (HTTP Sampler)</li>
- <li>HTTP default request (Configuration Element)</li>
- </ul>
- <li>HTTP default request (Configuration Element)</li>
- <li>Cookie Manager (Configuration Element)</li>
- </ul>
- </ul>
+
+<ul>
+
+<li>Thread Group</li>
+
+<ul>
+
+<li>Once Only Controller</li>
+
+<ul>
+
+<li>Login Request (an <a href="../usermanual/component_reference.html#HTTP_Request">HTTP Request</a>)</li>
+
+</ul>
+
+<li>Load Search Page (HTTP Sampler)</li>
+
+<li>Interleave Controller</li>
+
+<ul>
+
+<li>Search "A" (HTTP Sampler)</li>
+
+<li>Search "B" (HTTP Sampler)</li>
+
+<li>HTTP default request (Configuration Element)</li>
+
+</ul>
+
+<li>HTTP default request (Configuration Element)</li>
+
+<li>Cookie Manager (Configuration Element)</li>
+
+</ul>
+
</ul>
+
+</ul>
+
</p>
+
<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="../usermanual/component_reference.html#Once_Only_Controller">Once Only Controller</a>.</p>
+
<p>After the login, the next Sampler 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
is just a simple request, not filtered through any Logic Controller.</p>
+
<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,
@@ -189,6 +463,7 @@ ordering (i.e. it doesn't pass one on at
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="../usermanual/component_reference.html#HTTP_Request_Defaults">HTTP Request Defaults</a> 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,
@@ -201,6 +476,7 @@ path, and arguments, plus other optional
blank for those requests, and put that information into the Configuration Element. In this
case, this is a minor benefit at best, but it demonstrates the feature.</p>
+
<p>The next element in the tree is another HTTP default request, this time added to the
Thread Group itself. The Thread Group has a built-in Logic Controller, and thus, it uses
this Configuration Element exactly as described above. It fills in the blanks of any
@@ -210,162 +486,253 @@ into an HTTP default request element, ad
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 Sampler.</p>
+
<p>The last element is a <a href="../usermanual/component_reference.html#HTTP_Cookie_Manager">HTTP Cookie Manager</a>. 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>
+
<p>Logic Controllers can be combined to achieve various results. See the list of <a href="component_reference.html#logic_controllers">built-in
Logic Controllers</a>.</p>
+
</div>
-<div class="subsection"><h2 id="test_fragments">3.2.3 Test Fragments<a class="sectionlink" href="#test_fragments" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="test_fragments">3.2.3 Test Fragments<a class="sectionlink" href="#test_fragments" title="Link to here">¶</a>
+</h2>
+
<p>The Test Fragment element is a special type of <a href="#controllers">controller</a> that
exists on the Test Plan tree at the same level as the Thread Group element. It is distinguished
from a Thread Group in that it is not executed unless it is
referenced by either a <a href="../usermanual/component_reference.html#Module_Controller">Module Controller</a> or an <a href="../usermanual/component_reference.html#Include_Controller">Include_Controller</a>.
</p>
+
<p>This element is purely for code re-use within Test Plans</p>
+
</div>
-<div class="subsection"><h2 id="listeners">3.3 Listeners<a class="sectionlink" href="#listeners" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="listeners">3.3 Listeners<a class="sectionlink" href="#listeners" title="Link to here">¶</a>
+</h2>
+
<p>Listeners provide access to the information JMeter gathers about the test cases while
JMeter runs. The <a href="../usermanual/component_reference.html#Graph_Results">Graph Results</a> listener plots the response times on a graph.
The "View Results Tree" Listener shows details of sampler requests and responses, and can display basic HTML and XML representations of the response.
Other listeners provide summary or aggregation information.
</p>
+
<p>
Additionally, listeners can direct the data to a file for later use.
Every listener in JMeter provides a field to indicate the file to store data to.
There is also a Configuration button which can be used to choose which fields to save, and whether to use CSV or XML format.
-<div class="clear"></div><div class="note">Note that all Listeners save the same data; the only difference is in the way the data is presented on the screen.</div><div class="clear"></div>
+<div class="clear"></div>
+<div class="note">Note that all Listeners save the same data; the only difference is in the way the data is presented on the screen.</div>
+<div class="clear"></div>
+
</p>
+
<p>
Listeners can be added anywhere in the test, including directly under the test plan.
They will collect data only from elements at or below their level.
</p>
+
<p>There are several <a href="component_reference.html#listeners">listeners</a>
that come with JMeter.</p>
+
</div>
-<div class="subsection"><h2 id="timers">3.4 Timers<a class="sectionlink" href="#timers" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="timers">3.4 Timers<a class="sectionlink" href="#timers" title="Link to here">¶</a>
+</h2>
+
<p>By default, a JMeter thread executes samplers in sequence without pausing.
We recommend that you specify a delay by adding one of the available timers to
your Thread Group. If you do not add a delay, JMeter could overwhelm your server by
making too many requests in a very short amount of time.</p>
+
<p>A timer will cause JMeter to delay a certain amount of time <b>before</b> each
sampler which is in its <a href="#scoping_rules">scope</a>.</p>
+
<p>
If you choose to add more than one timer to a Thread Group, JMeter takes the sum of
the timers and pauses for that amount of time before executing the samplers to which the timers apply.
Timers can be added as children of samplers or controllers in order to restrict the samplers to which they are applied.
</p>
+
<p>
To provide a pause at a single place in a test plan, one can use the <a href="../usermanual/component_reference.html#Test_Action">Test Action</a> Sampler.
</p>
+
</div>
-<div class="subsection"><h2 id="assertions">3.5 Assertions<a class="sectionlink" href="#assertions" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="assertions">3.5 Assertions<a class="sectionlink" href="#assertions" title="Link to here">¶</a>
+</h2>
+
<p>Assertions allow you to assert facts about responses received from the
server being tested. Using an assertion, you can essentially "test" that your
application is returning the results you expect it to. </p>
+
<p>For instance, you can assert that the response to a query will contain some
particular text. The text you specify can be a Perl-style regular expression, and
you can indicate that the response is to contain the text, or that it should match
the whole response.</p>
+
<p>You can add an assertion to any Sampler. For example, you can
add an assertion to a HTTP Request that checks for the text, "<span class="code"></HTML></span>". JMeter
will then check that the text is present in the HTTP response. If JMeter cannot find the
text, then it will mark this as a failed request.</p>
-<div class="clear"></div><div class="note">
+
+<div class="clear"></div>
+<div class="note">
Note that assertions apply to all samplers which are in their <a href="#scoping_rules">scope</a>.
To restrict an assertion to a single sampler, add the assertion as a child of the sampler.
-</div><div class="clear"></div>
+</div>
+<div class="clear"></div>
+
<p>To view assertion results, add an Assertion Listener to the Thread Group.
Failed Assertions will also show up in the Tree View and Table Listeners,
and will count towards the error %age for example in the Aggregate and Summary reports.
</p>
+
</div>
-<div class="subsection"><h2 id="config_elements">3.6 Configuration Elements<a class="sectionlink" href="#config_elements" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="config_elements">3.6 Configuration Elements<a class="sectionlink" href="#config_elements" title="Link to here">¶</a>
+</h2>
+
<p>A configuration element works closely with a Sampler. Although it does not send requests
(except for <a href="../usermanual/component_reference.html#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder</a>), it can add to or modify requests.</p>
+
<p>A configuration element is accessible from only inside the tree branch where you place the element.
For example, if you place an HTTP Cookie Manager inside a Simple Logic Controller, the Cookie Manager will
only be accessible to HTTP Request Controllers you place inside the Simple Logic Controller (see figure 1).
The Cookie Manager is accessible to the HTTP requests "Web Page 1" and "Web Page 2", but not "Web Page 3". </p>
+
<p>Also, a configuration element inside a tree branch has higher precedence than the same element in a "parent"
branch. For example, we defined two HTTP Request Defaults elements, "Web Defaults 1" and "Web Defaults 2".
Since we placed "Web Defaults 1" inside a Loop Controller, only "Web Page 2" can access it. The other HTTP
requests will use "Web Defaults 2", since we placed it in the Thread Group (the "parent" of all other branches).</p>
-<figure><a href="../images/screenshots/http-config/http-config-example.png"><img src="../images/screenshots/http-config/http-config-example.png" width="" height="" alt="Figure 1 -
- Test Plan Showing Accessability of Configuration Elements"></a><figcaption>Figure 1 -
- Test Plan Showing Accessability of Configuration Elements</figcaption></figure>
-<div class="clear"></div><div class="note">
+<figure>
+<a href="../images/screenshots/http-config/http-config-example.png"><img src="../images/screenshots/http-config/http-config-example.png" width="" height="" alt="Figure 1 -
+ Test Plan Showing Accessibility of Configuration Elements"></a>
+<figcaption>Figure 1 -
+ Test Plan Showing Accessibility of Configuration Elements</figcaption>
+</figure>
+
+
+<div class="clear"></div>
+<div class="note">
The <a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> Configuration element is different.
It is processed at the start of a test, no matter where it is placed.
For simplicity, it is suggested that the element is placed only at the start of a Thread Group.
-</div><div class="clear"></div>
</div>
+<div class="clear"></div>
+
+</div>
+
+
+<div class="subsection">
+<h2 id="preprocessors">3.7 Pre-Processor Elements<a class="sectionlink" href="#preprocessors" title="Link to here">¶</a>
+</h2>
-<div class="subsection"><h2 id="preprocessors">3.7 Pre-Processor Elements<a class="sectionlink" href="#preprocessors" title="Link to here">¶</a></h2>
<p>A Pre-Processor executes some action prior to a Sampler Request being made.
If a Pre-Processor is attached to a Sampler element, then it will execute just prior to that sampler element running.
A Pre-Processor is most often used to modify the settings of a Sample Request just before it runs, or to update variables that aren't extracted from response text.
See the <a href="test_plan.html#scoping_rules"><b>scoping rules</b></a> for more details on when Pre-Processors are executed.</p>
+
</div>
-<div class="subsection"><h2 id="postprocessors">3.8 Post-Processor Elements<a class="sectionlink" href="#postprocessors" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="postprocessors">3.8 Post-Processor Elements<a class="sectionlink" href="#postprocessors" title="Link to here">¶</a>
+</h2>
+
<p>A Post-Processor executes some action after a Sampler Request has been made.
If a Post-Processor is attached to a Sampler element, then it will execute just after that sampler element runs.
A Post-Processor is most often used to process the response data, often to extract values from it.
See the <a href="test_plan.html#scoping_rules"><b>scoping rules</b></a> for more details on when Post-Processors are executed.</p>
+
</div>
-<div class="subsection"><h2 id="executionorder">3.9 Execution order<a class="sectionlink" href="#executionorder" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="executionorder">3.9 Execution order<a class="sectionlink" href="#executionorder" title="Link to here">¶</a>
+</h2>
+
<ol start="0">
+
<li>Configuration elements</li>
+
<li>Pre-Processors</li>
+
<li>Timers</li>
+
<li>Sampler</li>
+
<li>Post-Processors (unless SampleResult is <span class="code">null</span>)</li>
+
<li>Assertions (unless SampleResult is <span class="code">null</span>)</li>
+
<li>Listeners (unless SampleResult is <span class="code">null</span>)</li>
+
</ol>
-<div class="clear"></div><div class="note">
+
+<div class="clear"></div>
+<div class="note">
Please note that Timers, Assertions, Pre- and Post-Processors are only processed if there is a sampler to which they apply.
Logic Controllers and Samplers are processed in the order in which they appear in the tree.
Other test elements are processed according to the scope in which they are found, and the type of test element.
[Within a type, elements are processed in the order in which they appear in the tree].
-</div><div class="clear"></div>
+</div>
+<div class="clear"></div>
+
<p>
For example, in the following test plan:
<ul>
+
<li>Controller</li>
+
<ul>
+
<li>Post-Processor 1</li>
+
<li>Sampler 1</li>
+
<li>Sampler 2</li>
+
<li>Timer 1</li>
+
<li>Assertion 1</li>
+
<li>Pre-Processor 1</li>
+
<li>Timer 2</li>
+
<li>Post-Processor 2</li>
+
</ul>
+
</ul>
The order of execution would be:
<pre>
@@ -385,37 +752,70 @@ Post-Processor 1
Post-Processor 2
Assertion 1
</pre>
+
</p>
+
</div>
-<div class="subsection"><h2 id="scoping_rules">3.10 Scoping Rules<a class="sectionlink" href="#scoping_rules" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="scoping_rules">3.10 Scoping Rules<a class="sectionlink" href="#scoping_rules" title="Link to here">¶</a>
+</h2>
+
<p>
The JMeter test tree contains elements that are both hierarchical and ordered. Some elements in the test trees are strictly hierarchical (Listeners, Config Elements, Post-Processors, Pre-Processors, Assertions, Timers), and some are primarily ordered (controllers, samplers). When you create your test plan, you will create an ordered list of sample request (via Samplers) that represent a set of steps to be executed. These requests are often organized within controllers that are also ordered. Given the following test tree:</p>
-<figure><a href="../images/screenshots/scoping1.png"><img src="../images/screenshots/scoping1.png" width="" height="" alt="Example test tree"></a><figcaption>Example test tree</figcaption></figure>
+
+<figure>
+<a href="../images/screenshots/scoping1.png"><img src="../images/screenshots/scoping1.png" width="" height="" alt="Example test tree"></a>
+<figcaption>Example test tree</figcaption>
+</figure>
+
<p>The order of requests will be, One, Two, Three, Four.</p>
+
<p>Some controllers affect the order of their subelements, and you can read about these specific controllers in <a href="component_reference.html">the component reference</a>.</p>
+
<p>Other elements are hierarchical. An Assertion, for instance, is hierarchical in the test tree.
If its parent is a request, then it is applied to that request. If its
parent is a Controller, then it affects all requests that are descendants of
that Controller. In the following test tree:</p>
-<figure><a href="../images/screenshots/scoping2.png"><img src="../images/screenshots/scoping2.png" width="" height="" alt="Hierarchy example"></a><figcaption>Hierarchy example</figcaption></figure>
+
+<figure>
+<a href="../images/screenshots/scoping2.png"><img src="../images/screenshots/scoping2.png" width="" height="" alt="Hierarchy example"></a>
+<figcaption>Hierarchy example</figcaption>
+</figure>
+
<p>Assertion #1 is applied only to Request One, while Assertion #2 is applied to Requests Two and Three.</p>
+
<p>Another example, this time using Timers:</p>
-<figure><a href="../images/screenshots/scoping3.png"><img src="../images/screenshots/scoping3.png" width="" height="" alt="complex example"></a><figcaption>complex example</figcaption></figure>
+
+<figure>
+<a href="../images/screenshots/scoping3.png"><img src="../images/screenshots/scoping3.png" width="" height="" alt="complex example"></a>
+<figcaption>complex example</figcaption>
+</figure>
+
<p>In this example, the requests are named to reflect the order in which they will be executed. Timer #1 will apply to Requests Two, Three, and Four (notice how order is irrelevant for hierarchical elements). Assertion #1 will apply only to Request Three. Timer #2 will affect all the requests.</p>
+
<p>Hopefully these examples make it clear how configuration (hierarchical) elements are applied. If you imagine each Request being passed up the tree branches, to its parent, then to its parent's parent, etc., and each time collecting all the configuration elements of that parent, then you will see how it works. </p>
-<div class="clear"></div><div class="note">
+
+<div class="clear"></div>
+<div class="note">
The Configuration elements Header Manager, Cookie Manager and Authorization manager are
treated differently from the Configuration Default elements.
The settings from the Configuration Default elements are merged into a set of values that the Sampler has access to.
However, the settings from the Managers are not merged.
If more than one Manager is in the scope of a Sampler,
only one Manager is used, but there is currently no way to specify <em>which</em> is used.
-</div><div class="clear"></div>
</div>
+<div class="clear"></div>
+
+</div>
+
-<div class="subsection"><h2 id="properties">3.11 Properties and Variables<a class="sectionlink" href="#properties" title="Link to here">¶</a></h2>
+<div class="subsection">
+<h2 id="properties">3.11 Properties and Variables<a class="sectionlink" href="#properties" title="Link to here">¶</a>
+</h2>
+
<p>
JMeter <em>properties</em> are defined in <span class="code">jmeter.properties</span> (see <a href="get-started.html#configuring_jmeter">Getting Started - Configuring JMeter</a> for more details).
@@ -426,6 +826,7 @@ Properties can be referenced in test pla
- see <a href="functions.html#__property">Functions - read a property</a> -
but cannot be used for thread-specific values.
</p>
+
<p>
JMeter <em>variables</em> are local to each thread. The values may be the same for each thread, or they may be different.
<br>
@@ -434,7 +835,9 @@ For example the <a href="../usermanual/c
will set its variables according to the sample that its thread has read, and these can be used later
by the same thread.
For details of how to reference variables and functions, see <a href="functions.html">Functions and Variables</a>
+
</p>
+
<p>
Note that the values defined by the <a href="../usermanual/component_reference.html#Test_Plan">Test Plan</a> and the <a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> configuration element
are made available to the whole test plan at startup.
@@ -444,20 +847,30 @@ Other elements such as the
<a href="../usermanual/component_reference.html#User_Parameters">User Parameters</a> Pre-Processor or <a href="../usermanual/component_reference.html#Regular_Expression_Extractor">Regular Expression Extractor</a> Post-Processor
may be used to redefine the same variables (or create new ones). These redefinitions only apply to the current thread.
</p>
+
<p>
The <a href="functions.html#__setProperty">setProperty</a> function can be used to define a JMeter property.
These are global to the test plan, so can be used to pass information between threads - should that be needed.
</p>
-<div class="clear"></div><div class="note">Both variables and properties are case-sensitive.</div><div class="clear"></div>
+
+<div class="clear"></div>
+<div class="note">Both variables and properties are case-sensitive.</div>
+<div class="clear"></div>
+
</div>
-<div class="subsection"><h2 id="using_variables">3.12 Using Variables to parameterise tests<a class="sectionlink" href="#using_variables" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="using_variables">3.12 Using Variables to parameterise tests<a class="sectionlink" href="#using_variables" title="Link to here">¶</a>
+</h2>
+
<p>
Variables don't have to vary - they can be defined once, and if left alone, will not change value.
So you can use them as short-hand for expressions that appear frequently in a test plan.
Or for items which are constant during a run, but which may vary between runs.
For example, the name of a host, or the number of threads in a thread group.
</p>
+
<p>
When deciding how to structure a Test Plan,
make a note of which items are constant for the run, but which may change between runs.
@@ -468,6 +881,7 @@ Also consider which items need to be loc
for example counters or values extracted with the Regular Expression Post-Processor.
You may wish to use a different naming convention for these.
</p>
+
<p>
For example, you might define the following on the Test Plan:
<pre>
@@ -488,21 +902,53 @@ You can then change some or all of the v
<pre>
jmeter … -Jhost=www3.example.org -Jloops=13
</pre>
+
</p>
+
</div>
-</div><ul class="pagelinks"><li><a href="build-test-plan.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-web-test-plan.html">Next ></a></li></ul><div class="share-links">
+
+</div>
+<ul class="pagelinks">
+<li>
+<a href="build-test-plan.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="build-web-test-plan.html">Next ></a>
+</li>
+</ul>
+<div class="share-links">
Share this page:
- <ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
+ <ul>
+<li class="fb">
+<a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a>
+</li>
+<li class="twitter">
+<a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a>
+</li>
+<li class="gplus">
+<a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a>
+</li>
+</ul>
+</div>
+</div>
+<div class="footer">
+<div class="copyright">
Copyright ©
1999 –
2017
, Apache Software Foundation
- </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
+ </div>
+<div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
feather, and the Apache JMeter logo are
trademarks of the
Apache Software Foundation.
- </div></div><script>(function(){
+ </div>
+</div>
+<script>(function(){
// fill in the current location into social links on this page.
"use strict";
var as = document.getElementsByTagName('a');
@@ -516,4 +962,6 @@ jmeter … -Jhost=www3.example.org
as[i].href = href + encodeURIComponent(loc);
}
}
- })();</script></body></html>
\ No newline at end of file
+ })();</script>
+</body>
+</html>
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java Sun Sep 17 18:22:16 2017
@@ -49,7 +49,7 @@ public final class JMeterVersion {
* This ensures that JMeterUtils always gets the correct
* version, even if JMeterUtils is not re-compiled during the build.
*/
- private static final String VERSION = "3.3-SNAPSHOT";
+ private static final String VERSION = "3.3";
private static final String IMPLEMENTATION;
Modified: jmeter/trunk/xdocs/download_jmeter.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/download_jmeter.xml?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/xdocs/download_jmeter.xml (original)
+++ jmeter/trunk/xdocs/download_jmeter.xml Sun Sep 17 18:22:16 2017
@@ -18,7 +18,7 @@
<!DOCTYPE document
[
-<!ENTITY release '3.2'>
+<!ENTITY release '3.3'>
<!ENTITY hellip "…" >
]>
Modified: jmeter/trunk/xdocs/overview.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/overview.html?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/xdocs/overview.html (original)
+++ jmeter/trunk/xdocs/overview.html Sun Sep 17 18:22:16 2017
@@ -18,7 +18,7 @@
<!-- This file is copied into the Javadoc overview -->
<html>
<body>
-This is the documentation for Apache JMeter version 3.2 API.
-@version 3.2
+This is the documentation for Apache JMeter version 3.3 API.
+@version 3.3
</body>
</html>
\ No newline at end of file