You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by mi...@apache.org on 2016/11/05 14:26:11 UTC
svn commit: r1768221 [10/11] - in /jmeter/trunk: docs/
docs/images/screenshots/ docs/images/screenshots/dashboard/
docs/images/screenshots/http-config/ docs/localising/ docs/usermanual/
src/core/org/apache/jmeter/util/ xdocs/
Modified: jmeter/trunk/docs/usermanual/properties_reference.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/properties_reference.html?rev=1768221&r1=1768220&r2=1768221&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/properties_reference.html (original)
+++ jmeter/trunk/docs/usermanual/properties_reference.html Sat Nov 5 14:26:10 2016
@@ -5,149 +5,240 @@
APACHE LOGO
--><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
PROJECT LOGO
- --><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"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../changes_history.html">Change History</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">
<div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="glossary.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><ul class="section-index"><li><a href="#introduction">25 Introduction</a><ul></ul></li><li><a href="#language">25.1 Language</a><ul></ul></li><li><a href="#xml_parser">25.2 XML Parser</a><ul></ul></li><li><a href="#ssl_config">25.3 SSL configuration</a><ul></ul></li><li><a href="#laf_config">25.4 Look and Feel configuration</a><ul></ul></li><li><a href="#toolbar_display">25.5 Toolbar display</a><ul></ul></li><li><a href="#backup">25.6 JMX Backup configuration</a><ul></ul></li><li><a href="#remote">25.7
Remote hosts and RMI configuration</a><ul></ul></li><li><a href="#include_controller">25.8 Include Controller</a><ul></ul></li><li><a href="#logging">25.9 Logging Configuration</a><ul></ul></li><li><a href="#http_java_config">25.10 HTTP Java configuration</a><ul></ul></li><li><a href="#httpclient_common_properties">25.11 Commons and Apache HttpClient common properties</a><ul></ul></li><li><a href="#kerberos">25.12 Kerberos properties</a><ul></ul></li><li><a href="#log_levels_commons_httpclient">25.13 Sample logging levels for Commons HttpClient</a><ul></ul></li><li><a href="#httpclient_logging_examples">25.14 Apache HttpClient logging examples</a><ul></ul></li><li><a href="#httpclient4">25.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)</a><ul></ul></li><li><a href="#httpclient31">25.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)</a><ul></ul></li><li><a href="#cache_maanger">25.17 HTTP Cache Manager configuration</a><ul></ul></li><li><a hr
ef="#results_file_config">25.18 Results file configuration</a><ul></ul></li><li><a href="#sample_results">25.19 Settings that affect SampleResults</a><ul></ul></li><li><a href="#upgrade">25.20 Upgrade</a><ul></ul></li><li><a href="#test_script_recorder">25.21 JMeter Test Script recorder configuration</a><ul></ul></li><li><a href="#test_script_recorder_cert">25.22 Test Script Recorder certificate configuration</a><ul></ul></li><li><a href="#proxy_config">25.23 JMeter Proxy configuration</a><ul></ul></li><li><a href="#parser_config">25.24 HTML Parser configuration</a><ul></ul></li><li><a href="#remote_batching_config">25.25 Remote batching configuration</a><ul></ul></li><li><a href="#jdbc_request">25.26 JDBC Request configuration</a><ul></ul></li><li><a href="#os_sampler">25.27 OS Process Sampler configuration</a><ul></ul></li><li><a href="#tcp_sampler">25.28 TCP Sampler configuration</a><ul></ul></li><li><a href="#summariser">25.29 Summariser - Generate Summary Results - configuratio
n (mainly applies to non-GUI mode)</a><ul></ul></li><li><a href="#aggregate_report_graph">25.30 Aggregate Report and Aggregate Graph - configuration</a><ul></ul></li><li><a href="#backend">25.31 BackendListener - configuration</a><ul></ul></li><li><a href="#beanshell">25.32 BeanShell configuration</a><ul></ul></li><li><a href="#mailer">25.33 MailerModel configuration</a><ul></ul></li><li><a href="#csv">25.34 CSVRead configuration</a><ul></ul></li><li><a href="#time">25.35 __time() function configuration</a><ul></ul></li><li><a href="#csv_dataset">25.36 CSV DataSet configuration</a><ul></ul></li><li><a href="#ldap">25.37 LDAP Sampler configuration</a><ul></ul></li><li><a href="#miscellaneous">25.38 Miscellaneous configuration</a><ul></ul></li><li><a href="#classpath">25.39 Classpath configuration</a><ul></ul></li><li><a href="#reporting">25.40 Reporting configuration</a><ul></ul></li><li><a href="#properties">25.41 Additional property files to load</a><ul></ul></li><li><a href="#vali
dation">25.42 Thread Group Validation feature</a><ul></ul></li></ul><div class="section"><h1 id="introduction">25 Introduction<a class="sectionlink" href="#introduction" title="Link to here">¶</a></h1>
+ --><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"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (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="../e
xtending/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="mai
n" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="component_reference.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="functions.html">Next ></a></li></ul><ul class="section-index"><li><a href="#introduction">20 Introduction</a><ul></ul></li><li><a href="#language">20.1 Language</a><ul></ul></li><li><a href="#xml_parser">20.2 XML Parser</a><ul></ul></li><li><a href="#ssl_config">20.3 SSL configuration</a><ul></ul></li><li><a href="#laf_config">20.4 Look and Feel configuration</a><ul></ul></li><li><a href="#toolbar_display">20.5 Toolbar display</a><ul></ul></li><li><a href="#backup">
20.6 JMX Backup configuration</a><ul></ul></li><li><a href="#remote">20.7 Remote hosts and RMI configuration</a><ul></ul></li><li><a href="#include_controller">20.8 Include Controller</a><ul></ul></li><li><a href="#logging">20.9 Logging Configuration</a><ul></ul></li><li><a href="#http_java_config">20.10 HTTP Java configuration</a><ul></ul></li><li><a href="#httpclient_common_properties">20.11 Commons and Apache HttpClient common properties</a><ul></ul></li><li><a href="#kerberos">20.12 Kerberos properties</a><ul></ul></li><li><a href="#log_levels_commons_httpclient">20.13 Sample logging levels for Commons HttpClient</a><ul></ul></li><li><a href="#httpclient_logging_examples">20.14 Apache HttpClient logging examples</a><ul></ul></li><li><a href="#httpclient4">20.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)</a><ul></ul></li><li><a href="#httpclient31">20.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)</a><ul></ul></li><li><a href="#cache_
maanger">20.17 HTTP Cache Manager configuration</a><ul></ul></li><li><a href="#results_file_config">20.18 Results file configuration</a><ul></ul></li><li><a href="#sample_results">20.19 Settings that affect SampleResults</a><ul></ul></li><li><a href="#upgrade">20.20 Upgrade</a><ul></ul></li><li><a href="#test_script_recorder">20.21 JMeter Test Script recorder configuration</a><ul></ul></li><li><a href="#test_script_recorder_cert">20.22 Test Script Recorder certificate configuration</a><ul></ul></li><li><a href="#proxy_config">20.23 JMeter Proxy configuration</a><ul></ul></li><li><a href="#parser_config">20.24 HTML Parser configuration</a><ul></ul></li><li><a href="#remote_batching_config">20.25 Remote batching configuration</a><ul></ul></li><li><a href="#jdbc_request">20.26 JDBC Request configuration</a><ul></ul></li><li><a href="#os_sampler">20.27 OS Process Sampler configuration</a><ul></ul></li><li><a href="#tcp_sampler">20.28 TCP Sampler configuration</a><ul></ul></li><li><a hre
f="#summariser">20.29 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)</a><ul></ul></li><li><a href="#aggregate_report_graph">20.30 Aggregate Report and Aggregate Graph - configuration</a><ul></ul></li><li><a href="#backend">20.31 BackendListener - configuration</a><ul></ul></li><li><a href="#beanshell">20.32 BeanShell configuration</a><ul></ul></li><li><a href="#mailer">20.33 MailerModel configuration</a><ul></ul></li><li><a href="#csv">20.34 CSVRead configuration</a><ul></ul></li><li><a href="#time">20.35 __time() function configuration</a><ul></ul></li><li><a href="#csv_dataset">20.36 CSV DataSet configuration</a><ul></ul></li><li><a href="#ldap">20.37 LDAP Sampler configuration</a><ul></ul></li><li><a href="#miscellaneous">20.38 Miscellaneous configuration</a><ul></ul></li><li><a href="#classpath">20.39 Classpath configuration</a><ul></ul></li><li><a href="#reporting">20.40 Reporting configuration</a><ul></ul></li><li><a href="#properties">2
0.41 Additional property files to load</a><ul></ul></li><li><a href="#validation">20.42 Thread Group Validation feature</a><ul></ul></li><li><a href="#timer">20.43 Timer related feature</a><ul></ul></li></ul><div class="section"><h1 id="introduction">20 Introduction<a class="sectionlink" href="#introduction" title="Link to here">¶</a></h1>
<div class="description">
<p>
This document describes JMeter properties. The properties present in <span class="code">jmeter.properties</span> or <span class="code">reportgenerator.properties</span> should be set in the <span class="code">user.properties</span> file.
These properties are only taken into account after restarting JMeter as they are usually resolved when the class is loaded.
</p>
</div>
-</div><div class="section"><h1 id="language">25.1 Language<a class="sectionlink" href="#language" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="language">20.1 Language<a class="sectionlink" href="#language" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">language</div><div class="description req-true">Preferred GUI language. Comment out to use the JVM default locale's language.<br>, example:<pre class="source">language=en</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">language</div><div class="description req-true">
+ Preferred GUI language. Comment out to use the JVM default locale's language.<br>
+ Example: <pre class="source">language=en</pre>
+ <div class="clear"></div><div class="note">This property is the only one that must be set in <span class="code">jmeter.properties</span> file</div><div class="clear"></div>
+ <div class="clear"></div><div class="note">To fully configure language ensure you set locale, see <a href="http://www.oracle.com/us/technologies/java/locale-140624.html">Internationalization: Understanding Locale in the Java Platform</a>.
+ Example for English:
+ <pre class="source">-Duser.language=en -Duser.region=EN</pre>
+ </div><div class="clear"></div>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">locales.add</div><div class="description req-true">Additional locale(s) to add to the displayed list.<br>The current default list is: en, fr, de, no, es, tr, ja, zh_CN, zh_TW, pl, pt_BR<br> see <span class="code">JMeterMenuBar#makeLanguageMenu()]</span><br> The entries are a comma-separated list of language names<br>, Example: <pre class="source">locales.add=zu</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">locales.add</div><div class="description req-true">
+ Additional locale(s) to add to the displayed list.<br>
+ The current default list is: <span class="code">en</span>, <span class="code">fr</span>,
+ <span class="code">de</span>, <span class="code">no</span>, <span class="code">es</span>, <span class="code">tr</span>,
+ <span class="code">ja</span>, <span class="code">zh_CN</span>,
+ <span class="code">zh_TW</span>, <span class="code">pl</span>, <span class="code">pt_BR</span>.<br>
+ See <span class="code">JMeterMenuBar#makeLanguageMenu()</span><br>
+ The entries are a comma-separated list of language names.<br>
+ Example: <pre class="source">locales.add=zu</pre>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="xml_parser">25.2 XML Parser<a class="sectionlink" href="#xml_parser" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="xml_parser">20.2 XML Parser<a class="sectionlink" href="#xml_parser" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">xpath.namespace.config</div><div class="description req-true">Path to a Properties file containing Namespace mapping in the form <span class="code">prefix=Namespace</span>, Example: <pre class="source">ns=http://biz.aol.com/schema/2006-12-18</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">xpath.namespace.config</div><div class="description req-true">
+ Path to a Properties file containing Namespace mapping in the form <span class="code">prefix=Namespace</span>.
+ Example: <pre class="source">ns=http://biz.aol.com/schema/2006-12-18</pre></div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="ssl_config">25.3 SSL configuration<a class="sectionlink" href="#ssl_config" title="Link to here">¶</a></h1>
-<div class="clear"></div><div class="note">SSL (Java) System properties are now in system.properties<br>
-JMeter no longer converts <span class="code">javax.xxx</span> property entries in this file into System properties.<br>
+</div><div class="section"><h1 id="ssl_config">20.3 SSL configuration<a class="sectionlink" href="#ssl_config" title="Link to here">¶</a></h1>
+<div class="clear"></div><div class="note">SSL (Java) System properties are now in <span class="code">system.properties</span><br>
+JMeter no longer converts <span class="code">javax.<em>xxx</em></span> property entries in this file into System properties.<br>
These must now be defined in the <span class="code">system.properties</span> file or on the command-line.<br>
-The system.properties file gives more flexibility.</div><div class="clear"></div>
-<div class="property"><div class="name req-true">https.sessioncontext.shared</div><div class="description req-true">By default, SSL session contexts are now created per-thread, rather than being shared.<br> The old behaviour can be enabled by setting this property to <span class="code">true</span>. Defaults to: false</div><div class="required req-true">
+The <span class="code">system.properties</span> file gives more flexibility.</div><div class="clear"></div>
+<div class="property"><div class="name req-true">https.sessioncontext.shared</div><div class="description req-true">
+ By default, SSL session contexts are now created per-thread, rather than being shared.<br>
+ The old behaviour can be enabled by setting this property to <span class="code">true</span>. Defaults to: <span class="code">false</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">https.default.protocol</div><div class="description req-true">Be aware that https default protocol may vary depending on the version of JVM
-See <a href="https://blogs.oracle.com/java-platform-group/entry/diagnosing_tls_ssl_and_https" target="_blank">Diagnosing TLS, SSL and HTTPS</a> and <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=58236">
+<div class="property"><div class="name req-true">https.default.protocol</div><div class="description req-true">
+ Be aware that https default protocol may vary depending on the version of JVM.
+ See <a href="https://blogs.oracle.com/java-platform-group/entry/diagnosing_tls_ssl_and_https" target="_blank">Diagnosing TLS, SSL and HTTPS</a>
+ and <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=58236">
Bug
- 58236</a>
- -
-
-Default HTTPS protocol level: <pre class="source">https.default.protocol=TLS</pre>
-This may need to be changed to:<pre class="source">https.default.protocol=SSLv3</pre></div><div class="required req-true">
+ 58236</a>.
+ Default HTTPS protocol level: <pre class="source">https.default.protocol=TLS</pre>
+ This may need to be changed to: <pre class="source">https.default.protocol=SSLv3</pre>
+</div><div class="required req-true">
No
</div></div>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">https.socket.protocols</div><div class="description req-true">List of protocols to enable. You may have to select only a subset if you find issues with target server.<br>
-This is needed when server does not support Socket version negotiation, this can lead to errors like:
-<span class="code">javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated</span>
-or <span class="code">java.net.SocketException: Connection reset</span><br>, see <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=54759">
+<div class="property"><div class="name req-true">https.socket.protocols</div><div class="description req-true">
+ List of protocols to enable. You may have to select only a subset if you find issues with target server.<br>
+ This is needed when server does not support Socket version negotiation, this can lead to errors like:
+ <span class="code">javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated</span>
+ or <span class="code">java.net.SocketException: Connection reset</span>.<br>
+ See <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=54759">
Bug
- 54759</a>
- -
- , example: <pre class="source">https.socket.protocols=SSLv2Hello SSLv3 TLSv1</pre></div><div class="required req-true">
+ 54759</a>, example: <pre class="source">https.socket.protocols=SSLv2Hello SSLv3 TLSv1</pre>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">https.use.cached.ssl.context</div><div class="description req-true">Control if we allow reuse of cached SSL context between iterations<br> set the value to 'false' to reset the SSL context each iteration<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">https.use.cached.ssl.context</div><div class="description req-true">
+ Control if we allow reuse of cached SSL context between iterations.<br>
+ Set the value to <span class="code">false</span> to reset the SSL context each iteration.<br>
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">https.keyStoreStartIndex</div><div class="description req-true"> Start index to be used with keystores with many entries<br> The default is to use entry 0, i.e. the first<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">https.keyStoreStartIndex</div><div class="description req-true">
+ Start index to be used with keystores with many entries.<br>
+ The default is to use entry <span class="code">0</span>, i.e. the first.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">https.keyStoreEndIndex</div><div class="description req-true">End index to be used with keystores with many entries<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">https.keyStoreEndIndex</div><div class="description req-true">
+ End index to be used with keystores with many entries.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="laf_config">25.4 Look and Feel configuration<a class="sectionlink" href="#laf_config" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="laf_config">20.4 Look and Feel configuration<a class="sectionlink" href="#laf_config" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">jmeter.laf.windows_xp</div><div class="description req-true">Classname of the Swing default UI<br>
-The LAF classnames that are available are now displayed as ToolTip text<br> when hovering over the Options/Look and Feel selection list.
-You can either use a full class name, as shown below, or one of the strings "System" or "CrossPlatform" which means JMeter will use the
-corresponding string returned by <span class="code">UIManager.get<name>LookAndFeelClassName()</span>.<br>
-LAF can be overridden by os.name (lowercased, spaces replaced by '_')<br> Sample os.name LAF:<br>, example:<pre class="source">jmeter.laf.windows_xp=javax.swing.plaf.metal.MetalLookAndFeel</pre>
-Failing that, the OS family = os.name, but only up to first space: Sample OS family LAF:<br>, example <pre class="source">jmeter.laf.windows=com.sun.java.swing.plaf.windows.WindowsLookAndFeel</pre>
-Mac apparently looks better with the System LAF set through <pre class="source">jmeter.laf.mac=System</pre>.
-Failing that, the JMeter default laf can be defined through: <pre class="source">jmeter.laf=System</pre>
-If none of the above jmeter.laf properties are defined, JMeter uses the CrossPlatform LAF.
-This is because the CrossPlatform LAF generally looks better than the System LAF. See <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=52026">
+<div class="property"><div class="name req-true">jmeter.laf.windows_10</div><div class="description req-true">
+ Classname of the Swing default UI<br>
+ The LAF classnames that are available are now displayed as ToolTip text when hovering over
+ the Options/Look and Feel selection list.<br>
+ You can either use a full class name, as shown below, or one of the strings "<span class="code">System</span>"
+ or "<span class="code">CrossPlatform</span>" which means JMeter will use the
+ corresponding string returned by <span class="code">UIManager.get<name>LookAndFeelClassName()</span>.<br>
+ LAF can be overridden by <span class="code">os.name</span> (lowercased, spaces replaced by '_').<br>
+ <div class="example"><div class="title">Order of LAF property lookup<a class="sectionlink" href="#order-laf-lookup" title="Link to here">¶</a></div>
+ Take for example an <span class="code">os.name</span> of <span class="code">Windows 10</span>.<br>
+ JMeter would look first for a property
+ <pre class="source">jmeter.laf.windows_10=javax.swing.plaf.metal.MetalLookAndFeel</pre>
+ Failing that, the OS family <span class="code">os.name</span> would be used shortened to the first space. In our example
+ JMeter would therefore look for a property
+ <pre class="source">jmeter.laf.windows=com.sun.java.swing.plaf.windows.WindowsLookAndFeel</pre>
+ </div>
+ <div class="clear"></div><div class="note">
+ Mac apparently looks better with the System LAF set through
+ <pre class="source">jmeter.laf.mac=System</pre>
+ Failing that, the JMeter default laf can be defined through:
+ <pre class="source">jmeter.laf=System</pre>
+ If none of the above <span class="code">jmeter.laf</span> properties are defined, JMeter uses the <span class="code">CrossPlatform</span> LAF.
+ This is because the <span class="code">CrossPlatform</span> LAF generally looks better than the <span class="code">System</span> LAF.
+ See <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=52026">
Bug
- 52026</a>
- -
- for details
+ 52026</a> for details.
+ </div><div class="clear"></div>
</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.loggerpanel.display</div><div class="description req-true">LoggerPanel display<br> defaults to:false</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.loggerpanel.display</div><div class="description req-true">
+ Display LoggerPanel.<br>
+ Defaults to: <span class="code">false</span></div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.loggerpanel.enable_when_closed</div><div class="description req-true">Enable LogViewer Panel to receive log event even if closed<br> Enabled since 2.12<br> Note this has some impact on performances, but as GUI mode must<br> not be used for Load Test it is acceptable<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.loggerpanel.enable_when_closed</div><div class="description req-true">
+ Enable LogViewer Panel to receive log event even when closed.<br>
+ Enabled since 2.12<br>
+ <div class="clear"></div><div class="note">Note this has some impact on performances, but as GUI mode must not be used for Load Test it is acceptable</div><div class="clear"></div>
+ Defaults to: <span class="code">true</span></div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.loggerpanel.maxlength</div><div class="description req-true"> Max characters kept in LoggerPanel, 0 means no limit<br>, defaults to:80000</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.loggerpanel.maxlength</div><div class="description req-true">
+ Max characters kept in LoggerPanel, <span class="code">0</span> means no limit.<br>
+ Defaults to: <span class="code">80000</span></div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="toolbar_display">25.5 Toolbar display<a class="sectionlink" href="#toolbar_display" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="toolbar_display">20.5 Toolbar display<a class="sectionlink" href="#toolbar_display" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">jmeter.toolbar.icons</div><div class="description req-true">Toolbar icon definitions<br>, defaults to <span class="code">org/apache/jmeter/images/toolbar/icons-toolbar.properties</span></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.toolbar.icons</div><div class="description req-true">
+ Toolbar icon definitions.<br>
+ Defaults to <span class="code">org/apache/jmeter/images/toolbar/icons-toolbar.properties</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.toolbar</div><div class="description req-true">Toolbar list<br>, defaults to:<pre class="source">new,open,close,save,save_as_testplan,|,cut,copy,paste,|,expand,collapse,toggle,|,test_start,test_stop,test_shutdown,|,test_start_remote_all,test_stop_remote_all,test_shutdown_remote_all,|,test_clear,test_clear_all,|,search,search_reset,|,function_helper,help</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.toolbar</div><div class="description req-true">
+ Toolbar list.<br>
+ Defaults to:
+ <pre class="source">new,open,close,save,save_as_testplan,|,cut,copy,paste,|,expand,collapse,toggle,|,test_start,test_stop,test_shutdown,|,test_start_remote_all,test_stop_remote_all,test_shutdown_remote_all,|,test_clear,test_clear_all,|,search,search_reset,|,function_helper,help</pre>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.toolbar.icons.size</div><div class="description req-true">Available sizes are: <span class="code">22x22, 32x32, 48x48</span>. Suggested value for HiDPI mode is <pre class="source">jmeter.toolbar.icons.size=48x48</pre>, defaults to:22x22</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.toolbar.icons.size</div><div class="description req-true">
+ Available sizes are: <span class="code">22x22</span>, <span class="code">32x32</span>, <span class="code">48x48</span>. Suggested value for HiDPI mode is
+ <pre class="source">jmeter.toolbar.icons.size=48x48</pre>
+ Defaults to: <span class="code">22x22</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.icons</div><div class="description req-true">Icon definitions. Alternate set: <pre class="source">jmeter.icons=org/apache/jmeter/images/icon_1.properties</pre>, Historical icon set (deprecated):<pre class="source">jmeter.icons=org/apache/jmeter/images/icon_old.properties</pre> <br>defaults to:<span class="code">org/apache/jmeter/images/icon.properties</span></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.icons</div><div class="description req-true">
+ Icon definitions. Alternate set:
+ <pre class="source">jmeter.icons=org/apache/jmeter/images/icon_1.properties</pre>
+ Historical icon set (deprecated):
+ <pre class="source">jmeter.icons=org/apache/jmeter/images/icon_old.properties</pre>
+ Defaults to:<span class="code">org/apache/jmeter/images/icon.properties</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.tree.icons.size</div><div class="description req-true">Available sizes are: <span class="code">19x19, 24x24, 32x32, 48x48</span>. Useful for HiDPI display (see below)<br>, defaults to:<span class="code">19x19</span>Suggested value for HiDPI screen like 3200x1800 is defaults to:<span class="code">32x32</span></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.tree.icons.size</div><div class="description req-true">
+ Available sizes are: <span class="code">19x19</span>, <span class="code">24x24</span>, <span class="code">32x32</span>, <span class="code">48x48</span>.
+ Useful for HiDPI display (see below).<br>
+ Defaults to: <span class="code">19x19</span><br>
+ Suggested value for HiDPI screen like 3200x1800 is: <span class="code">32x32</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.hidpi.mode</div><div class="description req-true">HiDPI mode. Activate a 'pseudo'-hidpi mode. Allows to increase size of some UI elements which are not correctly managed by JVM with high resolution screens in Linux or Windows<br>, defaults to:false</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.hidpi.mode</div><div class="description req-true">
+ HiDPI mode. Activate a '<em>pseudo</em>'-HiDPI mode. Allows to increase size of some UI
+ elements which are not correctly managed by JVM with high resolution screens in Linux or Windows.<br>
+ Defaults to: <span class="code">false</span></div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.hidpi.scale.factor</div><div class="description req-true">HiDPI scale factor, suggested value for HiDPI: <span class="code">2.0</span>, defaults to:<span class="code">1.0</span></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.hidpi.scale.factor</div><div class="description req-true">
+ HiDPI scale factor. Suggested value for HiDPI: <span class="code">2.0</span>.
+ Defaults to: <span class="code">1.0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">not_in_menu</div><div class="description req-true">Components to not display in JMeter GUI (GUI class name or static label)<br> These elements are deprecated and will be removed in next version: <pre class="source">MongoDB Script, MongoDB Source Config, Distribution Graph, Spline Visualizer</pre> defaults to:<pre class="source">org.apache.jmeter.protocol.mongodb.sampler.MongoScriptSampler, org.apache.jmeter.protocol.mongodb.config.MongoSourceElement, org.apache.jmeter.visualizers.DistributionGraphVisualizer, org.apache.jmeter.visualizers.SplineVisualizer</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">not_in_menu</div><div class="description req-true">
+ Components to not display in JMeter GUI (GUI class name or static label).<br>
+ These elements are deprecated and will be removed in next version:
+ <pre class="source">MongoDB Script, MongoDB Source Config</pre>
+ Defaults to:
+ <pre class="source">org.apache.jmeter.protocol.mongodb.sampler.MongoScriptSampler, org.apache.jmeter.protocol.mongodb.config.MongoSourceElement</pre>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">undo.history.size</div><div class="description req-true">Number of items in undo history<br> Feature is disabled by default (0) due to known and not fixed bugs <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=57043">
+<div class="property"><div class="name req-true">undo.history.size</div><div class="description req-true">
+ Number of items in undo history.<br>
+ Feature is disabled by default (<span class="code">0</span>) due to known and not fixed bugs
+ <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=57043">
Bug
- 57043</a>
- -
- ,<a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=57039">
+ 57043</a>, <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=57039">
Bug
- 57039</a>
- -
- and <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=57040">
+ 57039</a> and <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=57040">
Bug
- 57040</a>
- -
- .
-Set it to a number > 0 (25 can be a good default)<br> The bigger it is, the more it consumes memory, defaults to:<span class="code">0</span></div><div class="required req-true">
+ 57040</a>.
+ Set it to a number greater than zero (<span class="code">25</span> can be a good default).<br>
+ The bigger it is, the more memory will be consumed.
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">gui.quick_X</div><div class="description req-true">Hotkeys to add JMeter components where X is the shortcut key, for example:
+<div class="property"><div class="name req-true">gui.quick_X</div><div class="description req-true">
+ Hotkeys to add JMeter components where <span class="code"><em>X</em></span> is the shortcut key, for example:
<pre class="source">
gui.quick_0=ThreadGroupGui
gui.quick_1=HttpTestSampleGui
@@ -160,126 +251,190 @@ gui.quick_7=JSR223PreProcessor
gui.quick_8=DebugSampler
gui.quick_9=ViewResultsFullVisualizer
</pre>
-Above code will add elements when you press Ctrl+0 .. Ctrl+9 (Command+0 .. Command+9 on Mac)
+ Above code will add the corresponding elements when you press
+ <span class="keycombo"><span class="keysym">Ctrl</span> + <span class="keysym">0</span></span> …
+ <span class="keycombo"><span class="keysym">Ctrl</span> + <span class="keysym">9</span></span>
+ (<span class="keycombo"><span class="keysym">⌘</span> + <span class="keysym">0</span></span> …
+ <span class="keycombo"><span class="keysym">⌘</span> + <span class="keysym">9</span></span> on Mac)
</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="backup">25.6 JMX Backup configuration<a class="sectionlink" href="#backup" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="backup">20.6 JMX Backup configuration<a class="sectionlink" href="#backup" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">jmeter.gui.action.save.backup_on_save</div><div class="description req-true">Enable auto backups of the .jmx file when a test plan is saved.<br>When enabled, before the .jmx is saved, it will be backed up to the directory pointed<br>by the jmeter.gui.action.save.backup_directory property (see below). Backup file names are built<br>after the jmx file being saved. For example, saving test-plan.jmx will create a test-plan-000012.jmx<br>in the backup directory provided that the last created backup file is test-plan-000011.jmx.<br>Default value is true indicating that auto backups are enabled<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.gui.action.save.backup_on_save</div><div class="description req-true">
+ Enable auto backups of the <span class="code">.jmx</span> file when a test plan is saved.<br>
+ When enabled, before the <span class="code">.jmx</span> is saved, it will be backed up to the directory
+ pointed to by the <span class="code">jmeter.gui.action.save.backup_directory</span> property (see below).
+ Backup file names are built after the jmx file being saved. For example,
+ saving <span class="code">test-plan.jmx</span> will create a <span class="code">test-plan-000012.jmx</span> in the backup
+ directory provided that the last created backup file is <span class="code">test-plan-000011.jmx</span>.<br>
+ Default value is <span class="code">true</span> indicating that auto backups are enabled.<br>
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.gui.action.save.backup_directory</div><div class="description req-true">Set the backup directory path where JMX backups will be created upon save in the GUI.<br>If not set (what it defaults to) then backup files will be created in<br>a sub-directory of the JMeter base installation. If set and the directory does not exist, it will be created.<br>, defaults to:<span class="code">${JMETER_HOME}/backups</span></div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.gui.action.save.backup_directory</div><div class="description req-true">
+ Set the backup directory path where JMX backups will be created upon save in the GUI.<br>
+ If not set (what it defaults to) then backup files will be created in a sub-directory of
+ the JMeter base installation. If set and the directory does not exist, a corresponding directory will be created.<br>
+ Defaults to: <span class="code">${JMETER_HOME}/backups</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.gui.action.save.keep_backup_max_hours</div><div class="description req-true">Set the maximum time (in hours) that backup files should be preserved since the save time.<br>By default no expiration time is set which means we keep backups for ever.<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.gui.action.save.keep_backup_max_hours</div><div class="description req-true">
+ Set the maximum time (in hours) that backup files should be preserved since the save time.<br>
+ By default no expiration time is set which means we keep backups for ever.<br>
+ Defaults to: <span class="code">0</span></div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.gui.action.save.keep_backup_max_count</div><div class="description req-true">Set the maximum number of backup files that should be preserved. By default 10 backups will be preserved.<br>Setting this to zero will cause the backups to not being deleted (unless keep_backup_max_hours is set to a non zero value)<br>, defaults to:10</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.gui.action.save.keep_backup_max_count</div><div class="description req-true">
+ Set the maximum number of backup files that should be preserved.
+ By default ten backups will be preserved.<br>
+ Setting this to zero will cause the backups to not being deleted (unless <span class="code">keep_backup_max_hours</span>
+ is set to a non zero value).<br>
+ Defaults to: <span class="code">10</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="remote">25.7 Remote hosts and RMI configuration<a class="sectionlink" href="#remote" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="remote">20.7 Remote hosts and RMI configuration<a class="sectionlink" href="#remote" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">remote_hosts</div><div class="description req-true"> Remote Hosts - comma delimited, example <pre class="source">remote_hosts=localhost:1099,localhost:2010</pre>, defaults to:127.0.0.1.</div><div class="required req-true">
- No
- </div></div>
-<div class="property"><div class="name req-true">server_port</div><div class="description req-true"> RMI port to be used by the server (must start rmiregistry with same port)
-To change the port to (say) 1234:
-On the server(s):
-<ul>
-<ol>set server_port=1234</ol>
-<ol>start rmiregistry with port 1234</ol>
-</ul>
-On Windows this can be done by:
-<ul>
-<ol><span class="code">SET SERVER_PORT=1234</span></ol>
-<ol>JMETER-SERVER</ol>
-</ul>
-On Unix:
-<span class="code">SERVER_PORT=1234 jmeter-server</span><br>
-On the client:
-<span class="code">set remote_hosts=server:1234</span><br>
-defaults to:1099</div><div class="required req-true">
+<div class="property"><div class="name req-true">remote_hosts</div><div class="description req-true">
+ Remote Hosts - comma delimited, for example
+ <pre class="source">remote_hosts=localhost:1099,localhost:2010</pre>
+ Defaults to: <span class="code">127.0.0.1</span></div><div class="required req-true">
+ No
+ </div></div>
+<div class="property"><div class="name req-true">server_port</div><div class="description req-true">
+ RMI port to be used by the server (must start <span class="code">rmiregistry</span> with same port).
+ To change the port to (say) <span class="code">1234</span>:<br>
+ On the server(s):
+ <ul>
+ <ol><span class="code">set server_port=1234</span></ol>
+ <ol>start <span class="code">rmiregistry</span> with port <span class="code">1234</span></ol>
+ </ul>
+ On Windows this can be done by:
+ <pre class="source">SET SERVER_PORT=1234
+JMETER-SERVER</pre>
+ On Unix:
+ <pre class="source">SERVER_PORT=1234 jmeter-server</pre>
+ On the windows client:
+ <pre class="source">set remote_hosts=<em>server</em>:1234</pre>
+ On the unix client:
+ <pre class="source">export remote_hosts=<em>server</em>:1234</pre>
+ Defaults to: <span class="code">1099</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">client.rmi.localport</div><div class="description req-true"> Parameter that controls the RMI port used by the RemoteSampleListenerImpl (The Controler)<br> Default value is 0 which means port is randomly assigned<br> You may need to open Firewall port on the Controller machine<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">client.rmi.localport</div><div class="description req-true">
+ Parameter that controls the RMI port used by the <span class="code">RemoteSampleListenerImpl</span> (The Controler)<br>
+ Default value is <span class="code">0</span>, which means port is randomly assigned.
+ <div class="clear"></div><div class="note">You may need to open a port in the firewall on the Controller machine.</div><div class="clear"></div>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">client.tries</div><div class="description req-true"> When distributed test is starting, there may be several attempts to initialize<br> remote engines. By default, only single try is made. Increase following property<br> to make it retry for additional times<br>, defaults to:1</div><div class="required req-true">
+<div class="property"><div class="name req-true">client.tries</div><div class="description req-true">
+ When distributed test is starting, there may be several attempts to initialize remote engines.<br>
+ By default, only a single try is made. Increase this property to make it retry additional times.<br>
+ Defaults to: <span class="code">1</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">client.retries_delay</div><div class="description req-true"> If there is initialization retries, following property sets delay between attempts<br>, defaults to:5000</div><div class="required req-true">
+<div class="property"><div class="name req-true">client.retries_delay</div><div class="description req-true">
+ If initialization is retried, this property sets the delay between those attempts in milliseconds.<br>
+ Defaults to: <span class="code">5000</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">client.continue_on_fail</div><div class="description req-true"> When all initialization tries was made, test will fail if some remote engines are failed<br> Set following property to true to ignore failed nodes and proceed with test <br>, defaults to:false</div><div class="required req-true">
+<div class="property"><div class="name req-true">client.continue_on_fail</div><div class="description req-true">
+ When all initialization tries were made, the test will fail, if any remote engines are failed.<br>
+ Set this property to <span class="code">true</span> to ignore failed nodes and proceed with test.<br>
+ Defaults to: <span class="code">false</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">server.rmi.port</div><div class="description req-true"> To change the default port (1099) used to access the server:<br>, defaults to:1234</div><div class="required req-true">
+<div class="property"><div class="name req-true">server.rmi.port</div><div class="description req-true">
+ To change the default port (<span class="code">1099</span>) used to access the server.<br>
+ Defaults to: <span class="code">1099</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">server.rmi.localport</div><div class="description req-true"> To use a specific port for the JMeter server engine, define<br> the following property before starting the server:<br>, defaults to:4000</div><div class="required req-true">
+<div class="property"><div class="name req-true">server.rmi.localport</div><div class="description req-true">
+ To use a specific port for the JMeter server engine, define this property before starting the server.<br>
+ Defaults to: <span class="code">4000</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">server.rmi.create</div><div class="description req-true"> From JMeter 2.3.1, the jmeter server creates the RMI registry as part of the server process.<br> To stop the server creating the RMI registry:<br>, defaults to:false</div><div class="required req-true">
+<div class="property"><div class="name req-true">server.rmi.create</div><div class="description req-true">
+ From JMeter version 2.3.1, the jmeter server creates the RMI registry as part of the server process.<br>
+ Set this property to <span class="code">false</span>, to stop the server creating the RMI registry.<br>
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">server.exitaftertest</div><div class="description req-true"> From JMeter 2.3.1, define the following property to cause JMeter to exit after the first test<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">server.exitaftertest</div><div class="description req-true">
+ From JMeter version 2.3.1, define this property to cause JMeter to exit after the first test.<br>
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="include_controller">25.8 Include Controller<a class="sectionlink" href="#include_controller" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="include_controller">20.8 Include Controller<a class="sectionlink" href="#include_controller" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">includecontroller.prefix</div><div class="description req-true"> Prefix used by IncludeController when building file name<br>, defaults to empty value</div><div class="required req-true">
+<div class="property"><div class="name req-true">includecontroller.prefix</div><div class="description req-true">
+ Prefix used by <span class="code">IncludeController</span> when building file names.<br>
+ Defaults to empty value
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="logging">25.9 Logging Configuration<a class="sectionlink" href="#logging" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="logging">20.9 Logging Configuration<a class="sectionlink" href="#logging" title="Link to here">¶</a></h1>
<div class="description">
-JMeter uses Avalon (Excalibur) LogKit
-The Logging Format is described <a href="http://excalibur.apache.org/apidocs/org/apache/log/format/PatternFormatter.html" target="_blank">here</a>
-
-Default format:
-<pre class="source">log_format=%{time:yyyy/MM/dd HH:mm:ss} %5.5{priority} - %{category}: %{message} %{throwable}
-</pre>
-<span class="code">\n</span> is automatically added to the end of the string
-Predefined formats in the JMeter LoggingManager:
-<pre class="source">
-#log_format_type=default
+ JMeter uses Avalon (Excalibur) LogKit.
+ The Logging Format is described <a href="http://excalibur.apache.org/apidocs/org/apache/log/format/PatternFormatter.html" target="_blank">here</a><br>
+ Default format:
+ <pre class="source">log_format=%{time:yyyy/MM/dd HH:mm:ss} %5.5{priority} - %{category}: %{message} %{throwable}</pre>
+ <div class="clear"></div><div class="note"><span class="code">\n</span> is automatically added to the end of the string.</div><div class="clear"></div>
+ Predefined formats in the JMeter LoggingManager:
+ <pre class="source">#log_format_type=default
#log_format_type=thread_prefix
#log_format_type=thread_suffix
</pre>
-<span class="code">default</span> is as above.
-<span class="code">thread_prefix</span> adds the thread name as a prefix to the category.
-<span class="code">thread_suffix</span> adds the thread name as a suffix to the category
-<div class="clear"></div><div class="note">Thread name is not included by default, as it requires extra processing.</div><div class="clear"></div>
+ <dl>
+ <dt><span class="code">default</span></dt><dd>is as above.</dd>
+ <dt><span class="code">thread_prefix</span></dt><dd>adds the thread name as a prefix to the category.</dd>
+ <dt><span class="code">thread_suffix</span></dt><dd>adds the thread name as a suffix to the category.</dd>
+ </dl>
+ <div class="clear"></div><div class="note">Thread name is not included by default, as it requires extra processing.</div><div class="clear"></div>
-To change the logging format, define either <span class="code">log_format_type</span> or <span class="code">log_format</span>
-If both are defined, the type takes precedence. Note that these properties cannot be defined using the <span class="code">-J</span> or <span class="code">-D</span> JMeter command-line flags,
-as the format will have already been determined by then
-However, they can be defined as JVM properties
-Logging levels for the logging categories in JMeter.
-Correct values are:
-<ul>
- <li>FATAL_ERROR</li>
- <li>ERROR</li>
- <li>WARN</li>
- <li>INFO</li>
- <li>DEBUG</li>
-</ul>
+ To change the logging format, define either <span class="code">log_format_type</span> or <span class="code">log_format</span>
+ If both are defined, the type takes precedence.
+ <div class="clear"></div><div class="note">Note that these properties cannot be defined using the <span class="code">-J</span> or <span class="code">-D</span> JMeter
+ command-line flags, as the format will have already been determined by then.
+ However, they can be defined as JVM properties.</div><div class="clear"></div>
+ Logging levels for the logging categories in JMeter.
+ Correct values are:
+ <ul>
+ <li><span class="code">FATAL_ERROR</span></li>
+ <li><span class="code">ERROR</span></li>
+ <li><span class="code">WARN</span></li>
+ <li><span class="code">INFO</span></li>
+ <li><span class="code">DEBUG</span></li>
+ </ul>
-To set the log level for a package or individual class, use:
+ To set the log level for a package or individual class, use:
<pre class="source">
log_level.[package_name].[classname]=[PRIORITY_LEVEL]
</pre>
-But omit <span class="code">org.apache</span> from the package name. The classname is optional. Further examples below.
+ But omit <span class="code">org.apache</span> from the package name. The classname is optional. Further examples below.
<pre class="source">
log_level.jmeter=INFO
@@ -301,1069 +456,1924 @@ log_level.jmeter.testelements.property=D
log_level.jorphan=INFO
</pre>
-# You can specify a different log file for different categories via:
-<pre class="source">
-log_file.[category]=[filename]
-</pre>
-<span class="code">category</span> is equivalent to the package/class names described above
+ You can specify a different log file for different categories via:
+ <pre class="source">log_file.[category]=[filename]</pre>
+ <span class="code">category</span> is equivalent to the package/class names described above.<br>
-Combined log file (for jmeter and jorphan)
-<pre class="source">
-log_file=jmeter.log
-</pre>
+ Combined log file (for <span class="code">jmeter</span> and <span class="code">jorphan</span>)
+ <pre class="source">log_file=jmeter.log</pre>
-To redirect logging to standard output, try the following (it will probably report an error, but output will be to stdout):
-<pre class="source">
-log_file=
-</pre>
+ To redirect logging to standard output, try the following (it will probably report an error, but output will be to <span class="code">stdout</span>):
+ <pre class="source">log_file=</pre>
-Or define separate logs if required:
-<pre class="source">
-log_file.jorphan=jorphan.log
-log_file.jmeter=jmeter.log
-</pre>
-If the filename contains paired single-quotes, then the name is processed as a SimpleDateFormat format applied to the current date, for example:
-<pre class="source">
-log_file='jmeter_'yyyyMMddHHmmss'.tmp'
-</pre>
-When JMeter starts, it sets the system property:
-<span class="code">org.apache.commons.logging.Log</span> to <span class="code">org.apache.commons.logging.impl.LogKitLogger</span>
-if not already set. This causes Apache and Commons HttpClient to use the same logging as JMeter
+ Or define separate logs if required:
+ <pre class="source">log_file.jorphan=jorphan.log
+log_file.jmeter=jmeter.log</pre>
-Excalibur logging provides the facility to configure logging using configuration files written in XML. This allows for such features as
-log file rotation which are not supported directly by JMeter. If such a file specified, it will be applied to the current logging
- hierarchy when that has been created.
-<pre class="source">
-log_config=logkit.xml
-</pre>
+ If the filename contains paired single-quotes, then the name is processed as
+ a <span class="code">SimpleDateFormat</span> format applied to the current date, for example:
+ <pre class="source">log_file='jmeter_'yyyyMMddHHmmss'.tmp'</pre>
+
+ When JMeter starts, it sets the system property:
+ <span class="code">org.apache.commons.logging.Log</span> to
+ <span class="code">org.apache.commons.logging.impl.LogKitLogger</span>
+ if not already set. This causes Apache and Commons HttpClient to use the same logging as JMeter.<br>
+
+ Excalibur logging provides the facility to configure logging using configuration files written in XML. This allows for such features as
+ log file rotation, which are not supported directly by JMeter. If such a file is specified, it will be applied to the current logging
+ hierarchy when that has been created.
+ <pre class="source">log_config=logkit.xml</pre>
</div>
-</div><div class="section"><h1 id="http_java_config">25.10 HTTP Java configuration<a class="sectionlink" href="#http_java_config" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="http_java_config">20.10 HTTP Java configuration<a class="sectionlink" href="#http_java_config" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">http.java.sampler.retries</div><div class="description req-true"> Number of connection retries performed by HTTP Java sampler before giving up. 0 means no retry since version 3.0, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">http.java.sampler.retries</div><div class="description req-true">
+ Number of connection retries performed by HTTP Java sampler before giving up.
+ <span class="code">0</span> means no retry since version 3.0.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="httpclient_common_properties">25.11 Commons and Apache HttpClient common properties<a class="sectionlink" href="#httpclient_common_properties" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="httpclient_common_properties">20.11 Commons and Apache HttpClient common properties<a class="sectionlink" href="#httpclient_common_properties" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">httpclient.timeout</div><div class="description req-true"> set the socket timeout (or use the parameter <span class="code">http.socket.timeout</span>) <br> for AJP Sampler and HttpClient3 implementation.<br> Note for HttpClient3 implementation it is better to use GUI to set timeout or use <span class="code">http.socket.timeout</span> in httpclient.parameters. Value is in milliseconds, 0 means no timeout, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.timeout</div><div class="description req-true">
+ Set the socket timeout (or use the parameter <span class="code">http.socket.timeout</span>) for
+ AJP Sampler and HttpClient3 implementation.<br>
+ <div class="clear"></div><div class="note">Note for HttpClient3 implementation it is better to use GUI to set timeout or
+ use <span class="code">http.socket.timeout</span> in <span class="code">httpclient.parameters</span>.</div><div class="clear"></div>
+ Value is in milliseconds, <span class="code">0</span> means no timeout.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient.version</div><div class="description req-true"> Set the http version, defaults to:<span class="code">1.1</span> (or use the parameter <span class="code">http.protocol.version</span>)</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.version</div><div class="description req-true">
+ Set the http version.<br>
+ Defaults to: <span class="code">1.1</span> (or use the parameter <span class="code">http.protocol.version</span>)
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient.socket.http.cps</div><div class="description req-true"> Set characters per second to a value > 0 to emulate slow connections<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.socket.http.cps</div><div class="description req-true">
+ Set characters per second to a value greater then zero to emulate slow connections.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient.socket.https.cps</div><div class="description req-true">Same as before but for https, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.socket.https.cps</div><div class="description req-true">
+ Same as before but for https.
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient.loopback</div><div class="description req-true">Enable loopback protocol<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.loopback</div><div class="description req-true">
+ Enable loopback protocol.<br>
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient.localaddress</div><div class="description req-true"> Define the local host address to be used for multi-homed hosts, example <pre class="source">httpclient.localaddress=1.2.3.4</pre></div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.localaddress</div><div class="description req-true">
+ Define the local host address to be used for multi-homed hosts,
+ example <pre class="source">httpclient.localaddress=1.2.3.4</pre>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="kerberos">25.12 Kerberos properties<a class="sectionlink" href="#kerberos" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="kerberos">20.12 Kerberos properties<a class="sectionlink" href="#kerberos" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">kerberos_jaas_application</div><div class="description req-true"> AuthManager Kerberos configuration<br> Name of application module used in jaas.conf, defaults to:JMeter </div><div class="required req-true">
+<div class="property"><div class="name req-true">kerberos_jaas_application</div><div class="description req-true">
+ AuthManager Kerberos configuration<br>
+ Name of application module used in <span class="code">jaas.conf</span>.<br>
+ Defaults to: <span class="code">JMeter</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">kerberos.spnego.strip_port</div><div class="description req-true"> Should ports be stripped from urls before constructing SPNs for spnego authentication, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">kerberos.spnego.strip_port</div><div class="description req-true">
+ Should port be stripped from urls before constructing SPNs for SPNEGO authentication.
+ Defaults to: <span class="code">true</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="log_levels_commons_httpclient">25.13 Sample logging levels for Commons HttpClient<a class="sectionlink" href="#log_levels_commons_httpclient" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="log_levels_commons_httpclient">20.13 Sample logging levels for Commons HttpClient<a class="sectionlink" href="#log_levels_commons_httpclient" title="Link to here">¶</a></h1>
<div class="description">
-Commons HttpClient Logging information can be found at <a href="http://hc.apache.org/httpclient-3.x/logging.html" target="_blank">Logging</a>
-Note that full category names are used, i.e. must include the org.apache.
-Info level produces no output.
-Set debug level:
-<pre class="source">log_level.org.apache.commons.httpclient=debug</pre>
-Might be useful:
-<pre class="source">log_level.org.apache.commons.httpclient.Authenticator=trace</pre>
-Show headers only
-<pre class="source">log_level.httpclient.wire.header=debug</pre>
-Full wire debug produces a lot of output; consider using separate file:
-<pre class="source">
+ Commons HttpClient Logging information can be found at <a href="http://hc.apache.org/httpclient-3.x/logging.html" target="_blank">Logging</a>
+ <div class="clear"></div><div class="note">Note that full category names are used, i.e. must include the <span class="code">org.apache</span>.</div><div class="clear"></div>
+ Info level produces no output.<br>
+ Set debug level:
+ <pre class="source">log_level.org.apache.commons.httpclient=debug</pre>
+ Might be useful:
+ <pre class="source">log_level.org.apache.commons.httpclient.Authenticator=trace</pre>
+ Show headers only
+ <pre class="source">log_level.httpclient.wire.header=debug</pre>
+ Full wire debug produces a lot of output; consider using separate file:
+ <pre class="source">
log_level.httpclient.wire=debug
log_file.httpclient=httpclient.log
</pre>
</div>
-</div><div class="section"><h1 id="httpclient_logging_examples">25.14 Apache HttpClient logging examples<a class="sectionlink" href="#httpclient_logging_examples" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="httpclient_logging_examples">20.14 Apache HttpClient logging examples<a class="sectionlink" href="#httpclient_logging_examples" title="Link to here">¶</a></h1>
<div class="description">
-Enable header wire + context logging - Best for Debugging
+ Enable header wire and context logging - Best for Debugging
<pre class="source">
log_level.org.apache.http=DEBUG
log_level.org.apache.http.wire=ERROR
</pre>
-Enable full wire + context logging
-<pre class="source">log_level.org.apache.http=DEBUG</pre>
-Enable context logging for connection management
-<pre class="source">log_level.org.apache.http.impl.conn=DEBUG</pre>
-Enable context logging for connection management / request execution
+ Enable full wire and context logging
+ <pre class="source">log_level.org.apache.http=DEBUG</pre>
+ Enable context logging for connection management
+ <pre class="source">log_level.org.apache.http.impl.conn=DEBUG</pre>
+ Enable context logging for connection management / request execution
<pre class="source">
log_level.org.apache.http.impl.conn=DEBUG
log_level.org.apache.http.impl.client=DEBUG
log_level.org.apache.http.client=DEBUG
</pre>
</div>
-</div><div class="section"><h1 id="httpclient4">25.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)<a class="sectionlink" href="#httpclient4" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="httpclient4">20.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)<a class="sectionlink" href="#httpclient4" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">hc.parameters.file</div><div class="description req-true"> define a properties file for overriding Apache HttpClient parameters<br> Uncomment this line if you put anything in hc.parameters file<br>, defaults to:hc.parameters</div><div class="required req-true">
+<div class="property"><div class="name req-true">hc.parameters.file</div><div class="description req-true">
+ Define a properties file for overriding Apache HttpClient parameters.<br>
+ Uncomment this line if you put anything in <span class="code">hc.parameters</span> file.<br>
+ Defaults to: <span class="code">hc.parameters</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient4.retrycount</div><div class="description req-true"> Number of retries to attempt<br>, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient4.retrycount</div><div class="description req-true">
+ Number of retries to attempt.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
+ No
+ </div></div>
+<div class="property"><div class="name req-true">httpclient4.idletimeout</div><div class="description req-true">
+ Idle connection timeout (in milliseconds) to apply if the server does not send <span class="code">Keep-Alive</span> headers.<br>
+ Defaults to: <span class="code">0</span> (no suggested duration for <span class="code">Keep-Alive</span>)
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient4.idletimeout</div><div class="description req-true">Idle connection timeout (Milliseconds) to apply if the server does not send Keep-Alive headers, defaults to:0 (no suggested duration for Keep-Alive))</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient4.validate_after_inactivity</div><div class="description req-true">
+ Check connections if the elapsed time (in milliseconds) since the last use of the connection
+ exceeds this value.<br>
+ Defaults to: <span class="code">2000</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient4.validate_after_inactivity</div><div class="description req-true">Check connections if the elapsed time (Milliseconds) since the last use of the connection exceeds this value<br>, defaults to:2000</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient4.time_to_live</div><div class="description req-true">
+ <abbr title="time to live">TTL</abbr> (in milliseconds) represents an absolute value.
+ No matter what, the connection will not be re-used beyond its TTL.<br>
+ Defaults to: <span class="code">2000</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient4.time_to_live</div><div class="description req-true"> TTL (in Milliseconds) represents an absolute value. No matter what, the connection will not be re-used beyond its TTL. <br>, defaults to:2000</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient4.max_body_retain_size</div><div class="description req-true">
+ Max size in bytes of <span class="code">PUT</span> body to retain in result sampler.
+ Bigger results will be clipped.<br>
+ Defaults to: <span class="code">327678</span> (bytes)
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="httpclient31">25.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)<a class="sectionlink" href="#httpclient31" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="httpclient31">20.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)<a class="sectionlink" href="#httpclient31" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">httpclient.parameters.file</div><div class="description req-true">define a properties file for overriding Commons HttpClient parameters
-See <a href="http://hc.apache.org/httpclient-3.x/preference-api.html">this</a>.
-Uncomment this line if you put anything in httpclient.parameters file</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient.parameters.file</div><div class="description req-true">
+ Define a properties file for overriding Commons HttpClient parameters.
+ See <a href="http://hc.apache.org/httpclient-3.x/preference-api.html">this</a>.
+ Uncomment this line if you put anything in <span class="code">httpclient.parameters</span> file.
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">httpclient3.retrycount</div><div class="description req-true">Number of retries to attempt, defaults to:0</div><div class="required req-true">
+<div class="property"><div class="name req-true">httpclient3.retrycount</div><div class="description req-true">
+ Number of retries to attempt.<br>
+ Defaults to: <span class="code">0</span>
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="cache_maanger">25.17 HTTP Cache Manager configuration<a class="sectionlink" href="#cache_maanger" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="cache_maanger">20.17 HTTP Cache Manager configuration<a class="sectionlink" href="#cache_maanger" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">cacheable_methods</div><div class="description req-true"><br> Space or comma separated list of methods that can be cached<br>, defaults to:GET</div><div class="required req-true">
- No
- </div></div>
-<div class="property"><div class="name req-true">cache_manager.cached_resource_mode</div><div class="description req-true"> N.B. This property is currently a temporary solution for Bug 56162<br> Since 2.12, JMeter does not create anymore a Sample Result with 204 response <br> code for a resource found in cache which is inline with what browser do.<br>, defaults to:RETURN_NO_SAMPLE</div><div class="required req-true">
+<div class="property"><div class="name req-true">cacheable_methods</div><div class="description req-true">
+ Space or comma separated list of methods that can be cached.<br>
+ Defaults to: <span class="code">GET</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true"> RETURN_200_CACHE.message</div><div class="description req-true"> You can choose between 3 modes:<br> RETURN_NO_SAMPLE (default)<br> RETURN_200_CACHE<br> RETURN_CUSTOM_STATUS<br> Those mode have the following behaviours:<br> RETURN_NO_SAMPLE : this mode returns no Sample Result, it has no additional configuration<br> RETURN_200_CACHE : this mode will return Sample Result with response code to 200 and response message to "(ex cache)", you can modify response message by setting <br>, defaults to:(ex cache)</div><div class="required req-true">
+<div class="property"><div class="name req-true">cache_manager.cached_resource_mode</div><div class="description req-true">
+ <div class="clear"></div><div class="note">N.B. This property is currently a temporary solution for <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=56162">
+ Bug
+ 56162</a>.</div><div class="clear"></div>
+ Since version 2.12, JMeter does not create anymore a Sample Result with a response
+ code of <span class="code">204</span> for a resource found in cache. This is in line with what browser do.<br>
+ You can choose between three modes:
+ <dl>
+ <dt><span class="code">RETURN_NO_SAMPLE</span> (default)</dt>
+ <dd>this mode returns no Sample Result. It has no additional configuration.</dd>
+ <dt><span class="code">RETURN_200_CACHE</span></dt>
+ <dd>this mode will return Sample Result with response code to <span class="code">200</span> and
+ response message to "<span class="code">(ex cache)</span>".</dd>
+ <dt><span class="code">RETURN_CUSTOM_STATUS</span></dt>
+ <dd>choosing this mode, response code and message have to be set by specifying
+ <span class="code">RETURN_CUSTOM_STATUS.code</span> and <span class="code">RETURN_CUSTOM_STATUS.message</span>.</dd>
+ </dl>
+ Defaults to: <span class="code">RETURN_NO_SAMPLE</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true"> RETURN_CUSTOM_STATUS.code</div><div class="description req-true"> RETURN_CUSTOM_STATUS : This mode lets you select what response code and message you want to return, if you use this mode you need to set those properties<br>, defaults to:</div><div class="required req-true">
+<div class="property"><div class="name req-true">RETURN_CUSTOM_STATUS.code</div><div class="description req-true">
+ This lets you select what response code you want to return if mode <span class="code">RETURN_CUSTOM_STATUS</span>
+ is selected.<br>
+ Defaults to empty value.
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true"> RETURN_CUSTOM_STATUS.message</div><div class="description req-true">, defaults to:</div><div class="required req-true">
+<div class="property"><div class="name req-true">RETURN_CUSTOM_STATUS.message</div><div class="description req-true">
+ This lets you select what response message you want to return if mode <span class="code">RETURN_CUSTOM_STATUS</span>
+ is selected.<br>
+ Defaults to empty value
+</div><div class="required req-true">
No
</div></div>
</div>
-</div><div class="section"><h1 id="results_file_config">25.18 Results file configuration<a class="sectionlink" href="#results_file_config" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="results_file_config">20.18 Results file configuration<a class="sectionlink" href="#results_file_config" title="Link to here">¶</a></h1>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
-<div class="property"><div class="name req-true">jmeter.save.saveservice.output_format</div><div class="description req-true"> This section helps determine how result data will be saved.<br> The commented out values are the defaults.<br> legitimate values: xml, csv, db. Only xml and csv are currently supported.<br>, defaults to:csv</div><div class="required req-true">
- No
- </div></div>
-<div class="property"><div class="name req-true">jmeter.save.saveservice.assertion_results_failure_message</div><div class="description req-true"> true when field should be saved; false otherwise<br> assertion_results_failure_message only affects CSV output<br>, defaults to:true</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.save.saveservice.output_format</div><div class="description req-true">
+ This section helps determine how result data will be saved.<br>
+ The commented out values are the defaults.<br>
+ Legitimate values: <span class="code">xml</span>, <span class="code">csv</span>, <span class="code">db</span>.<br>
+ Only <span class="code">xml</span> and <span class="code">csv</span> are currently supported.<br>
+ Defaults to: <span class="code">csv</span>
+</div><div class="required req-true">
No
</div></div>
-<div class="property"><div class="name req-true">jmeter.save.saveservice.assertion_results</div><div class="description req-true"><br> legitimate values: none, first, all<br>, defaults to:none</div><div class="required req-true">
+<div class="property"><div class="name req-true">jmeter.save.saveservice.assertion_results_failure_message</div><div class="description req-true">
[... 1996 lines stripped ...]