| <!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: Properties Reference</title><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"><link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png"><link rel="icon" href="../images/favicon.png"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="../images/mstile-144x144.png"><meta name="theme-color" content="#ffffff"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!-- |
| APACHE LOGO |
| --><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!-- |
| 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 href="#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 - configuration (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="#validation">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 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 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"> |
| 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"> |
| 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 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"> |
| 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> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| Bug |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| Bug |
| 52026</a> |
| - |
| for details |
| </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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| Bug |
| 57043</a> |
| - |
| ,<a href="http://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"> |
| 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"> |
| 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: |
| <pre class="source"> |
| gui.quick_0=ThreadGroupGui |
| gui.quick_1=HttpTestSampleGui |
| gui.quick_2=RegexExtractorGui |
| gui.quick_3=AssertionGui |
| gui.quick_4=ConstantTimerGui |
| gui.quick_5=TestActionGui |
| gui.quick_6=JSR223PostProcessor |
| 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) |
| </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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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 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 |
| #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> |
| |
| 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 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. |
| |
| <pre class="source"> |
| log_level.jmeter=INFO |
| log_level.jmeter.junit=DEBUG |
| log_level.jmeter.control=DEBUG |
| log_level.jmeter.testbeans=DEBUG |
| log_level.jmeter.engine=DEBUG |
| log_level.jmeter.threads=DEBUG |
| log_level.jmeter.gui=WARN |
| log_level.jmeter.testelement=DEBUG |
| log_level.jmeter.util=WARN |
| log_level.jmeter.protocol.http=DEBUG |
| # For CookieManager, AuthManager etc: |
| log_level.jmeter.protocol.http.control=DEBUG |
| log_level.jmeter.protocol.ftp=WARN |
| log_level.jmeter.protocol.jdbc=DEBUG |
| log_level.jmeter.protocol.java=WARN |
| log_level.jmeter.testelements.property=DEBUG |
| 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 |
| |
| Combined log file (for jmeter and jorphan) |
| <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> |
| |
| 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 |
| |
| 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> |
| </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 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"> |
| 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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| 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 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"> |
| 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 class="description"> |
| Enable header wire + 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 |
| <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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| 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"> |
| 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"> |
| 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 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"> |
| 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"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.data_type</div><div class="description req-true"><br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.label</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.response_code</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.response_data</div><div class="description req-true"> response_data is not currently supported for CSV output<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.response_data.on_error</div><div class="description req-true"> Save ResponseData for failed samples<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.response_message</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.successful</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.thread_name</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.time</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.subresults</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.assertions</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.latency</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.connect_time</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.samplerData</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.responseHeaders</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.requestHeaders</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.encoding</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.bytes</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.url</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.filename</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.hostname</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.thread_counts</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.sample_count</div><div class="description req-true">, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.idle_time</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.timestamp_format</div><div class="description req-true"> Timestamp format - this only affects CSV output files<br> legitimate values: none, ms, or a format suitable for SimpleDateFormat<br>, defaults to:ms</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.timestamp_format</div><div class="description req-true">, defaults to:yyyy/MM/dd HH:mm:ss.SSS</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.default_delimiter</div><div class="description req-true"> For use with Comma-separated value (CSV) files or other formats<br> where the fields' values are separated by specified delimiters.<br> Default:<br>, defaults to:,</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.default_delimiter</div><div class="description req-true"> For TAB, since JMeter 2.3 one can use:<br>, defaults to:\t</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.print_field_names</div><div class="description req-true"> Only applies to CSV format files:<br> Print field names as first line in CSV<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sample_variables</div><div class="description req-true"> Optional list of JMeter variable names whose values are to be saved in the result data files.<br> Use commas to separate the names. For example:<br>, defaults to:SESSION_ID,REFERENCE</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.xml_pi</div><div class="description req-true"> N.B. The current implementation saves the values in XML as attributes,<br> so the names must be valid XML names.<br> Versions of JMeter after 2.3.2 send the variable to all servers<br> to ensure that the correct data is available at the client.<br> Optional xml processing instruction for line 2 of the file:<br> Example:<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.base_prefix</div><div class="description req-true"> Prefix used to identify filenames that are relative to the current base<br>, defaults to:~/</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.save.saveservice.autoflush</div><div class="description req-true"> AutoFlush on each line written in XML or CSV output<br> Setting this to true will result in less test results data loss in case of Crash<br> but with impact on performances, particularly for intensive tests (low or no pauses)<br> Since JMeter 2.10, this is false by default<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="sample_results">25.19 Settings that affect SampleResults<a class="sectionlink" href="#sample_results" 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">sampleresult.timestamp.start</div><div class="description req-true"> Save the start time stamp instead of the end<br> This also affects the timestamp stored in result files<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sampleresult.useNanoTime</div><div class="description req-true"> Whether to use System.nanoTime() - otherwise only use System.currentTimeMillis()<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> </div><div class="description req-true"> </div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sampleresult.nanoThreadSleep</div><div class="description req-true">Use a background thread to calculate the nanoTime offset<br>. Set this to a value < 0 to disable the background thread, defaults to:5000</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="upgrade">25.20 Upgrade<a class="sectionlink" href="#upgrade" 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">upgrade_properties</div><div class="description req-true"> File that holds a record of name changes for backward compatibility issues<br>, defaults to:/bin/upgrade.properties</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="test_script_recorder">25.21 JMeter Test Script recorder configuration<a class="sectionlink" href="#test_script_recorder" 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">proxy.pause</div><div class="description req-true"><br> N.B. The element was originally called the Proxy recorder, which is why the<br> properties have the prefix "proxy".<br> If the recorder detects a gap of at least 5s (default) between HTTP requests,<br> it assumes that the user has clicked a new URL<br>, defaults to:5000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.number.requests</div><div class="description req-true"> Add numeric prefix to Sampler names (default true)<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.excludes.suggested</div><div class="description req-true"> List of URL patterns that will be added to URL Patterns to exclude<br> Separate multiple lines with ;<br>, defaults to:.*\\.(bmp|css|js|gif|ico|jpe?g|png|swf|woff)</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpsampler</div><div class="description req-true"> Change the default HTTP Sampler (currently HttpClient4)<br> Java:<br>, defaults to:HTTPSampler</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpsampler</div><div class="description req-true">or<br>, defaults to:Java</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpsampler</div><div class="description req-true"><br> Apache HTTPClient:<br>, defaults to:HTTPSampler2</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpsampler</div><div class="description req-true">or<br>, defaults to:HttpClient3.1</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpsampler</div><div class="description req-true"><br> HttpClient4.x<br>, defaults to:HttpClient4</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.httpclient.strict_rfc2616</div><div class="description req-true"> By default JMeter tries to be more lenient with RFC2616 redirects and allows<br> relative paths.<br> If you want to test strict conformance, set this value to true<br> When the property is true, JMeter follows http://tools.ietf.org/html/rfc3986#section-5.2<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.content_type_include</div><div class="description req-true"> Default content-type include filter to use<br>, defaults to:text/html|text/plain|text/xml</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.content_type_exclude</div><div class="description req-true"> Default content-type exclude filter to use<br>, defaults to:image/.*|text/css|application/.*</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.headers.remove</div><div class="description req-true"> Default headers to remove from Header Manager elements<br> (Cookie and Authorization are always removed)<br>, defaults to:If-Modified-Since,If-None-Match,Host</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.binary.types</div><div class="description req-true"> Binary content-type handling<br> These content-types will be handled by saving the request in a file:<br>, defaults to:application/x-amf,application/x-java-serialized-object</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.binary.directory</div><div class="description req-true"> The files will be saved in this directory:<br>, defaults to:user.dir</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.binary.filesuffix</div><div class="description req-true"> The files will be created with this file filesuffix:<br>, defaults to:.binary</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.redirect.disabling</div><div class="description req-true"> Whether to attempt disabling of samples that resulted from redirects<br> where the generated samples use auto-redirection<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.ssl.protocol</div><div class="description req-true"> SSL configuration<br>, defaults to:TLS</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="test_script_recorder_cert">25.22 Test Script Recorder certificate configuration<a class="sectionlink" href="#test_script_recorder_cert" 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">proxy.cert.directory</div><div class="description req-true">, defaults to:<JMeter bin directory></div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.file</div><div class="description req-true">, defaults to:proxyserver.jks</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.type</div><div class="description req-true">, defaults to:JKS</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.keystorepass</div><div class="description req-true">, defaults to:password</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.keypassword</div><div class="description req-true">, defaults to:password</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.factory</div><div class="description req-true">, defaults to:SunX509</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.alias</div><div class="description req-true"> define this property if you wish to use your own keystore<br>, defaults to:<span class="code">none</span></div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.validity</div><div class="description req-true"> The default validity for certificates created by JMeter<br>, defaults to:7</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">proxy.cert.dynamic_keys</div><div class="description req-true"> Use dynamic key generation (if supported by JMeter/JVM)<br> If false, will revert to using a single key with no certificate<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="proxy_config">25.23 JMeter Proxy configuration<a class="sectionlink" href="#proxy_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.proxyDomain</div><div class="description req-true"> use command-line flags for user-name and password<br>, defaults to:NTLM domain, if required by HTTPClient sampler</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="parser_config">25.24 HTML Parser configuration<a class="sectionlink" href="#parser_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">HTTPResponse.parsers</div><div class="description req-true"> Space-separated list of parser groups<br>, defaults to:htmlParser wmlParser cssParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">cssParser.className</div><div class="description req-true"> for each parser, there should be a parser.types and a parser.className property<br> CSS Parser based on ph-css<br>, defaults to:org.apache.jmeter.protocol.http.parser.CssParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">cssParser.types</div><div class="description req-true">, defaults to:text/css</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> see https://bz.apache.org/bugzilla/show_bug.cgi?id</div><div class="description req-true"> Define the HTML parser to be used.<br> Default parser:<br> This new parser (since 2.10) should perform better than all others<br>, defaults to:55632</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">htmlParser.className</div><div class="description req-true"> Do not comment this property<br>, defaults to:org.apache.jmeter.protocol.http.parser.LagartoBasedHtmlParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">htmlParser.className</div><div class="description req-true"> Other parsers:<br> Default parser before 2.10<br>, defaults to:org.apache.jmeter.protocol.http.parser.JTidyHTMLParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">htmlParser.className</div><div class="description req-true"> Note that Regexp extractor may detect references that have been commented out.<br> In many cases it will work OK, but you should be aware that it may generate <br> additional references.<br>, defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">htmlParser.className</div><div class="description req-true"> This parser is based on JSoup, it should be the most accurate but less performant<br> than LagartoBasedHtmlParser<br>, defaults to:org.apache.jmeter.protocol.http.parser.JsoupBasedHtmlParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">htmlParser.types</div><div class="description req-true">Used by HTTPSamplerBase to associate htmlParser with content types below <br>, defaults to:text/html application/xhtml+xml application/xml text/xml</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">wmlParser.className</div><div class="description req-true">, defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">wmlParser.types</div><div class="description req-true">Used by HTTPSamplerBase to associate wmlParser with content types below <br>, defaults to:text/vnd.wap.wml </div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="remote_batching_config">25.25 Remote batching configuration<a class="sectionlink" href="#remote_batching_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">sample_sender_client_configured</div><div class="description req-true"> How is Sample sender implementations configured:<br> - true (default) means client configuration will be used<br> - false means server configuration will be used<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> but can now also be defined using mode</div><div class="description req-true"> Remote batching support<br> Since JMeter 2.9, default is MODE_STRIPPED_BATCH, which returns samples in<br> batch mode (every 100 samples or every minute by default)<br> Note also that MODE_STRIPPED_BATCH strips response data from SampleResult, so if you need it change to<br> another mode<br> Hold retains samples until end of test (may need lots of memory)<br> Batch returns samples in batches<br> Statistical returns sample summary statistics<br> hold_samples was originally defined as a separate property,<br>, defaults to:Hold</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true"> mode can also be the class name of an implementation of org.apache.jmeter.samplers.SampleSender<br>, defaults to:Standard</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:Batch</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:Hold</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:Statistical</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">key_on_threadname</div><div class="description req-true">Set to true to key statistical samples on threadName rather than threadGroup<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:Stripped</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:StrippedBatch</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true">, defaults to:org.example.load.MySampleSender</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">num_sample_threshold</div><div class="description req-true"><br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">time_threshold</div><div class="description req-true"> Value is in milliseconds<br>, defaults to:60000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true"><br> Asynchronous sender; uses a queue and background worker process to return the samples<br>, defaults to:Asynch</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">asynch.batch.queue.size</div><div class="description req-true"> default queue size<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true"> Same as Asynch but strips response data from SampleResult<br>, defaults to:StrippedAsynch</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true"><br> DiskStore: as for Hold mode, but serialises the samples to disk, rather than saving in memory<br>, defaults to:DiskStore</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mode</div><div class="description req-true"> Same as DiskStore but strips response data from SampleResult<br>, defaults to:StrippedDiskStore</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> monitor.buffer.size</div><div class="description req-true"> Note: the mode is currently resolved on the client; <br> other properties (e.g. time_threshold) are resolved on the server.<br> To set the Monitor Health Visualiser buffer size, enter the desired value<br>, defaults to:800</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="jdbc_request">25.26 JDBC Request configuration<a class="sectionlink" href="#jdbc_request" 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">jdbcsampler.maxopenpreparedstatements</div><div class="description req-true"> Max number of PreparedStatements per Connection for PreparedStatement cache<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jdbcsampler.nullmarker</div><div class="description req-true"> String used to indicate a null value<br>, defaults to:]NULL[</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="os_sampler">25.27 OS Process Sampler configuration<a class="sectionlink" href="#os_sampler" 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">os_sampler.poll_for_timeout</div><div class="description req-true"> Polling to see if process has finished its work, used when a timeout is configured on sampler<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="tcp_sampler">25.28 TCP Sampler configuration<a class="sectionlink" href="#tcp_sampler" 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">tcp.handler</div><div class="description req-true"> The default handler class<br>, defaults to:TCPClientImpl</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> eolByte </div><div class="description req-true"><br>, defaults to: byte value for end of line</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.eolByte</div><div class="description req-true"> set this to a value outside the range -128 to +127 to skip eol checking<br>, defaults to:1000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.charset</div><div class="description req-true"><br> TCP Charset, used by org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl<br> default to Platform defaults charset as returned by Charset.defaultCharset().name()<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> status.prefix and suffix </div><div class="description req-true"><br>, defaults to: strings that enclose the status response code</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.status.prefix</div><div class="description req-true">, defaults to:Status</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.status.suffix</div><div class="description req-true">, defaults to:.</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> status.properties </div><div class="description req-true"><br>, defaults to: property file to convert codes to messages</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.status.properties</div><div class="description req-true">, defaults to:mytestfiles/tcpstatus.properties</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">tcp.binarylength.prefix.length</div><div class="description req-true"> The length prefix used by LengthPrefixedBinaryTCPClientImpl implementation<br> defaults to 2 bytes.<br>, defaults to:2</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="summariser">25.29 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)<a class="sectionlink" href="#summariser" 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">summariser.name</div><div class="description req-true"><br> Comment the following property to disable the default non-GUI summariser<br> [or change the value to rename it]<br> (applies to non-GUI mode only)<br>, defaults to:summary</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">summariser.interval</div><div class="description req-true"><br> interval between summaries (in seconds) default 30 seconds<br>, defaults to:30</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">summariser.log</div><div class="description req-true"><br> Write messages to log file<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">summariser.out</div><div class="description req-true"><br> Write messages to System.out<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="aggregate_report_graph">25.30 Aggregate Report and Aggregate Graph - configuration<a class="sectionlink" href="#aggregate_report_graph" 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">aggregate_rpt_pct1</div><div class="description req-true"><br> Percentiles to display in reports<br> Can be float value between 0 and 100<br> First percentile to display, defaults to 90%<br>, defaults to:90</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">aggregate_rpt_pct2</div><div class="description req-true"> Second percentile to display, defaults to 95%<br>, defaults to:95</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">aggregate_rpt_pct3</div><div class="description req-true"> Second percentile to display, defaults to 99%<br>, defaults to:99</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="backend">25.31 BackendListener - configuration<a class="sectionlink" href="#backend" 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">backend_metrics_window</div><div class="description req-true"><br> Backend metrics sliding window size for Percentiles, Min, Max<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="beanshell">25.32 BeanShell configuration<a class="sectionlink" href="#beanshell" 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">beanshell.server.port</div><div class="description req-true"> BeanShell Server properties<br><br> Define the port number as non-zero to start the http server on that port<br>, defaults to:9000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.server.file</div><div class="description req-true"> The telnet server will be started on the next port<br><br> Define the server initialisation file<br>, defaults to:../extras/startup.bsh</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.init.file</div><div class="description req-true"><br> Define a file to be processed at startup<br> This is processed using its own interpreter.<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.sampler.init</div><div class="description req-true"><br> Define the intialisation files for BeanShell Sampler, Function and other BeanShell elements<br> N.B. Beanshell test elements do not share interpreters.<br> Each element in each thread has its own interpreter.<br> This is retained between samples.<br>, defaults to:BeanShellSampler.bshrc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.function.init</div><div class="description req-true">, defaults to:BeanShellFunction.bshrc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.assertion.init</div><div class="description req-true">, defaults to:BeanShellAssertion.bshrc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.listener.init</div><div class="description req-true">, defaults to:etc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.postprocessor.init</div><div class="description req-true">, defaults to:etc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.preprocessor.init</div><div class="description req-true">, defaults to:etc</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">beanshell.timer.init</div><div class="description req-true">, defaults to:etc</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="mailer">25.33 MailerModel configuration<a class="sectionlink" href="#mailer" 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">mailer.successlimit</div><div class="description req-true"> The file BeanShellListeners.bshrc contains sample definitions<br> of Test and Thread Listeners.<br> Number of successful samples before a message is sent<br>, defaults to:2</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">mailer.failurelimit</div><div class="description req-true"><br> Number of failed samples before a message is sent<br>, defaults to:2</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="csv">25.34 CSVRead configuration<a class="sectionlink" href="#csv" 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">csvread.delimiter</div><div class="description req-true"> CSVRead delimiter setting (default ",")<br> Make sure that there are no trailing spaces or tabs after the delimiter<br> characters, or these will be included in the list of valid delimiters<br>, defaults to:,</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">csvread.delimiter</div><div class="description req-true">, defaults to:;</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">csvread.delimiter</div><div class="description req-true">, defaults to:!</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">csvread.delimiter</div><div class="description req-true">, defaults to:~</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> The following line has a tab after the </div><div class="description req-true">, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">csvread.delimiter</div><div class="description req-true">, defaults to: </div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="time">25.35 __time() function configuration<a class="sectionlink" href="#time" 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">time.YMD</div><div class="description req-true"><br> The properties below can be used to redefine the default formats<br>, defaults to:yyyyMMdd</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">time.HMS</div><div class="description req-true">, defaults to:HHmmss</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">time.YMDHMS</div><div class="description req-true">, defaults to:yyyyMMdd-HHmmss</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">time.USER1</div><div class="description req-true">, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">time.USER2</div><div class="description req-true">, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="csv_dataset">25.36 CSV DataSet configuration<a class="sectionlink" href="#csv_dataset" 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">csvdataset.eofstring</div><div class="description req-true"> String to return at EOF (if recycle not used)<br>, defaults to:<span class="code"><EOF></span></div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="ldap">25.37 LDAP Sampler configuration<a class="sectionlink" href="#ldap" 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">ldapsampler.max_sorted_results</div><div class="description req-true"> Maximum number of search results returned by a search that will be sorted<br> to guarantee a stable ordering (if more results then this limit are retruned<br> then no sorting is done). Set to 0 to turn off all sorting, in which case<br> "Equals" response assertions will be very likely to fail against search results.<br><br>, defaults to:1000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">assertion.equals_section_diff_len</div><div class="description req-true"> Number of characters to log for each of three sections (starting matching section, diff section,<br> ending matching section where not all sections will appear for all diffs) diff display when an Equals<br> assertion fails. So a value of 100 means a maximum of 300 characters of diff text will be displayed<br> (+ a number of extra characters like "..." and "[[["/"]]]" which are used to decorate it).<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">assertion.equals_diff_delta_start</div><div class="description req-true"> test written out to log to signify start/end of diff delta<br>, defaults to:[[[</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">assertion.equals_diff_delta_end</div><div class="description req-true">, defaults to:]]]</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="miscellaneous">25.38 Miscellaneous configuration<a class="sectionlink" href="#miscellaneous" 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">mirror.server.port</div><div class="description req-true"> If defined, then start the mirror server on the port<br>, defaults to:8081</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">oro.patterncache.size</div><div class="description req-true"> ORO PatternCacheLRU size<br>, defaults to:1000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">propertyEditorSearchPath</div><div class="description req-true">TestBeanGui<br><br>, defaults to:null</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.expertMode</div><div class="description req-true"> Turn expert mode on/off: expert mode will show expert-mode beans and properties<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.max_redirects</div><div class="description req-true"> Maximum redirects to follow in a single sequence (default 5)<br>, defaults to:5</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.max_frame_depth</div><div class="description req-true"> Maximum frame/iframe nesting depth (default 5)<br>, defaults to:5</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.separate.container</div><div class="description req-true"> Revert to BUG 51939 behaviour (no separate container for embedded resources) by setting the following false:<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.ignore_failed_embedded_resources</div><div class="description req-true"> If embedded resources download fails due to missing resources or other reasons, if this property is true<br> Parent sample will not be marked as failed <br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.parallel_download_thread_keepalive_inseconds</div><div class="description req-true">keep alive time for the parallel download threads (in seconds)<br>, defaults to:60</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.embedded_resources_use_md5</div><div class="description req-true"> Don't keep the embedded resources response data : just keep the size and the md5<br> default to false<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">httpsampler.user_defined_methods</div><div class="description req-true"> List of extra HTTP methods that should be available in select box<br>, defaults to:VERSION-CONTROL,REPORT,CHECKOUT,CHECKIN,UNCHECKOUT,MKWORKSPACE,UPDATE,LABEL,MERGE,BASELINE-CONTROL,MKACTIVITY</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sampleresult.default.encoding</div><div class="description req-true"> The encoding to be used if none is provided (default ISO-8859-1)<br>, defaults to:ISO-8859-1</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sampleresult.getbytes.body_real_size</div><div class="description req-true"> Network response size calculation method<br> Use real size: number of bytes for response body return by webserver<br> (i.e. the network bytes received for response)<br> if set to false, the (uncompressed) response data size will used (default before 2.5)<br> Include headers: add the headers size in real size<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">sampleresult.getbytes.headers_size</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">CookieManager.delete_null_cookies</div><div class="description req-true"> CookieManager behaviour - should cookies with null/empty values be deleted?<br> Default is true. Use false to revert to original behaviour<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">CookieManager.allow_variable_cookies</div><div class="description req-true"> CookieManager behaviour - should variable cookies be allowed?<br> Default is true. Use false to revert to original behaviour<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">CookieManager.save.cookies</div><div class="description req-true"> CookieManager behaviour - should Cookies be stored as variables?<br> Default is false<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">CookieManager.name.prefix</div><div class="description req-true"> CookieManager behaviour - prefix to add to cookie name before storing it as a variable<br> Default is COOKIE_; to remove the prefix, define it as one or more spaces<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">CookieManager.check.cookies</div><div class="description req-true"> CookieManager behaviour - check received cookies are valid before storing them?<br> Default is true. Use false to revert to previous behaviour<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">cookies</div><div class="description req-true"> Netscape HTTP Cookie file<br>, defaults to:cookies</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> - JDK ></div><div class="description req-true"> Ability to switch to Nashorn as default Javascript Engine used by IfController and __javaScript function<br> JMeter works as following:<br> - JDK < 8 : Rhino<br>, defaults to: 8 and javascript.use_rhino</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">javascript.use_rhino</div><div class="description req-true"> If you want to use Nashorn on JDK8, set this property to false<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.threadstop.wait</div><div class="description req-true"> Number of milliseconds to wait for a thread to stop<br>, defaults to:5000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.remote.system.exit</div><div class="description req-true">Whether to invoke System.exit(0) in server exit code after stopping RMI<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.stopfail.system.exit</div><div class="description req-true"> Whether to call System.exit(1) on failure to stop threads in non-GUI mode.<br> This only takes effect if the test was explictly requested to stop.<br> If this is disabled, it may be necessary to kill the JVM externally<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.force.system.exit</div><div class="description req-true"> Whether to force call System.exit(0) at end of test in non-GUI mode, even if<br> there were no failures and the test was not explicitly asked to stop.<br> Without this, the JVM may never exit if there are other threads spawned by<br> the test which never exit.<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.exit.check.pause</div><div class="description req-true">How long to pause (in ms) in the daemon thread before reporting that the JVM has failed to exit.<br>, If the value is < 0, the JMeter does not start the daemon thread, defaults to:2000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.nongui.port</div><div class="description req-true"> If running non-GUI, then JMeter listens on the following port for a shutdown message.<br> To disable, set the port to 1000 or less.<br>, defaults to:4445</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterengine.nongui.maxport</div><div class="description req-true"><br> If the initial port is busy, keep trying until this port is reached<br> (to disable searching, set the value less than or equal to the .port property)<br>, defaults to:4455</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeterthread.rampup.granularity</div><div class="description req-true"> How often to check for shutdown during ramp-up (milliseconds)<br>, defaults to:1000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">onload.expandtree</div><div class="description req-true">Should JMeter expand the tree when loading a test plan?<br> default value is false since JMeter 2.7<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.wrapstyleword</div><div class="description req-true">JSyntaxTextArea configuration<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.linewrap</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.codefolding</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.maxundos</div><div class="description req-true"> Set 0 to disable undo feature in JSyntaxTextArea<br>, defaults to:50</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.font.family</div><div class="description req-true"> Change the font on the (JSyntax) Text Areas. (Useful for HiDPI screens)<br>, defaults to:Hack</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsyntaxtextarea.font.size</div><div class="description req-true">, defaults to:14</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">loggerpanel.usejsyntaxtext</div><div class="description req-true"> Set this to false to disable the use of JSyntaxTextArea for the Console Logger panel <br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> Maximum size of HTML page that can be displayed; default</div><div class="description req-true">, defaults to:10 mbytes</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">view.results.tree.max_size</div><div class="description req-true"> Set to 0 to disable the size check and display the whole response<br>, defaults to:10485760</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">view.results.tree.renderers_order</div><div class="description req-true"> Order of Renderers in View Results Tree<br> Note full class names should be used for non jmeter core renderers<br> For JMeter core renderers, class names start with . and are automatically<br> prefixed with org.apache.jmeter.visualizers<br>, defaults to:.RenderAsText,.RenderAsRegexp,.RenderAsCssJQuery,.RenderAsXPath,.RenderAsHTML,.RenderAsHTMLWithEmbedded,.RenderAsDocument,.RenderAsJSON,.RenderAsXML</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> Maximum size of Document that can be parsed by Tika engine; defaut</div><div class="description req-true">, defaults to:10 * 1024 * 1024 (10MB)</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">document.max_size</div><div class="description req-true"> Set to 0 to disable the size check<br>, defaults to:0</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">JMSSampler.useSecurity.properties</div><div class="description req-true">JMS options<br> Enable the following property to stop JMS Point-to-Point Sampler from using<br> the properties java.naming.security.[principal|credentials] when creating the queue connection<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">confirm.delete.skip</div><div class="description req-true"> Set the following value to true in order to skip the delete confirmation dialogue<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jsr223.compiled_scripts_cache_size</div><div class="description req-true"> Used by JSR223 elements<br> Size of compiled scripts cache<br>, defaults to:100</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="classpath">25.39 Classpath configuration<a class="sectionlink" href="#classpath" 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">search_paths</div><div class="description req-true"> List of directories (separated by ;) to search for additional JMeter plugin classes,<br> for example new GUI elements and samplers.<br> Any jar file in such a directory will be automatically included,<br> jar files in sub directories are ignored.<br> The given value is in addition to any jars found in the lib/ext directory.<br> Do not use this for utility or plugin dependency jars.<br>, defaults to:/app1/lib;/app2/lib</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">user.classpath</div><div class="description req-true"> List of directories that JMeter will search for utility and plugin dependency classes.<br> Use your platform path separator to separate multiple paths.<br> Any jar file in such a directory will be automatically included,<br> jar files in sub directories are ignored.<br> The given value is in addition to any jars found in the lib directory.<br> All entries will be added to the class path of the system class loader<br> and also to the path of the JMeter internal loader.<br> Paths with spaces may cause problems for the JVM<br>, defaults to:../classes;../lib</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">plugin_dependency_paths</div><div class="description req-true"> List of directories (separated by ;) that JMeter will search for utility<br> and plugin dependency classes.<br> Any jar file in such a directory will be automatically included,<br> jar files in sub directories are ignored.<br> The given value is in addition to any jars found in the lib directory<br> or given by the user.classpath property.<br> All entries will be added to the path of the JMeter internal loader only.<br> For plugin dependencies this property should be used instead of user.classpath.<br>, defaults to:../dependencies/lib;../app1/;../app2/</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true"> </div><div class="description req-true"> Classpath finder<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">classfinder.functions.contain</div><div class="description req-true"> The classpath finder currently needs to load every single JMeter class to find<br> the classes it needs.<br> For non-GUI mode, it's only necessary to scan for Function classes, but all classes<br> are still loaded.<br> All current Function classes include ".function." in their name,<br> and none include ".gui." in the name, so the number of unwanted classes loaded can be<br> reduced by checking for these. However, if a valid function class name does not match<br> these restrictions, it will not be loaded. If problems are encountered, then comment<br> or change the following properties:<br>, defaults to:.functions.</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">classfinder.functions.notContain</div><div class="description req-true">, defaults to:.gui.</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="reporting">25.40 Reporting configuration<a class="sectionlink" href="#reporting" 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.reportgenerator.apdex_satisfied_threshold</div><div class="description req-true"> Sets the satisfaction threshold for the APDEX calculation (in milliseconds).<br>, defaults to:500</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.apdex_tolerated_threshold</div><div class="description req-true"> Sets the tolerance threshold for the APDEX calculation (in milliseconds).<br>, defaults to:1500</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.sample_filter</div><div class="description req-true"> Regular Expression which Indicates which samples to keep for graphs and statistics generation.<br> Empty value means no filtering<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.temp_dir</div><div class="description req-true"> Sets the temporary directory used by the generation processus if it needs file I/O operations.<br>, defaults to:temp</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.statistic_window </div><div class="description req-true"> Sets the size of the sliding window used by percentile evaluation.<br> Caution : higher value provides a better accurency but needs more memory.<br>, defaults to: 200000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.report_title</div><div class="description req-true"> Configure this property to change the report title<br>, defaults to:Apache JMeter Dashboard</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.overall_granularity</div><div class="description req-true"> Defines the overall granularity for over time graphs<br>, defaults to:60000</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimePercentiles.classname</div><div class="description req-true"> Response Time Percentiles graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimePercentilesGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimePercentiles.title</div><div class="description req-true">, defaults to:Response Time Percentiles</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeDistribution.classname</div><div class="description req-true"> Response Time Distribution graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeDistributionGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeDistribution.title</div><div class="description req-true">, defaults to:Response Time Distribution</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeDistribution.property.set_granularity</div><div class="description req-true">, defaults to:500</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.activeThreadsOverTime.classname</div><div class="description req-true"> Active Threads Over Time graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.ActiveThreadsGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.activeThreadsOverTime.title</div><div class="description req-true">, defaults to:Active Threads Over Time</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.activeThreadsOverTime.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.timeVsThreads.classname</div><div class="description req-true"> Time VS Threads graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.TimeVSThreadGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.timeVsThreads.title</div><div class="description req-true">, defaults to:Time VS Threads</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.bytesThroughputOverTime.classname</div><div class="description req-true"> Bytes Throughput Over Time graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.BytesThroughputGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.bytesThroughputOverTime.title</div><div class="description req-true">, defaults to:Bytes Throughput Over Time</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.bytesThroughputOverTime.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimesOverTime.classname</div><div class="description req-true"> Response Time Over Time graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeOverTimeGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimesOverTime.title</div><div class="description req-true">, defaults to:Response Time Over Time</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimesOverTime.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latenciesOverTime.classname</div><div class="description req-true"> Latencies Over Time graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyOverTimeGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latenciesOverTime.title</div><div class="description req-true">, defaults to:Latencies Over Time</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latenciesOverTime.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeVsRequest.classname</div><div class="description req-true"> Response Time Vs Request graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeVSRequestGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeVsRequest.title</div><div class="description req-true">, defaults to:Response Time Vs Request</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeVsRequest.exclude_controllers</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.responseTimeVsRequest.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latencyVsRequest.classname</div><div class="description req-true"> Latencies Vs Request graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyVSRequestGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latencyVsRequest.title</div><div class="description req-true">, defaults to:Latencies Vs Request</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latencyVsRequest.exclude_controllers</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.latencyVsRequest.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.hitsPerSecond.classname</div><div class="description req-true"> Hits Per Second graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.HitsPerSecondGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.hitsPerSecond.title</div><div class="description req-true">, defaults to:Hits Per Second</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.hitsPerSecond.exclude_controllers</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.hitsPerSecond.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.codesPerSecond.classname</div><div class="description req-true"> Codes Per Second graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.CodesPerSecondGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.codesPerSecond.title</div><div class="description req-true">, defaults to:Codes Per Second</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.codesPerSecond.exclude_controllers</div><div class="description req-true">, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.codesPerSecond.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.transactionsPerSecond.classname</div><div class="description req-true"> Transactions Per Second graph definition<br>, defaults to:org.apache.jmeter.report.processor.graph.impl.TransactionsPerSecondGraphConsumer</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.transactionsPerSecond.title</div><div class="description req-true">, defaults to:Transactions Per Second</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.graph.transactionsPerSecond.property.set_granularity</div><div class="description req-true">, defaults to:${jmeter.reportgenerator.overall_granularity}</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.classname</div><div class="description req-true"> HTML Export<br>, defaults to:org.apache.jmeter.report.dashboard.HtmlTemplateExporter</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.property.template_dir</div><div class="description req-true"> Sets the source directory of templated files from which the html pages are generated.<br>, defaults to:report-template</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.property.output_dir</div><div class="description req-true"> Sets the destination directory for generated html pages.<br> This will be overriden by the command line option -o <br>, defaults to:report-output</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.series_filter</div><div class="description req-true"> Regular Expression which Indicates which graph series are filtered in display<br> Empty value means no filtering<br>, defaults to:</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.filters_only_sample_series</div><div class="description req-true"> Indicates whether series filter apply only on sample series<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">jmeter.reportgenerator.exporter.html.show_controllers_only</div><div class="description req-true"> Indicates whether only controller samples are displayed on graphs that support it.<br>, defaults to:false</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="properties">25.41 Additional property files to load<a class="sectionlink" href="#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">user.properties</div><div class="description req-true">Should JMeter automatically load additional JMeter properties?<br> File name to look for (comment to disable)<br>, defaults to:user.properties</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">Should JMeter automatically load additional system properties?<br> File name to look for (comment to disable)<br>, defaults to:system.properties</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">template.files</div><div class="description req-true">Comma separated list of files that contain reference to templates and their description<br> Path must be relative to jmeter root folder<br>, defaults to:/bin/templates/templates.xml</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| </div><div class="section"><h1 id="validation">25.42 Thread Group Validation feature<a class="sectionlink" href="#validation" title="Link to here">¶</a></h1> |
| <div class="description">Validation is the name of the feature used to rapidly validate a Thread Group runs fine</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">testplan_validation.tree_cloner_class</div><div class="description req-true">Default implementation is org.apache.jmeter.gui.action.validation.TreeClonerForValidation<br> It runs validation without timers, with 1 thread and 1 iteration<br> You can implement your own policy that must extend org.apache.jmeter.engine.TreeCloner<br> JMeter will instanciate it and use it to create the Tree used to run validation on Thread Group<br>, defaults to:org.apache.jmeter.gui.action.validation.TreeClonerForValidation</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">testplan_validation.nb_threads_per_thread_group</div><div class="description req-true">Number of threads to use to validate a Thread Group<br>, defaults to:1</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">testplan_validation.ignore_timers</div><div class="description req-true">Ignore timers when validating the thread group of plan<br>, defaults to:true</div><div class="required req-true"> |
| No |
| </div></div> |
| <div class="property"><div class="name req-true">testplan_validation.number_iterations</div><div class="description req-true">Number of iterations to use to validate a Thread Group<br>, defaults to:1</div><div class="required req-true"> |
| No |
| </div></div> |
| </div> |
| <a href="#">^</a> |
| |
| </div><ul class="pagelinks"><li><a href="glossary.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="share-links"> |
| Share this page: |
| <ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright"> |
| Copyright © |
| 1999 – |
| 2016 |
| , Apache Software Foundation |
| </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache |
| feather, and the Apache JMeter logo are |
| trademarks of the |
| Apache Software Foundation. |
| </div></div><script>(function(){ |
| // fill in the current location into social links on this page. |
| "use strict"; |
| var as = document.getElementsByTagName('a'); |
| var loc = document.location.href; |
| if (!loc.toLowerCase().startsWith('http')) { |
| return; |
| } |
| for (var i=0; i<as.length; i++) { |
| var href = as[i].getAttribute('data-social-url'); |
| if (href !== null) { |
| as[i].href = href + encodeURIComponent(loc); |
| } |
| } |
| })();</script></body></html> |
