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 2015/03/24 20:39:32 UTC
svn commit: r1668968 - /jmeter/trunk/xdocs/usermanual/get-started.xml
Author: fschumacher
Date: Tue Mar 24 19:39:31 2015
New Revision: 1668968
URL: http://svn.apache.org/r1668968
Log:
Markup changes. Use code for code like text fragments. Use definition lists where apropriate and split source blocks.
Modified:
jmeter/trunk/xdocs/usermanual/get-started.xml
Modified: jmeter/trunk/xdocs/usermanual/get-started.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/get-started.xml?rev=1668968&r1=1668967&r2=1668968&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/get-started.xml (original)
+++ jmeter/trunk/xdocs/usermanual/get-started.xml Tue Mar 24 19:39:31 2015
@@ -112,10 +112,10 @@ It also has an SMTP(S) sampler.
implementation of SSL be provided, as is the case with Sun Java 1.4 and above.
If your version of Java does not include SSL support, then it is possible to add an external implementation.
Include the necessary encryption packages in JMeter's <a href="#classpath">classpath</a>.
-Also, update <a href="#configuring_jmeter">system.properties</a> to register the SSL Provider.</p>
+Also, update <a href="#configuring_jmeter"><code>system.properties</code></a> to register the SSL Provider.</p>
<p>
JMeter HTTP defaults to protocol level TLS. This can be changed by editting the JMeter property
-<i>https.default.protocol</i> in jmeter.properties or user.properties.
+<code>https.default.protocol</code> in <code>jmeter.properties</code> or <code>user.properties</code>.
</p>
<p><b>The JMeter HTTP samplers are configured to accept all certificates,
whether trusted or not, regardless of validity periods, etc.</b>
@@ -137,17 +137,17 @@ Make sure the file is a jar file, not a
<subsection name="§-num;.2.6 JMS client" anchor="opt_jms">
<p>
JMeter now includes the JMS API from Apache Geronimo, so you just need to add the appropriate JMS Client implementation
-jar(s) from the JMS provider. Please refer to their documentation for details.
+jar(s) from the JMS provider. Please refer to their documentation for details.
There may also be some information on the <a href="http://wiki.apache.org/jmeter/">JMeter Wiki</a>.
</p>
</subsection>
<subsection name="§-num;.2.7 Libraries for ActiveMQ JMS" anchor="libraries_activemq">
<p>
-You will need to add the jar activemq-all-X.X.X.jar to your classpath, e.g. by storing it in the lib/ directory.
+You will need to add the jar <code>activemq-all-X.X.X.jar</code> to your classpath, e.g. by storing it in the <code>lib/</code> directory.
</p>
<p>
-The other required jars (such as commons-logging) are already included with JMeter.
+The other required jars (such as commons-logging) are already included with JMeter.
</p>
<p>
See <a href="http://activemq.apache.org/initial-configuration.html">ActiveMQ initial configuration page</a>
@@ -165,13 +165,13 @@ See the <a href="#classpath">JMeter Clas
<p>We recommend that most users run the <a href="http://jmeter.apache.org/download_jmeter.cgi">latest release</a>.</p>
<p>To install a release build, simply unzip the zip/tar file into the directory
where you want JMeter to be installed. Provided that you have a JRE/JDK correctly installed
-and the JAVA_HOME environment variable set, there is nothing more for you to do.</p>
-<p>
-Note: there can be problems (especially with client-server mode) if the directory path contains any spaces.
-</p>
+and the <code>JAVA_HOME</code> environment variable set, there is nothing more for you to do.</p>
+<note>
+There can be problems (especially with client-server mode) if the directory path contains any spaces.
+</note>
<p>
-The installation directory structure should look something like this (where X.Y is version number):
-<pre>
+The installation directory structure should look something like this (where <code>X.Y</code> is version number):
+<source>
apache-jmeter-X.Y
apache-jmeter-X.Y/bin
apache-jmeter-X.Y/docs
@@ -181,94 +181,96 @@ apache-jmeter-X.Y/lib/ext
apache-jmeter-X.Y/lib/junit
apache-jmeter-X.Y/licenses
apache-jmeter-X.Y/printable_docs
-</pre>
-You can rename the parent directory (i.e. apache-jmeter-X.Y) if you want, but do not change any of the sub-directory names.
+</source>
+You can rename the parent directory (i.e. <code>apache-jmeter-X.Y</code>) if you want, but do not change any of the sub-directory names.
</p>
</section>
<section name="§-num;.4 Running JMeter" anchor="running">
<br/>
-<p>To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file.
+<p>To run JMeter, run the <code>jmeter.bat</code> (for Windows) or <code>jmeter</code> (for Unix) file.
These files are found in the bin directory.
-After a short time, the JMeter GUI should appear.
+After a short time, the JMeter GUI should appear.
</p>
<p>
There are some additional scripts in the bin directory that you may find useful.
Windows script files (the .CMD files require Win2K or later):
-<ul>
-<li>jmeter.bat - run JMeter (in GUI mode by default)</li>
-<li>jmeterw.cmd - run JMeter without the windows shell console (in GUI mode by default)</li>
-<li>jmeter-n.cmd - drop a JMX file on this to run a non-GUI test</li>
-<li>jmeter-n-r.cmd - drop a JMX file on this to run a non-GUI test remotely</li>
-<li>jmeter-t.cmd - drop a JMX file on this to load it in GUI mode</li>
-<li>jmeter-server.bat - start JMeter in server mode</li>
-<li>mirror-server.cmd - runs the JMeter Mirror Server in non-GUI mode</li>
-<li>shutdown.cmd - Run the Shutdown client to stop a non-GUI instance gracefully</li>
-<li>stoptest.cmd - Run the Shutdown client to stop a non-GUI instance abruptly</li>
-</ul>
-Note: the special name LAST can be used with jmeter-n.cmd, jmeter-t.cmd and jmeter-n-r.cmd
-and means the last test plan that was run interactively.
</p>
+<dl>
+<dt><code>jmeter.bat</code></dt><dd>run JMeter (in GUI mode by default)</dd>
+<dt><code>jmeterw.cmd</code></dt><dd>run JMeter without the windows shell console (in GUI mode by default)</dd>
+<dt><code>jmeter-n.cmd</code></dt><dd>drop a JMX file on this to run a non-GUI test</dd>
+<dt><code>jmeter-n-r.cmd</code></dt><dd>drop a JMX file on this to run a non-GUI test remotely</dd>
+<dt><code>jmeter-t.cmd</code></dt><dd>drop a JMX file on this to load it in GUI mode</dd>
+<dt><code>jmeter-server.bat</code></dt><dd>start JMeter in server mode</dd>
+<dt><code>mirror-server.cmd</code></dt><dd>runs the JMeter Mirror Server in non-GUI mode</dd>
+<dt><code>shutdown.cmd</code></dt><dd>Run the Shutdown client to stop a non-GUI instance gracefully</dd>
+<dt><code>stoptest.cmd</code></dt><dd>Run the Shutdown client to stop a non-GUI instance abruptly</dd>
+</dl>
+<note>The special name <code>LAST</code> can be used with <code>jmeter-n.cmd</code>, <code>jmeter-t.cmd</code> and <code>jmeter-n-r.cmd</code>
+and means the last test plan that was run interactively.</note>
<p>
-The environment variable JVM_ARGS can be used to override JVM settings in the jmeter.bat script.
+The environment variable <code>JVM_ARGS</code> can be used to override JVM settings in the <code>jmeter.bat</code> script.
For example:
-<pre>
+</p>
+<source>
set JVM_ARGS="-Xms1024m -Xmx1024m -Dpropname=propvalue"
jmeter -t test.jmx ...
-</pre>
-</p>
+</source>
<p>
Un*x script files; should work on most Linux/Unix systems:
-<ul>
-<li>jmeter - run JMeter (in GUI mode by default). Defines some JVM settings which may not work for all JVMs.</li>
-<li>jmeter-server - start JMeter in server mode (calls jmeter script with appropriate parameters)</li>
-<li>jmeter.sh - very basic JMeter script (You may need to adapt JVM options like memory settings).</li>
-<li>mirror-server.sh - runs the JMeter Mirror Server in non-GUI mode</li>
-<li>shutdown.sh - Run the Shutdown client to stop a non-GUI instance gracefully</li>
-<li>stoptest.sh - Run the Shutdown client to stop a non-GUI instance abruptly</li>
-</ul>
</p>
+<dl>
+<dt><code>jmeter</code></dt><dd>run JMeter (in GUI mode by default). Defines some JVM settings which may not work for all JVMs.</dd>
+<dt><code>jmeter-server</code></dt><dd>start JMeter in server mode (calls jmeter script with appropriate parameters)</dd>
+<dt><code>jmeter.sh</code></dt><dd>very basic JMeter script (You may need to adapt JVM options like memory settings).</dd>
+<dt><code>mirror-server.sh</code></dt><dd>runs the JMeter Mirror Server in non-GUI mode</dd>
+<dt><code>shutdown.sh</code></dt><dd>Run the Shutdown client to stop a non-GUI instance gracefully</dd>
+<dt><code>stoptest.sh</code></dt><dd>Run the Shutdown client to stop a non-GUI instance abruptly</dd>
+</dl>
<p>
It may be necessary to edit the jmeter shell script if some of the JVM options are not supported
by the JVM you are using.
-The JVM_ARGS environment variable can be used to override or set additional JVM options, for example:
-<pre>
+The <code>JVM_ARGS</code> environment variable can be used to override or set additional JVM options, for example:
+</p>
+<source>
JVM_ARGS="-Xms1024m -Xmx1024m" jmeter -t test.jmx [etc.]
-</pre>
+</source>
will override the HEAP settings in the script.
-</p>
<subsection name="§-num;.4.1 JMeter's Classpath" anchor="classpath">
<p>JMeter automatically finds classes from jars in the following directories:</p>
-<ul>
-<li>JMETER_HOME/lib - used for utility jars</li>
-<li>JMETER_HOME/lib/ext - used for JMeter components and plugins</li>
-</ul>
+<dl>
+<dt><code>JMETER_HOME/lib</code></dt><dd>used for utility jars</dd>
+<dt><code>JMETER_HOME/lib/ext</code></dt><dd>used for JMeter components and plugins</dd>
+</dl>
<p>If you have developed new JMeter components,
-then you should jar them and copy the jar into JMeter's <b>lib/ext</b> directory.
+then you should jar them and copy the jar into JMeter's <code>lib/ext</code> directory.
JMeter will automatically find JMeter components in any jars found here.
-Do not use lib/ext for utility jars or dependency jars used by the plugins;
+Do not use <code>lib/ext</code> for utility jars or dependency jars used by the plugins;
it is only intended for JMeter components and plugins.
</p>
-<p>If you don't want to put JMeter plugin jars in the <b>lib/ext</b> directory,
-then define the property <b>search_paths</b> in jmeter.properties.
+<p>If you don't want to put JMeter plugin jars in the <code>lib/ext</code> directory,
+then define the property <code>search_paths</code> in <code>jmeter.properties</code>.
</p>
-<p>Utility and dependency jars (libraries etc) can be placed in the <b>lib</b> directory.</p>
-<p>If you don't want to put such jars in the <b>lib</b> directory,
-then define the property <b>user.classpath</b> or <b>plugin_dependency_paths</b>
-in jmeter.properties. See below for an explanation of the differences.
+<p>Utility and dependency jars (libraries etc) can be placed in the <code>lib</code> directory.</p>
+<p>If you don't want to put such jars in the <code>lib</code> directory,
+then define the property <code>user.classpath</code> or <code>plugin_dependency_paths</code>
+in <code>jmeter.properties</code>. See below for an explanation of the differences.
</p>
<p>
Other jars (such as JDBC, JMS implementations and any other support libaries needed by the JMeter code)
-should be placed in the <b>lib</b> directory - not the <b>lib/ext</b> directory,
-or added to <b>user.classpath</b>.</p>
-<p>Note: JMeter will only find .jar files, not .zip.</p>
-<p>You can also install utility Jar files in $JAVA_HOME/jre/lib/ext, or you can set the property <b>user.classpath</b> in jmeter.properties</p>
-<p>Note that setting the CLASSPATH environment variable will have no effect.
-This is because JMeter is started with "java -jar",
-and the java command silently ignores the CLASSPATH variable, and the -classpath/-cp options when -jar is used.
+should be placed in the <code>lib</code> directory - not the <code>lib/ext</code> directory,
+or added to <code>user.classpath</code>.</p>
+<note>JMeter will only find <code>.jar</code> files, not <code>.zip</code>.</note>
+<p>You can also install utility Jar files in <code>$JAVA_HOME/jre/lib/ext</code>, or you can set the
+property <code>user.classpath</code> in <code>jmeter.properties</code></p>
+<p>Note that setting the <code>CLASSPATH</code> environment variable will have no effect.
+This is because JMeter is started with "<code>java -jar</code>",
+and the java command silently ignores the <code>CLASSPATH</code> variable, and the <code>-classpath</code>/<code>-cp</code>
+options when <code>-jar</code> is used.
[This occurs with all Java programs, not just JMeter.]</p>
</subsection>
@@ -285,35 +287,38 @@ and the java command silently ignores th
<subsection name="§-num;.4.3 Using JMeter behind a proxy" anchor="proxy_server">
<p>If you are testing from behind a firewall/proxy server, you may need to provide JMeter with
-the firewall/proxy server hostname and port number. To do so, run the jmeter[.bat] file
+the firewall/proxy server hostname and port number. To do so, run the <code>jmeter[.bat]</code> file
from a command line with the following parameters:</p>
-<p>
--H [proxy server hostname or ip address]<br/>
--P [proxy server port]<br/>
--N [nonproxy hosts] (e.g. *.apache.org|localhost)<br/>
--u [username for proxy authentication - if required]<br/>
--a [password for proxy authentication - if required]<br/>
-</p>
-<p><b>Example</b>: jmeter -H my.proxy.server -P 8000 -u username -a password -N localhost</p>
-<p>You can also use --proxyHost, --proxyPort, --username, and --password as parameter names</p>
+<dl>
+<dh><code>-H</code></dh><dd>[proxy server hostname or ip address]</dd>
+<dh><code>-P</code></dh><dd>[proxy server port]</dd>
+<dh><code>-N</code></dh><dd>[nonproxy hosts] (e.g. <code>*.apache.org|localhost</code>)</dd>
+<dh><code>-u</code></dh><dd>[username for proxy authentication - if required]</dd>
+<dh><code>-a</code></dh><dd>[password for proxy authentication - if required]</dd>
+</dl>
+<b>Example</b>:
+<source>jmeter -H my.proxy.server -P 8000 -u username -a password -N localhost</source>
+<p>You can also use <code>--proxyHost</code>, <code>--proxyPort</code>, <code>--username</code>, and <code>--password</code> as parameter names</p>
<note>
Parameters provided on a command-line may be visible to other users on the system.
</note>
<p>
If the proxy host and port are provided, then JMeter sets the following System properties:
+</p>
<ul>
-<li>http.proxyHost</li>
-<li>http.proxyPort</li>
-<li>https.proxyHost</li>
-<li>https.proxyPort</li>
+<li><code>http.proxyHost</code></li>
+<li><code>http.proxyPort</code></li>
+<li><code>https.proxyHost</code></li>
+<li><code>https.proxyPort</code></li>
</ul>
If a nonproxy host list is provided, then JMeter sets the following System properties:
<ul>
-<li>http.nonProxyHosts</li>
-<li>https.nonProxyHosts</li>
+<li><code>http.nonProxyHosts</code></li>
+<li><code>https.nonProxyHosts</code></li>
</ul>
+<p>
So if you don't wish to set both http and https proxies,
-you can define the relevant properties in system.properties instead of using the command-line parameters.
+you can define the relevant properties in <code>system.properties</code> instead of using the command-line parameters.
</p>
<p>
Proxy Settings can also be defined in a Test Plan, using either the <complink name="HTTP Request Defaults"/>
@@ -327,23 +332,24 @@ This is not to be confused with the prox
<subsection name="§-num;.4.4 Non-GUI Mode (Command Line mode)" anchor="non_gui">
<p>For non-interactive testing, you may choose to run JMeter without the GUI. To do so, use
the following command options:</p>
-<p>
--n This specifies JMeter is to run in non-gui mode<br/>
--t [name of JMX file that contains the Test Plan].<br/>
--l [name of JTL file to log sample results to].<br/>
--j [name of JMeter run log file].<br/>
--r Run the test in the servers specified by the JMeter property "remote_hosts"<br/>
--R [list of remote servers] Run the test in the specified remote servers
-</p>
+<dl>
+<dh><code>-n</code></dh><dd>This specifies JMeter is to run in non-gui mode</dd>
+<dh><code>-t</code></dh><dd>[name of JMX file that contains the Test Plan].</dd>
+<dh><code>-l</code></dh><dd>[name of JTL file to log sample results to].</dd>
+<dh><code>-j</code></dh><dd>[name of JMeter run log file].</dd>
+<dh><code>-r</code></dh><dd>Run the test in the servers specified by the JMeter property "<code>remote_hosts</code>"</dd>
+<dh><code>-R</code></dh><dd>[list of remote servers] Run the test in the specified remote servers</dd>
+</dl>
<p>The script also lets you specify the optional firewall/proxy server information:</p>
+<dl>
+<dh><code>-H</code></dh><dd>[proxy server hostname or ip address]</dd>
+<dh><code>-P</code></dh><dd>[proxy server port]</dd>
+</dl>
+<b>Example</b>
+<source>jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000</source>
<p>
--H [proxy server hostname or ip address]<br/>
--P [proxy server port]
-</p>
-<p><b>Example</b>: jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000</p>
-<p>
-If the property <code>jmeterengine.stopfail.system.exit</code> is set to true (default is false),
-then JMeter will invoke System.exit(1) if it cannot stop all threads.
+If the property <code>jmeterengine.stopfail.system.exit</code> is set to <code>true</code> (default is <code>false</code>),
+then JMeter will invoke <code>System.exit(1)</code> if it cannot stop all threads.
Normally this is not necessary.
</p>
</subsection>
@@ -351,52 +357,57 @@ Normally this is not necessary.
<subsection name="§-num;.4.5 Server Mode" anchor="server">
<p>For <a href="remote-test.html">distributed testing</a>, run JMeter in server mode on the remote node(s), and then control the server(s) from the GUI.
You can also use non-GUI mode to run remote tests.
-To start the server(s), run jmeter-server[.bat] on each server host.</p>
+To start the server(s), run <code>jmeter-server[.bat]</code> on each server host.</p>
<p>The script also lets you specify the optional firewall/proxy server information:</p>
-<p>-H [proxy server hostname or ip address]<br/>
--P [proxy server port]</p>
-<p><b>Example</b>: jmeter-server -H my.proxy.server -P 8000</p>
-<p>If you want the server to exit after a single test has been run, then define the JMeter property server.exitaftertest=true.
+<dl>
+<dh><code>-H</code></dh><dd>[proxy server hostname or ip address]</dd>
+<dh><code>-P</code></dh><dd>[proxy server port]</dd>
+</dl>
+<b>Example</b>:
+<source>jmeter-server -H my.proxy.server -P 8000</source>
+<p>If you want the server to exit after a single test has been run, then define the JMeter property <code>server.exitaftertest=true</code>.
</p>
<p>To run the test from the client in non-GUI mode, use the following command:</p>
-<pre>
+<source>
jmeter -n -t testplan.jmx -r [-Gprop=val] [-Gglobal.properties] [-X]
+</source>
where:
--G is used to define JMeter properties to be set in the servers
--X means exit the servers at the end of the test
--Rserver1,server2 - can be used instead of -r to provide a list of servers to start
- Overrides remote_hosts, but does not define the property.
-</pre>
+<dl>
+<dh><code>-G</code></dh><dd>is used to define JMeter properties to be set in the servers</dd>
+<dh><code>-X</code></dh><dd>means exit the servers at the end of the test</dd>
+<dh><code>-Rserver1,server2</code></dh><dd>can be used instead of <code>-r</code> to provide a list of servers to start.
+Overrides <code>remote_hosts</code>, but does not define the property.</dd>
+</dl>
<p>
-If the property <code>jmeterengine.remote.system.exit</code> is set to true (default is false),
-then JMeter will invoke System.exit(0) after stopping RMI at the end of a test.
+If the property <code>jmeterengine.remote.system.exit</code> is set to <code>true</code> (default is <code>false</code>),
+then JMeter will invoke <code>System.exit(0)</code> after stopping RMI at the end of a test.
Normally this is not necessary.
</p>
</subsection>
<subsection name="§-num;.4.6 Overriding Properties Via The Command Line" anchor="override">
-<p>Java system properties, JMeter properties, and logging properties can be overriden directly on the command line (instead of modifying jmeter.properties).
+<p>Java system properties, JMeter properties, and logging properties can be overriden directly on the command line
+(instead of modifying <code>jmeter.properties</code>).
To do so, use the following options:</p>
-<p>
--D[prop_name]=[value] - defines a java system property value.<br/>
--J[prop name]=[value] - defines a local JMeter property.<br/>
--G[prop name]=[value] - defines a JMeter property to be sent to all remote servers.<br/>
--G[propertyfile] - defines a file containing JMeter properties to be sent to all remote servers.<br/>
--L[category]=[priority] - overrides a logging setting, setting a particular category to the given priority level.
-</p>
-<p>The -L flag can also be used without the category name to set the root logging level.</p>
- <p><b>Examples</b>:
-<pre>
+<dl>
+<dh><code>-D[prop_name]=[value]</code></dh><dd>defines a java system property value.</dd>
+<dh><code>-J[prop_name]=[value]</code></dh><dd>defines a local JMeter property.</dd>
+<dh><code>-G[prop_name]=[value]</code></dh><dd>defines a JMeter property to be sent to all remote servers.</dd>
+<dh><code>-G[propertyfile]</code></dh><dd>defines a file containing JMeter properties to be sent to all remote servers.</dd>
+<dh><code>-L[category]=[priority]</code></dh><dd>overrides a logging setting, setting a particular category to the given priority level.</dd>
+</dl>
+<p>The <code>-L</code> flag can also be used without the category name to set the root logging level.</p>
+<p><b>Examples</b>:
+</p>
+<source>
jmeter -Duser.dir=/home/mstover/jmeter_stuff \
-Jremote_hosts=127.0.0.1 -Ljmeter.engine=DEBUG
-
-jmeter -LDEBUG</pre>
-</p>
-<p>
-<b>N.B.<br/>
+</source>
+<source>jmeter -LDEBUG</source>
+<note>
The command line properties are processed early in startup, but after the logging system has been set up.
- Attempts to use the -J flag to update log_level or log_file properties will have no effect.</b>
- </p>
+ Attempts to use the <code>-J</code> flag to update <code>log_level</code> or <code>log_file</code> properties will have no effect.
+ </note>
</subsection>
<subsection name="§-num;.4.7 Logging and error messages" anchor="logging">
<note>
@@ -404,32 +415,31 @@ jmeter -LDEBUG</pre>
running tests. Nor does it report any error for a mis-spelt variable or function; instead the
reference is just used as is. See <a href="functions.html">Functions and Variables for more information</a>.
</note>
- <p>If JMeter detects an error during a test, a message will be written to the log file.
- The log file name is defined in the jmeter.properties file (or using the -j option, see below).
- It defaults to <b>jmeter.log</b>, and will be found in the directory from which JMeter was launched.
+ <p>If JMeter detects an error during a test, a message will be written to the log file.
+ The log file name is defined in the <code>jmeter.properties</code> file (or using the <code>-j</code> option, see below).
+ It defaults to <code>jmeter.log</code>, and will be found in the directory from which JMeter was launched.
</p>
<p>
- The menu <b>Options > Log Viewer</b> displays the log file in a bottom pane on main JMeter window.
+ The menu <b>Options > Log Viewer</b> displays the log file in a bottom pane on main JMeter window.
</p>
<p>
- In the GUI mode, the number of error/fatal messages logged in the log file is displayed at top-right.
+ In the GUI mode, the number of error/fatal messages logged in the log file is displayed at top-right.
</p>
<figure image="log_errors_counter.png">Error/fatal counter</figure>
<p>
- The command-line option <i>-j jmeterlogfile</i> allow to process
+ The command-line option <code>-j jmeterlogfile</code> allow to process
after the initial properties file is read,
- and before any further properties are processed.
- It therefore allows the default of jmeter.log to be overridden.
- The jmeter scripts that take a test plan name as a parameter (e.g. jmeter-n.cmd) have been updated
+ and before any further properties are processed.
+ It therefore allows the default of <code>jmeter.log</code> to be overridden.
+ The jmeter scripts that take a test plan name as a parameter (e.g. <code>jmeter-n.cmd</code>) have been updated
to define the log file using the test plan name,
- e.g. for the test plan Test27.jmx the log file is set to Test27.log.
+ e.g. for the test plan <code>Test27.jmx</code> the log file is set to <code>Test27.log</code>.
</p>
<p>When running on Windows, the file may appear as just <b>jmeter</b> unless you have set Windows to show file extensions.
[Which you should do anyway, to make it easier to detect viruses and other nasties that pretend to be text files...]
</p>
- <p>As well as recording errors, the jmeter.log file records some information about the test run. For example:</p>
-<div overflow="scroll">
-<pre>
+ <p>As well as recording errors, the <code>jmeter.log</code> file records some information about the test run. For example:</p>
+<source>
10/17/2003 12:19:20 PM INFO - jmeter.JMeter: Version 1.9.20031002
10/17/2003 12:19:45 PM INFO - jmeter.gui.action.Load: Loading file: c:\mytestfiles\BSH.jmx
10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Running the test!
@@ -438,78 +448,78 @@ jmeter -LDEBUG</pre>
10/17/2003 12:19:52 PM INFO - jmeter.threads.JMeterThread: Thread BSH1-1 started
10/17/2003 12:19:52 PM INFO - jmeter.threads.JMeterThread: Thread BSH1-1 is done
10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Test has ended
-</pre>
-</div>
+</source>
<p>The log file can be helpful in determining the cause of an error,
as JMeter does not interrupt a test to display an error dialogue.</p>
</subsection>
<subsection name="§-num;.4.8 Full list of command-line options" anchor="options">
-<p>Invoking JMeter as "jmeter -?" will print a list of all the command-line options.
+<p>Invoking JMeter as "<code>jmeter -?</code>" will print a list of all the command-line options.
These are shown below.</p>
-<pre>
- -h, --help
- print usage information and exit
- -v, --version
- print the version information and exit
- -p, --propfile {argument}
- the jmeter property file to use
- -q, --addprop {argument}
- additional property file(s)
- -t, --testfile {argument}
- the jmeter test(.jmx) file to run
- -j, --jmeterlogfile {argument}
- the jmeter log file
- -l, --logfile {argument}
- the file to log samples to
- -n, --nongui
- run JMeter in nongui mode
- -s, --server
- run the JMeter server
- -H, --proxyHost {argument}
- Set a proxy server for JMeter to use
- -P, --proxyPort {argument}
- Set proxy server port for JMeter to use
- -u, --username {argument}
- Set username for proxy server that JMeter is to use
- -a, --password {argument}
- Set password for proxy server that JMeter is to use
- -J, --jmeterproperty {argument}={value}
- Define additional JMeter properties
- -G, --globalproperty (argument)[=(value)]
- Define Global properties (sent to servers)
- e.g. -Gport=123
- or -Gglobal.properties
- -D, --systemproperty {argument}={value}
- Define additional System properties
- -S, --systemPropertyFile {filename}
- a property file to be added as System properties
- -L, --loglevel {argument}={value}
- Define loglevel: [category=]level
- e.g. jorphan=INFO or jmeter.util=DEBUG
- -r, --runremote (non-GUI only)
- Start remote servers (as defined by the jmeter property remote_hosts)
- -R, --remotestart server1,... (non-GUI only)
- Start these remote servers (overrides remote_hosts)
- -d, --homedir {argument}
- the jmeter home directory to use
- -X, --remoteexit
- Exit the remote servers at end of test (non-GUI)
-</pre>
+<source>
+-h, --help
+ print usage information and exit
+-v, --version
+ print the version information and exit
+-p, --propfile {argument}
+ the jmeter property file to use
+-q, --addprop {argument}
+ additional property file(s)
+-t, --testfile {argument}
+ the jmeter test(.jmx) file to run
+-j, --jmeterlogfile {argument}
+ the jmeter log file
+-l, --logfile {argument}
+ the file to log samples to
+-n, --nongui
+ run JMeter in nongui mode
+-s, --server
+ run the JMeter server
+-H, --proxyHost {argument}
+ Set a proxy server for JMeter to use
+-P, --proxyPort {argument}
+ Set proxy server port for JMeter to use
+-u, --username {argument}
+ Set username for proxy server that JMeter is to use
+-a, --password {argument}
+ Set password for proxy server that JMeter is to use
+-J, --jmeterproperty {argument}={value}
+ Define additional JMeter properties
+-G, --globalproperty (argument)[=(value)]
+ Define Global properties (sent to servers)
+ e.g. -Gport=123
+ or -Gglobal.properties
+-D, --systemproperty {argument}={value}
+ Define additional System properties
+-S, --systemPropertyFile {filename}
+ a property file to be added as System properties
+-L, --loglevel {argument}={value}
+ Define loglevel: [category=]level
+ e.g. jorphan=INFO or jmeter.util=DEBUG
+-r, --runremote (non-GUI only)
+ Start remote servers (as defined by the jmeter property remote_hosts)
+-R, --remotestart server1,... (non-GUI only)
+ Start these remote servers (overrides remote_hosts)
+-d, --homedir {argument}
+ the jmeter home directory to use
+-X, --remoteexit
+ Exit the remote servers at end of test (non-GUI)
+</source>
<p>
Note: the JMeter log file name is formatted as a SimpleDateFormat (applied to the current date)
-if it contains paired single-quotes, .e.g. 'jmeter_'yyyyMMddHHmmss'.log'
+if it contains paired single-quotes, .e.g. '<code>jmeter_'yyyyMMddHHmmss'.log</code>'
</p>
<p>
-If the special name LAST is used for the -t, -j or -l flags, then JMeter takes that to mean the last test plan
+If the special name <code>LAST</code> is used for the <code>-t</code>, <code>-j</code> or <code>-l</code> flags,
+then JMeter takes that to mean the last test plan
that was run in interactive mode.
</p>
</subsection>
<subsection name="§-num;.4.9 non-GUI shutdown" anchor="shutdown">
<p>
-Prior to version 2.5.1, JMeter invoked System.exit() when a non-GUI test completed.
-This caused problems for applications that invoke JMeter directly, so JMeter no longer invokes System.exit()
-for a normal test completion. [Some fatal errors may still invoke System.exit()]
+Prior to version 2.5.1, JMeter invoked <code>System.exit()</code> when a non-GUI test completed.
+This caused problems for applications that invoke JMeter directly, so JMeter no longer invokes <code>System.exit()</code>
+for a normal test completion. [Some fatal errors may still invoke <code>System.exit()</code>]
JMeter will exit all the non-daemon threads it starts, but it is possible that some non-daemon threads
may still remain; these will prevent the JVM from exitting.
To detect this situation, JMeter starts a new daemon thread just before it exits.
@@ -518,7 +528,7 @@ JVM has not been able to exit, and the t
</p>
<p>
The property <code>jmeter.exit.check.pause</code> can be used to override the default pause of 2000ms (2secs).
-If set to 0, then JMeter does not start the daemon thread.
+If set to <code>0</code>, then JMeter does not start the daemon thread.
</p>
</subsection>
@@ -527,23 +537,23 @@ If set to 0, then JMeter does not start
<section name="§-num;.5 Configuring JMeter" anchor="configuring_jmeter">
<p>If you wish to modify the properties with which JMeter runs you need to
- either modify the user.properties in the /bin directory or create
- your own copy of the jmeter.properties and specify it in the command line.
+ either modify the <code>user.properties</code> in the <code>/bin</code> directory or create
+ your own copy of the <code>jmeter.properties</code> and specify it in the command line.
</p>
<note>
Note: You can define additional JMeter properties in the file defined by the
- JMeter property <b>user.properties</b> which has the default value <b>user.properties</b>.
+ JMeter property <code>user.properties</code> which has the default value <code>user.properties</code>.
The file will be automatically loaded if it is found in the current directory
or if it is found in the JMeter bin directory.
- Similarly, <b>system.properties</b> is used to update system properties.
+ Similarly, <code>system.properties</code> is used to update system properties.
</note>
<properties>
<property name="ssl.provider">You can specify the class for your SSL
implementation if you don't want to use the built-in Java implementation.
</property>
<property name="xml.parser">You can specify an implementation as your XML
- parser. The default value is: org.apache.xerces.parsers.SAXParser</property>
- <property name="remote_hosts">Comma-delimited list of remote JMeter hosts (or host:port if required).
+ parser. The default value is: <code>org.apache.xerces.parsers.SAXParser</code></property>
+ <property name="remote_hosts">Comma-delimited list of remote JMeter hosts (or <code>host:port</code> if required).
If you are running JMeter in a distributed environment, list the machines where
you have JMeter remote servers running. This will allow you to control those
servers from this machine's GUI</property>
@@ -553,57 +563,57 @@ If set to 0, then JMeter does not start
You may list their classname or their class label (the string that appears
in JMeter's UI) here, and they will no longer appear in the menus.</property>
<property name="search_paths">
- List of paths (separated by ;) that JMeter will search for JMeter plugin classes,
+ List of paths (separated by <code>;</code>) that JMeter will search for JMeter plugin classes,
for example additional samplers. A path item can either be a jar file or a directory.
- Any jar file in such a directory will be automatically included in search_paths,
+ Any jar file in such a directory will be automatically included in <code>search_paths</code>,
jar files in sub directories are ignored.
- The given value is in addition to any jars found in the lib/ext directory.
+ The given value is in addition to any jars found in the <code>lib/ext</code> directory.
</property>
<property name="user.classpath">
List of paths that JMeter will search for utility and plugin dependency classes.
Use your platform path separator to separate multiple paths.
A path item can either be a jar file or a directory.
- Any jar file in such a directory will be automatically included in user.classpath,
+ Any jar file in such a directory will be automatically included in <code>user.classpath</code>,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib directory.
All entries will be added to the class path of the system class loader
and also to the path of the JMeter internal loader.
</property>
<property name="plugin_dependency_paths">
- List of paths (separated by ;) that JMeter will search for utility
+ List of paths (separated by <code>;</code>) that JMeter will search for utility
and plugin dependency classes.
A path item can either be a jar file or a directory.
- Any jar file in such a directory will be automatically included in plugin_dependency_paths,
+ Any jar file in such a directory will be automatically included in <code>plugin_dependency_paths</code>,
jar files in sub directories are ignored.
- The given value is in addition to any jars found in the lib directory
- or given by the user.classpath property.
+ The given value is in addition to any jars found in the <code>lib</code> directory
+ or given by the <code>user.classpath</code> property.
All entries will be added to the path of the JMeter internal loader only.
- For plugin dependencies using plugin_dependency_paths should be preferred over
- user.classpath.
+ For plugin dependencies using <code>plugin_dependency_paths</code> should be preferred over
+ <code>user.classpath</code>.
</property>
<property name="user.properties">
- Name of file containing additional JMeter properties.
- These are added after the initial property file, but before the -q and -J options are processed.
+ Name of file containing additional JMeter properties.
+ These are added after the initial property file, but before the <code>-q</code> and <code>-J</code> options are processed.
</property>
<property name="system.properties">
Name of file containing additional system properties.
- These are added before the -S and -D options are processed.
+ These are added before the <code>-S</code> and <code>-D</code> options are processed.
</property>
</properties>
<p>
The command line options and properties files are processed in the following order:
- <ul>
- <li>-p propfile</li>
- <li>jmeter.properties (or the file from the -p option) is then loaded</li>
- <li>-j logfile</li>
+ <ol>
+ <li><code>-p propfile</code></li>
+ <li><code>jmeter.properties</code> (or the file from the <code>-p</code> option) is then loaded</li>
+ <li><code>-j logfile</code></li>
<li>Logging is initialised</li>
- <li>user.properties is loaded</li>
- <li>system.properties is loaded</li>
+ <li><code>user.properties</code> is loaded</li>
+ <li><code>system.properties</code> is loaded</li>
<li>all other command-line options are processed</li>
- </ul>
+ </ol>
</p>
<p><b>
-See also the comments in the jmeter.properties, user.properties and system.properties files for further information on other settings you can change.
+See also the comments in the <code>jmeter.properties</code>, <code>user.properties</code> and <code>system.properties</code> files for further information on other settings you can change.
</b></p>
</section>