Modified: jmeter/trunk/docs/usermanual/get-started.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/get-started.html?rev=1739469&r1=1739468&r2=1739469&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/get-started.html (original) +++ jmeter/trunk/docs/usermanual/get-started.html Sat Apr 16 14:36:00 2016 @@ -1,23 +1,12 @@ <!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 - - User's Manual: Getting Started</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 rel="stylesheet" type="text/css" href="../css/new-style.css"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!-- + User's Manual: Getting Started</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 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" width="290" height="75" src="../images/asf-logo.png" alt="Logo ASF"></a></div><!-- + --><div><a href="http://www.apache.org";><img title="Apache Software Foundation" class="logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!-- PROJECT LOGO - --><div><a href="http://jmeter.apache.org/";><img src="../images/logo.jpg" alt="Apache JMeter"></a></div><div class="twitter"><div><a href="https://twitter.com/share"; class="twitter-share-button" data-text="Powerful Load Testing with Apache #JMeter" data-via="ApacheJMeter" data-lang="en-gb" data-size="large">Tweet</a><script> - (function(d,s,id){ - var js, - fjs=d.getElementsByTagName(s)[0], - p=/^http:/.test(d.location)?'http':'https'; - if (!d.getElementById(id)) { - js=d.createElement(s); - js.id=id; - js.src=p+'://platform.twitter.com/widgets.js'; - fjs.parentNode.insertBefore(js,fjs); - } - })(document, 'script', 'twitter-wjs'); - </script></div><div><a href="https://twitter.com/ApacheJMeter"; class="twitter-follow-button" data-show-count="false" data-lang="en-gb" data-size="large">Follow</a><script>(function(d,s,id){ + --><div><a href="http://jmeter.apache.org/";><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html"; style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><div class="social menu"><div><a href="https://twitter.com/share"; class="twitter-share-button" data-text="Powerful Load Testing with Apache #JMeter" data-via="ApacheJMeter" data-lang="en-gb" data-size="large">Tweet</a><script> + (function(d,s,id){ var js, fjs=d.getElementsByTagName(s)[0], p=/^http:/.test(d.location)?'http':'https'; @@ -27,8 +16,19 @@ js.src=p+'://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js,fjs); } - })(document, 'script', 'twitter-wjs'); - </script></div></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html"; style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://twitter.com/ApacheJMeter";>JMeter on Twitter<img src="../images/twitter.png" alt="Icon for JMeter on Twitter"></a></li><li><a href="../issues.html">Issue Tracking</a></li><li><a href="http://projects.apache.org/feeds/rss/jmeter.xml";>Subscribe to What's New</a></li><li><a href="http://www.apache.org/licenses/";>License</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../nightly.html">Developer (Nightly) Builds</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Documentation</div><ul><li><a href="../changes.html" >Changes per version</a></li><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="../api/index.html">Javadocs</a></li><li><a >href="../building.html">Building JMeter and Add-Ons</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><div >class="menu-title">Tutorials (PDF format)</div><ul><li><a >href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed >Testing</a></li><li><a >href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording >Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit >Sampler</a></li><li><a href="../us ermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Community</div><ul><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters";>Contributors</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">SVN Repositories</a></li></ul></li></ul><ul class="menu"><li><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"><ul class="pagelinks"><li><a href="intro.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Nex t ></a></li></ul><div class="section"><h1 id="get_started">2. Getting Started<a class="sectionlink" href="#get_started" title="Link to here">¶</a></h1> + })(document, 'script', 'twitter-wjs'); + </script></div><div><a href="https://twitter.com/ApacheJMeter"; class="twitter-follow-button" data-show-count="false" data-lang="en-gb" data-size="large">Follow</a><script>(function(d,s,id){ + var js, + fjs=d.getElementsByTagName(s)[0], + p=/^http:/.test(d.location)?'http':'https'; + if (!d.getElementById(id)) { + js=d.createElement(s); + js.id=id; + js.src=p+'://platform.twitter.com/widgets.js'; + fjs.parentNode.insertBefore(js,fjs); + } + })(document, 'script', 'twitter-wjs'); + </script></div><div><a href="https://github.com/apache/jmeter";><img alt="star this repo" src="http://githubbadges.com/star.svg?user=apache&repo=jmeter&style=default";></a></div><div><a href="https://github.com/apache/jmeter/fork";><img alt="fork this repo" src="http://githubbadges.com/fork.svg?user=apache&repo=jmeter&style=default";></a></div><div><a href="https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter";><img alt="Maven Central" src="https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter/badge.png";></a></div></div><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="../nightly.html">Developer (Nightly) Builds</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../changes.html">Changes per version</a></li><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="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</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 (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a ></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording >Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit >Sampler</a></li><li><a >href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log >Sampler</a></li><li><a href="../extending/jmeter_tutorial.pdf">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"><ul class="pagelinks"><li><a href="intro.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul><div class="section"><h1 id="get_started">2. Getting Started<a class="sectionlink" href="#get_started" title="Link to here">¶</a></h1> <p>The easiest way to begin using JMeter is to first <a href="http://jmeter.apache.org/download_jmeter.cgi";>download the latest production release</a> and install it. The release contains all of the files you need to build and run most types of tests, @@ -67,14 +67,14 @@ over your Test Plans.</p> </div><div class="section"><h1 id="requirements">2.1 Requirements<a class="sectionlink" href="#requirements" title="Link to here">¶</a></h1> <p>JMeter requires that your computing environment meets some minimum requirements.</p> -<div class="subsection"><h2>2.1.1 Java Version<a class="sectionlink" href="#java_versions" title="Link to here">¶</a></h2> -<div class="clear"></div><div class="note">JMeter requires a fully compliant JVM 6 or higher. +<div class="subsection"><h2 id="java_versions">2.1.1 Java Version<a class="sectionlink" href="#java_versions" title="Link to here">¶</a></h2> +<div class="clear"></div><div class="note">JMeter requires a fully compliant JVM 7 or higher. </div><div class="clear"></div> <p>Because JMeter uses only standard Java APIs, please do not file bug reports if your JRE fails to run JMeter because of JRE implementation issues.</p> </div> -<div class="subsection"><h2>2.1.2 Operating Systems<a class="sectionlink" href="#os" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="os">2.1.2 Operating Systems<a class="sectionlink" href="#os" title="Link to here">¶</a></h2> <p>JMeter is a 100% Java application and should run correctly on any system that has a compliant Java implementation.</p> <p>Operating systems tested with JMeter can be viewed on @@ -86,33 +86,33 @@ on JMeter wiki.</p> <p>If you plan on doing JMeter development, then you will need one or more optional packages listed below.</p> -<div class="subsection"><h2>2.2.1 Java Compiler<a class="sectionlink" href="#opt_compiler" title="Link to here">¶</a></h2> -<p>If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK 6 or higher.</p> +<div class="subsection"><h2 id="opt_compiler">2.2.1 Java Compiler<a class="sectionlink" href="#opt_compiler" title="Link to here">¶</a></h2> +<p>If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK 7 or higher.</p> </div> -<div class="subsection"><h2>2.2.2 SAX XML Parser<a class="sectionlink" href="#opt_sax" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="opt_sax">2.2.2 SAX XML Parser<a class="sectionlink" href="#opt_sax" title="Link to here">¶</a></h2> <p>JMeter comes with Apache's <a href="http://xml.apache.org/";>Xerces XML parser</a>. You have the option of telling JMeter to use a different XML parser. To do so, include the classes for the third-party parser in JMeter's <a href="#classpath">classpath</a>, and update the <a href="#configuring_jmeter">jmeter.properties</a> file with the full classname of the parser implementation.</p> </div> -<div class="subsection"><h2>2.2.3 Email Support<a class="sectionlink" href="#opt_email" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="opt_email">2.2.3 Email Support<a class="sectionlink" href="#opt_email" title="Link to here">¶</a></h2> <p>JMeter has extensive Email capabilities. It can send email based on test results, and has a POP3(S)/IMAP(S) sampler. It also has an SMTP(S) sampler. </p> </div> -<div class="subsection"><h2>2.2.4 SSL Encryption<a class="sectionlink" href="#opt_ssl" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="opt_ssl">2.2.4 SSL Encryption<a class="sectionlink" href="#opt_ssl" title="Link to here">¶</a></h2> <p>To test a web server using SSL encryption (HTTPS), JMeter requires that an 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"><span class="code">system.properties</span></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. +JMeter HTTP defaults to protocol level TLS. This can be changed by editing the JMeter property +<span class="code">https.default.protocol</span> in <span class="code">jmeter.properties</span> or <span class="code">user.properties</span>. </p> <p><b>The JMeter HTTP samplers are configured to accept all certificates, whether trusted or not, regardless of validity periods, etc.</b> @@ -125,26 +125,26 @@ The SMTP sampler can optionally use a lo </p> </div> -<div class="subsection"><h2>2.2.5 JDBC Driver<a class="sectionlink" href="#opt_jdbc" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="opt_jdbc">2.2.5 JDBC Driver<a class="sectionlink" href="#opt_jdbc" title="Link to here">¶</a></h2> <p>You will need to add your database vendor's JDBC driver to the <a href="#classpath">classpath</a> if you want to do JDBC testing. Make sure the file is a jar file, not a zip. </p> </div> -<div class="subsection"><h2>2.2.6 JMS client<a class="sectionlink" href="#opt_jms" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="opt_jms">2.2.6 JMS client<a class="sectionlink" href="#opt_jms" title="Link to here">¶</a></h2> <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> </div> -<div class="subsection"><h2>2.2.7 Libraries for ActiveMQ JMS<a class="sectionlink" href="#libraries_activemq" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="libraries_activemq">2.2.7 Libraries for ActiveMQ JMS<a class="sectionlink" href="#libraries_activemq" title="Link to here">¶</a></h2> <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 <span class="code">activemq-all-X.X.X.jar</span> to your classpath, e.g. by storing it in the <span class="code">lib/</span> 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> @@ -160,13 +160,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 <span class="code">JAVA_HOME</span> environment variable set, there is nothing more for you to do.</p> +<div class="clear"></div><div class="note"> +There can be problems (especially with client-server mode) if the directory path contains any spaces. +</div><div class="clear"></div> <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 <span class="code">X.Y</span> is version number): +<pre class="source"> apache-jmeter-X.Y apache-jmeter-X.Y/bin apache-jmeter-X.Y/docs @@ -177,97 +177,100 @@ 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. +You can rename the parent directory (i.e. <span class="code">apache-jmeter-X.Y</span>) if you want, but do not change any of the sub-directory names. </p> </div><div class="section"><h1 id="running">2.4 Running JMeter<a class="sectionlink" href="#running" title="Link to here">¶</a></h1> <br> -<p>To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file. +<p>To run JMeter, run the <span class="code">jmeter.bat</span> (for Windows) or <span class="code">jmeter</span> (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><span class="code">jmeter.bat</span></dt><dd>run JMeter (in GUI mode by default)</dd> +<dt><span class="code">jmeterw.cmd</span></dt><dd>run JMeter without the windows shell console (in GUI mode by default)</dd> +<dt><span class="code">jmeter-n.cmd</span></dt><dd>drop a JMX file on this to run a non-GUI test</dd> +<dt><span class="code">jmeter-n-r.cmd</span></dt><dd>drop a JMX file on this to run a non-GUI test remotely</dd> +<dt><span class="code">jmeter-t.cmd</span></dt><dd>drop a JMX file on this to load it in GUI mode</dd> +<dt><span class="code">jmeter-server.bat</span></dt><dd>start JMeter in server mode</dd> +<dt><span class="code">mirror-server.cmd</span></dt><dd>runs the JMeter Mirror Server in non-GUI mode</dd> +<dt><span class="code">shutdown.cmd</span></dt><dd>Run the Shutdown client to stop a non-GUI instance gracefully</dd> +<dt><span class="code">stoptest.cmd</span></dt><dd>Run the Shutdown client to stop a non-GUI instance abruptly</dd> +</dl> +<div class="clear"></div><div class="note">The special name <span class="code">LAST</span> can be used with <span class="code">jmeter-n.cmd</span>, <span class="code">jmeter-t.cmd</span> and <span class="code">jmeter-n-r.cmd</span> +and means the last test plan that was run interactively.</div><div class="clear"></div> <p> -The environment variable JVM_ARGS can be used to override JVM settings in the jmeter.bat script. +The environment variable <span class="code">JVM_ARGS</span> can be used to override JVM settings in the <span class="code">jmeter.bat</span> script. For example: -<pre> +</p> +<pre class="source"> set JVM_ARGS="-Xms1024m -Xmx1024m -Dpropname=propvalue" -jmeter -t test.jmx ... +jmeter -t test.jmx … </pre> -</p> <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><span class="code">jmeter</span></dt><dd>run JMeter (in GUI mode by default). Defines some JVM settings which may not work for all JVMs.</dd> +<dt><span class="code">jmeter-server</span></dt><dd>start JMeter in server mode (calls jmeter script with appropriate parameters)</dd> +<dt><span class="code">jmeter.sh</span></dt><dd>very basic JMeter script (You may need to adapt JVM options like memory settings).</dd> +<dt><span class="code">mirror-server.sh</span></dt><dd>runs the JMeter Mirror Server in non-GUI mode</dd> +<dt><span class="code">shutdown.sh</span></dt><dd>Run the Shutdown client to stop a non-GUI instance gracefully</dd> +<dt><span class="code">stoptest.sh</span></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 <span class="code">JVM_ARGS</span> environment variable can be used to override or set additional JVM options, for example: +</p> +<pre class="source"> JVM_ARGS="-Xms1024m -Xmx1024m" jmeter -t test.jmx [etc.] </pre> will override the HEAP settings in the script. -</p> -<div class="subsection"><h2>2.4.1 JMeter's Classpath<a class="sectionlink" href="#classpath" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="classpath">2.4.1 JMeter's Classpath<a class="sectionlink" href="#classpath" title="Link to here">¶</a></h2> <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><span class="code">JMETER_HOME/lib</span></dt><dd>used for utility jars</dd> +<dt><span class="code">JMETER_HOME/lib/ext</span></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 <span class="code">lib/ext</span> 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 <span class="code">lib/ext</span> 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 <span class="code">lib/ext</span> directory, +then define the property <span class="code">search_paths</span> in <span class="code">jmeter.properties</span>. </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> -<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. -[This occurs with all Java programs, not just JMeter.]</p> +<p>Utility and dependency jars (libraries etc) can be placed in the <span class="code">lib</span> directory.</p> +<p>If you don't want to put such jars in the <span class="code">lib</span> directory, +then define the property <span class="code">user.classpath</span> or <span class="code">plugin_dependency_paths</span> +in <span class="code">jmeter.properties</span>. See below for an explanation of the differences. +</p> +<p> +Other jars (such as JDBC, JMS implementations and any other support libraries needed by the JMeter code) +should be placed in the <span class="code">lib</span> directory - not the <span class="code">lib/ext</span> directory, +or added to <span class="code">user.classpath</span>.</p> +<div class="clear"></div><div class="note">JMeter will only find <span class="code">.jar</span> files, not <span class="code">.zip</span>.</div><div class="clear"></div> +<p>You can also install utility Jar files in <span class="code">$JAVA_HOME/jre/lib/ext</span>, or you can set the +property <span class="code">user.classpath</span> in <span class="code">jmeter.properties</span></p> +<p>Note that setting the <span class="code">CLASSPATH</span> environment variable will have no effect. +This is because JMeter is started with "<span class="code">java -jar</span>", +and the java command silently ignores the <span class="code">CLASSPATH</span> variable, and the <span class="code">-classpath</span>/<span class="code">-cp</span> +options when <span class="code">-jar</span> is used.</p> +<div class="clear"></div><div class="note">This occurs with all Java programs, not just JMeter.</div><div class="clear"></div> </div> -<div class="subsection"><h2>2.4.2 Create Test Plan from Template<a class="sectionlink" href="#template" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="template">2.4.2 Create Test Plan from Template<a class="sectionlink" href="#template" title="Link to here">¶</a></h2> <p>You have the ability to create a new Test Plan from existing template.</p> -<p>To do so you use the menu <b>File</b> > <b>Templates...</b> or Templates icon: +<p>To do so you use the menu +<span class="menuchoice"><span class="guimenuitem">File</span> → <span class="guimenuitem">Templates…</span></span> or Templates icon: <figure><a href="../images/screenshots/template_menu.png"><img src="../images/screenshots/template_menu.png" width="" height="" alt="Templates icon item"></a><figcaption>Templates icon item</figcaption></figure> </p> <p>A popup appears, you can then choose a template among the list: @@ -276,37 +279,40 @@ and the java command silently ignores th <p>A documentation for each template explains what to do once test plan is created from template.</p> </div> -<div class="subsection"><h2>2.4.3 Using JMeter behing a proxy<a class="sectionlink" href="#proxy_server" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="proxy_server">2.4.3 Using JMeter behind a proxy<a class="sectionlink" href="#proxy_server" title="Link to here">¶</a></h2> <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 <span class="code">jmeter[.bat]</span> 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> +<dt><span class="code">-H</span></dt><dd>[proxy server hostname or ip address]</dd> +<dt><span class="code">-P</span></dt><dd>[proxy server port]</dd> +<dt><span class="code">-N</span></dt><dd>[nonproxy hosts] (e.g. <span class="code">*.apache.org|localhost</span>)</dd> +<dt><span class="code">-u</span></dt><dd>[username for proxy authentication - if required]</dd> +<dt><span class="code">-a</span></dt><dd>[password for proxy authentication - if required]</dd> +</dl> +<b>Example</b>: +<pre class="source">jmeter -H my.proxy.server -P 8000 -u username -a password -N localhost</pre> +<p>You can also use <span class="code">--proxyHost</span>, <span class="code">--proxyPort</span>, <span class="code">--username</span>, and <span class="code">--password</span> as parameter names</p> <div class="clear"></div><div class="note"> Parameters provided on a command-line may be visible to other users on the system. </div><div class="clear"></div> <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><span class="code">http.proxyHost</span></li> +<li><span class="code">http.proxyPort</span></li> +<li><span class="code">https.proxyHost</span></li> +<li><span class="code">https.proxyPort</span></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><span class="code">http.nonProxyHosts</span></li> +<li><span class="code">https.nonProxyHosts</span></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 <span class="code">system.properties</span> instead of using the command-line parameters. </p> <p> Proxy Settings can also be defined in a Test Plan, using either the <a href="../usermanual/component_reference.html#HTTP_Request_Defaults">HTTP Request Defaults</a> @@ -317,112 +323,121 @@ This is only used for recording HTTP or This is not to be confused with the proxy settings described above, which are used when JMeter makes HTTP or HTTPS requests itself.</div><div class="clear"></div> </div> -<div class="subsection"><h2>2.4.4 Non-GUI Mode (Command Line mode)<a class="sectionlink" href="#non_gui" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="non_gui">2.4.4 Non-GUI Mode (Command Line mode)<a class="sectionlink" href="#non_gui" title="Link to here">¶</a></h2> <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> +<dt><span class="code">-n</span></dt><dd>This specifies JMeter is to run in non-gui mode</dd> +<dt><span class="code">-t</span></dt><dd>[name of JMX file that contains the Test Plan].</dd> +<dt><span class="code">-l</span></dt><dd>[name of JTL file to log sample results to].</dd> +<dt><span class="code">-j</span></dt><dd>[name of JMeter run log file].</dd> +<dt><span class="code">-r</span></dt><dd>Run the test in the servers specified by the JMeter property "<span class="code">remote_hosts</span>"</dd> +<dt><span class="code">-R</span></dt><dd>[list of remote servers] Run the test in the specified remote servers</dd> +<dt><span class="code">-g</span></dt><dd>[path to CSV file] generate report dashboard only</dd> +<dt><span class="code">-e</span></dt><dd>generate report dashboard after load test</dd> +<dt><span class="code">-o</span></dt><dd>output folder where to generate the report dashboard after load test. Folder must not exist or be empty</dd> +</dl> <p>The script also lets you specify the optional firewall/proxy server information:</p> +<dl> +<dt><span class="code">-H</span></dt><dd>[proxy server hostname or ip address]</dd> +<dt><span class="code">-P</span></dt><dd>[proxy server port]</dd> +</dl> +<b>Example</b> +<pre class="source">jmeter -n -t my_test.jmx -l log.jtl -H my.proxy.server -P 8000</pre> <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 <span class="code">jmeterengine.stopfail.system.exit</span> is set to true (default is false), -then JMeter will invoke System.exit(1) if it cannot stop all threads. +If the property <span class="code">jmeterengine.stopfail.system.exit</span> is set to <span class="code">true</span> (default is <span class="code">false</span>), +then JMeter will invoke <span class="code">System.exit(1)</span> if it cannot stop all threads. Normally this is not necessary. </p> </div> -<div class="subsection"><h2>2.4.5 Server Mode<a class="sectionlink" href="#server" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="server">2.4.5 Server Mode<a class="sectionlink" href="#server" title="Link to here">¶</a></h2> <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 <span class="code">jmeter-server[.bat]</span> 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> +<dt><span class="code">-H</span></dt><dd>[proxy server hostname or ip address]</dd> +<dt><span class="code">-P</span></dt><dd>[proxy server port]</dd> +</dl> +<b>Example</b>: +<pre class="source">jmeter-server -H my.proxy.server -P 8000</pre> +<p>If you want the server to exit after a single test has been run, then define the JMeter property <span class="code">server.exitaftertest=true</span>. </p> <p>To run the test from the client in non-GUI mode, use the following command:</p> -<pre> +<pre class="source"> jmeter -n -t testplan.jmx -r [-Gprop=val] [-Gglobal.properties] [-X] -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> +where: +<dl> +<dt><span class="code">-G</span></dt><dd>is used to define JMeter properties to be set in the servers</dd> +<dt><span class="code">-X</span></dt><dd>means exit the servers at the end of the test</dd> +<dt><span class="code">-Rserver1,server2</span></dt><dd>can be used instead of <span class="code">-r</span> to provide a list of servers to start. +Overrides <span class="code">remote_hosts</span>, but does not define the property.</dd> +</dl> <p> -If the property <span class="code">jmeterengine.remote.system.exit</span> 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 <span class="code">jmeterengine.remote.system.exit</span> is set to <span class="code">true</span> (default is <span class="code">false</span>), +then JMeter will invoke <span class="code">System.exit(0)</span> after stopping RMI at the end of a test. Normally this is not necessary. </p> </div> -<div class="subsection"><h2>2.4.6 Overriding Properties Via The Command Line<a class="sectionlink" href="#override" title="Link to here">¶</a></h2> -<p>Java system properties, JMeter properties, and logging properties can be overriden directly on the command line (instead of modifying jmeter.properties). +<div class="subsection"><h2 id="override">2.4.6 Overriding Properties Via The Command Line<a class="sectionlink" href="#override" title="Link to here">¶</a></h2> +<p>Java system properties, JMeter properties, and logging properties can be overridden directly on the command line +(instead of modifying <span class="code">jmeter.properties</span>). 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> +<dt><span class="code">-D[prop_name]=[value]</span></dt><dd>defines a java system property value.</dd> +<dt><span class="code">-J[prop_name]=[value]</span></dt><dd>defines a local JMeter property.</dd> +<dt><span class="code">-G[prop_name]=[value]</span></dt><dd>defines a JMeter property to be sent to all remote servers.</dd> +<dt><span class="code">-G[propertyfile]</span></dt><dd>defines a file containing JMeter properties to be sent to all remote servers.</dd> +<dt><span class="code">-L[category]=[priority]</span></dt><dd>overrides a logging setting, setting a particular category to the given priority level.</dd> +</dl> +<p>The <span class="code">-L</span> flag can also be used without the category name to set the root logging level.</p> +<p><b>Examples</b>: +</p> +<pre class="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> +</pre> +<pre class="source">jmeter -LDEBUG</pre> +<div class="clear"></div><div class="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 <span class="code">-J</span> flag to update <span class="code">log_level</span> or <span class="code">log_file</span> properties will have no effect. + </div><div class="clear"></div> </div> -<div class="subsection"><h2>2.4.7 Logging and error messages<a class="sectionlink" href="#logging" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="logging">2.4.7 Logging and error messages<a class="sectionlink" href="#logging" title="Link to here">¶</a></h2> <div class="clear"></div><div class="note"> JMeter does not generally use pop-up dialog boxes for errors, as these would interfere with 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>. </div><div class="clear"></div> - <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 <span class="code">jmeter.properties</span> file (or using the <span class="code">-j</span> option, see below). + It defaults to <span class="code">jmeter.log</span>, 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 <span class="menuchoice"><span class="guimenuitem">Options</span> → <span class="guimenuitem">Log Viewer</span></span> + 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><a href="../images/screenshots/log_errors_counter.png"><img src="../images/screenshots/log_errors_counter.png" width="" height="" alt="Error/fatal counter"></a><figcaption>Error/fatal counter</figcaption></figure> <p> - The command-line option <i>-j jmeterlogfile</i> allow to process + The command-line option <span class="code">-j jmeterlogfile</span> 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 <span class="code">jmeter.log</span> to be overridden. + The jmeter scripts that take a test plan name as a parameter (e.g. <span class="code">jmeter-n.cmd</span>) 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 <span class="code">Test27.jmx</span> the log file is set to <span class="code">Test27.log</span>. </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...] + [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 <span class="code">jmeter.log</span> file records some information about the test run. For example:</p> +<pre class="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! @@ -432,100 +447,107 @@ jmeter -LDEBUG</pre> 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> <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> </div> -<div class="subsection"><h2>2.4.8 Full list of command-line options<a class="sectionlink" href="#options" title="Link to here">¶</a></h2> -<p>Invoking JMeter as "jmeter -?" will print a list of all the command-line options. +<div class="subsection"><h2 id="options">2.4.8 Full list of command-line options<a class="sectionlink" href="#options" title="Link to here">¶</a></h2> +<p>Invoking JMeter as "<span class="code">jmeter -?</span>" 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 class="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 JMeter property file(s) + -t, --testfile <argument> + the jmeter test(.jmx) file to run + -l, --logfile <argument> + the file to log samples to + -j, --jmeterlogfile <argument> + jmeter run log file (jmeter.log) + -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 + -N, --nonProxyHosts <argument> + Set nonproxy host list (e.g. *.apache.org|localhost) + -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 <argument> + additional system property file(s) + -L, --loglevel <argument>=<value> + [category=]level e.g. jorphan=INFO or jmeter.util=DEBUG + -r, --runremote + Start remote servers (as defined in remote_hosts) + -R, --remotestart <argument> + 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) + -g, --reportonly <argument> + generate report dashboard only + -e, --reportatendofloadtests + generate report dashboard after load test + -o, --reportoutputfolder + output folder for report dashboard </pre> <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. '<span class="code">jmeter_'yyyyMMddHHmmss'.log</span>' </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 <span class="code">LAST</span> is used for the <span class="code">-t</span>, <span class="code">-j</span> or <span class="code">-l</span> flags, +then JMeter takes that to mean the last test plan that was run in interactive mode. </p> </div> -<div class="subsection"><h2>2.4.9 non-GUI shutdown<a class="sectionlink" href="#shutdown" title="Link to here">¶</a></h2> +<div class="subsection"><h2 id="shutdown">2.4.9 non-GUI shutdown<a class="sectionlink" href="#shutdown" title="Link to here">¶</a></h2> <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 <span class="code">System.exit()</span> when a non-GUI test completed. +This caused problems for applications that invoke JMeter directly, so JMeter no longer invokes <span class="code">System.exit()</span> +for a normal test completion. [Some fatal errors may still invoke <span class="code">System.exit()</span>] 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. +may still remain; these will prevent the JVM from exiting. To detect this situation, JMeter starts a new daemon thread just before it exits. This daemon thread waits a short while; if it returns from the wait, then clearly the JVM has not been able to exit, and the thread prints a message to say why. </p> <p> The property <span class="code">jmeter.exit.check.pause</span> 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 <span class="code">0</span>, then JMeter does not start the daemon thread. </p> </div> </div><div class="section"><h1 id="configuring_jmeter">2.5 Configuring JMeter<a class="sectionlink" href="#configuring_jmeter" title="Link to here">¶</a></h1> <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 <span class="code">user.properties</span> in the <span class="code">/bin</span> directory or create + your own copy of the <span class="code">jmeter.properties</span> and specify it in the command line. </p> <div class="clear"></div><div class="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 <span class="code">user.properties</span> which has the default value <span class="code">user.properties</span>. 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, <span class="code">system.properties</span> is used to update system properties. </div><div class="clear"></div> <div class="properties"><h3> Parameters @@ -536,10 +558,10 @@ If set to 0, then JMeter does not start No </div></div> <div class="property"><div class="name req-true">xml.parser</div><div class="description req-true">You can specify an implementation as your XML - parser. The default value is: org.apache.xerces.parsers.SAXParser</div><div class="required req-true"> + parser. The default value is: <span class="code">org.apache.xerces.parsers.SAXParser</span></div><div class="required req-true"> No </div></div> - <div class="property"><div class="name req-true">remote_hosts</div><div class="description req-true">Comma-delimited list of remote JMeter hosts (or host:port if required). + <div class="property"><div class="name req-true">remote_hosts</div><div class="description req-true">Comma-delimited list of remote JMeter hosts (or <span class="code">host:port</span> 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</div><div class="required req-true"> @@ -553,11 +575,11 @@ If set to 0, then JMeter does not start No </div></div> <div class="property"><div class="name req-true">search_paths</div><div class="description req-true"> - List of paths (separated by ;) that JMeter will search for JMeter plugin classes, + List of paths (separated by <span class="code">;</span>) 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 <span class="code">search_paths</span>, 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 <span class="code">lib/ext</span> directory. </div><div class="required req-true"> No </div></div> @@ -565,7 +587,7 @@ If set to 0, then JMeter does not start 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 <span class="code">user.classpath</span>, 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 @@ -574,51 +596,51 @@ If set to 0, then JMeter does not start No </div></div> <div class="property"><div class="name req-true">plugin_dependency_paths</div><div class="description req-true"> - List of paths (separated by ;) that JMeter will search for utility + List of paths (separated by <span class="code">;</span>) 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 <span class="code">plugin_dependency_paths</span>, 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 <span class="code">lib</span> directory + or given by the <span class="code">user.classpath</span> 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 <span class="code">plugin_dependency_paths</span> should be preferred over + <span class="code">user.classpath</span>. </div><div class="required req-true"> No </div></div> <div class="property"><div class="name req-true">user.properties</div><div class="description req-true"> - 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 <span class="code">-q</span> and <span class="code">-J</span> options are processed. </div><div class="required req-true"> No </div></div> <div class="property"><div class="name req-true">system.properties</div><div class="description req-true"> Name of file containing additional system properties. - These are added before the -S and -D options are processed. + These are added before the <span class="code">-S</span> and <span class="code">-D</span> options are processed. </div><div class="required req-true"> No </div></div> </div> <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><span class="code">-p propfile</span></li> + <li><span class="code">jmeter.properties</span> (or the file from the <span class="code">-p</span> option) is then loaded</li> + <li><span class="code">-j logfile</span></li> <li>Logging is initialised</li> - <li>user.properties is loaded</li> - <li>system.properties is loaded</li> + <li><span class="code">user.properties</span> is loaded</li> + <li><span class="code">system.properties</span> 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 <span class="code">jmeter.properties</span>, <span class="code">user.properties</span> and <span class="code">system.properties</span> files for further information on other settings you can change. </b></p> </div><ul class="pagelinks"><li><a href="intro.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul></div><div class="footer"><div class="copyright"> Copyright © 1999 – - 2015 + 2016 , Apache Software Foundation </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache feather, and the Apache JMeter logo are
Modified: jmeter/trunk/docs/usermanual/glossary.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/glossary.html?rev=1739469&r1=1739468&r2=1739469&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/glossary.html (original) +++ jmeter/trunk/docs/usermanual/glossary.html Sat Apr 16 14:36:00 2016 @@ -1,23 +1,12 @@ <!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 - - User's Manual: Glossary</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 rel="stylesheet" type="text/css" href="../css/new-style.css"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!-- + User's Manual: Glossary</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 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" width="290" height="75" src="../images/asf-logo.png" alt="Logo ASF"></a></div><!-- + --><div><a href="http://www.apache.org";><img title="Apache Software Foundation" class="logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!-- PROJECT LOGO - --><div><a href="http://jmeter.apache.org/";><img src="../images/logo.jpg" alt="Apache JMeter"></a></div><div class="twitter"><div><a href="https://twitter.com/share"; class="twitter-share-button" data-text="Powerful Load Testing with Apache #JMeter" data-via="ApacheJMeter" data-lang="en-gb" data-size="large">Tweet</a><script> - (function(d,s,id){ - var js, - fjs=d.getElementsByTagName(s)[0], - p=/^http:/.test(d.location)?'http':'https'; - if (!d.getElementById(id)) { - js=d.createElement(s); - js.id=id; - js.src=p+'://platform.twitter.com/widgets.js'; - fjs.parentNode.insertBefore(js,fjs); - } - })(document, 'script', 'twitter-wjs'); - </script></div><div><a href="https://twitter.com/ApacheJMeter"; class="twitter-follow-button" data-show-count="false" data-lang="en-gb" data-size="large">Follow</a><script>(function(d,s,id){ + --><div><a href="http://jmeter.apache.org/";><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html"; style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><div class="social menu"><div><a href="https://twitter.com/share"; class="twitter-share-button" data-text="Powerful Load Testing with Apache #JMeter" data-via="ApacheJMeter" data-lang="en-gb" data-size="large">Tweet</a><script> + (function(d,s,id){ var js, fjs=d.getElementsByTagName(s)[0], p=/^http:/.test(d.location)?'http':'https'; @@ -27,8 +16,19 @@ js.src=p+'://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js,fjs); } - })(document, 'script', 'twitter-wjs'); - </script></div></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html"; style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://twitter.com/ApacheJMeter";>JMeter on Twitter<img src="../images/twitter.png" alt="Icon for JMeter on Twitter"></a></li><li><a href="../issues.html">Issue Tracking</a></li><li><a href="http://projects.apache.org/feeds/rss/jmeter.xml";>Subscribe to What's New</a></li><li><a href="http://www.apache.org/licenses/";>License</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../nightly.html">Developer (Nightly) Builds</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Documentation</div><ul><li><a href="../changes.html" >Changes per version</a></li><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="../api/index.html">Javadocs</a></li><li><a >href="../building.html">Building JMeter and Add-Ons</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><div >class="menu-title">Tutorials (PDF format)</div><ul><li><a >href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed >Testing</a></li><li><a >href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording >Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit >Sampler</a></li><li><a href="../us ermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Community</div><ul><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters";>Contributors</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">SVN Repositories</a></li></ul></li></ul><ul class="menu"><li><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"><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="section"><h1 id="glossary">22. Glossary<a class="sectionlink" href="#glossary" title="Link to here">¶</a></h1> + })(document, 'script', 'twitter-wjs'); + </script></div><div><a href="https://twitter.com/ApacheJMeter"; class="twitter-follow-button" data-show-count="false" data-lang="en-gb" data-size="large">Follow</a><script>(function(d,s,id){ + var js, + fjs=d.getElementsByTagName(s)[0], + p=/^http:/.test(d.location)?'http':'https'; + if (!d.getElementById(id)) { + js=d.createElement(s); + js.id=id; + js.src=p+'://platform.twitter.com/widgets.js'; + fjs.parentNode.insertBefore(js,fjs); + } + })(document, 'script', 'twitter-wjs'); + </script></div><div><a href="https://github.com/apache/jmeter";><img alt="star this repo" src="http://githubbadges.com/star.svg?user=apache&repo=jmeter&style=default";></a></div><div><a href="https://github.com/apache/jmeter/fork";><img alt="fork this repo" src="http://githubbadges.com/fork.svg?user=apache&repo=jmeter&style=default";></a></div><div><a href="https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter";><img alt="Maven Central" src="https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter/badge.png";></a></div></div><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="../nightly.html">Developer (Nightly) Builds</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../changes.html">Changes per version</a></li><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="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</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 (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a ></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording >Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit >Sampler</a></li><li><a >href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log >Sampler</a></li><li><a href="../extending/jmeter_tutorial.pdf">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"><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="section"><h1 id="glossary">24. Glossary<a class="sectionlink" href="#glossary" title="Link to here">¶</a></h1> <p> <a name="Elapsed"><b>Elapsed time</b></a>. JMeter measures the elapsed time from just before sending the request to @@ -50,6 +50,8 @@ browser or other application client. <p> <a name="Connect"><b>Connect Time</b></a>. JMeter measures the time it took to establish the connection, including SSL handshake. Note that connect time is not automatically subtracted from <a href="#Latency">latency</a>. +In case of connection error, the metric will be equal to the time it took to face the error, for example in case of Timeout, it should be equal to connection timeout. +<div class="clear"></div><div class="note">As of JMeter 3.0, this metric is only computed to TCP Sampler and HTTP Request.</div><div class="clear"></div> </p> <p> @@ -72,7 +74,7 @@ See, for example: <a href="http://en.wik <a name="StandardDeviation"><b>Standard Deviation</b></a> is a measure of the variability of a data set. This is a standard statistical measure. See, for example: <a href="http://en.wikipedia.org/wiki/Standard_deviation";>Standard Deviation</a> entry at Wikipedia. -JMeter calculates the population standard deviation (e.g. STDEVP function in spreadheets), not the sample standard deviation (e.g. STDEV). +JMeter calculates the population standard deviation (e.g. STDEVP function in spreadsheets), not the sample standard deviation (e.g. STDEV). </p> <p> @@ -106,7 +108,7 @@ The formula is: Throughput = (number of </div><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul></div><div class="footer"><div class="copyright"> Copyright © 1999 – - 2015 + 2016 , Apache Software Foundation </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache feather, and the Apache JMeter logo are
![http://githubbadges.com/star.svg?user=apache&repo=jmeter&style=default"](http://githubbadges.com/star.svg?user=apache&repo=jmeter&style=default"){kind=link}
![http://githubbadges.com/fork.svg?user=apache&repo=jmeter&style=default"](http://githubbadges.com/fork.svg?user=apache&repo=jmeter&style=default"){kind=link}
![https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter/badge.png"](https://maven-badges.herokuapp.com/maven-central/org.apache.jmeter/ApacheJMeter/badge.png"){kind=link}