- 25 Introduction
- 25.1 Language
- 25.2 XML Parser
- 25.3 SSL configuration
- 25.4 Look and Feel configuration
- 25.5 Toolbar display
- 25.6 JMX Backup configuration
- 25.7 Remote hosts and RMI configuration
- 25.8 Include Controller
- 25.9 Logging Configuration
- 25.10 HTTP Java configuration
- 25.11 Commons and Apache HttpClient common properties
- 25.12 Kerberos properties
- 25.13 Sample logging levels for Commons HttpClient
- 25.14 Apache HttpClient logging examples
- 25.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)
- 25.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)
- 25.17 HTTP Cache Manager configuration
- 25.18 Results file configuration
- 25.19 Settings that affect SampleResults
- 25.20 Upgrade
- 25.21 JMeter Test Script recorder configuration
- 25.22 Test Script Recorder certificate configuration
- 25.23 JMeter Proxy configuration
- 25.24 HTML Parser configuration
- 25.25 Remote batching configuration
- 25.26 JDBC Request configuration
- 25.27 OS Process Sampler configuration
- 25.28 TCP Sampler configuration
- 25.29 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)
- 25.30 Aggregate Report and Aggregate Graph - configuration
- 25.31 BackendListener - configuration
- 25.32 BeanShell configuration
- 25.33 MailerModel configuration
- 25.34 CSVRead configuration
- 25.35 __time() function configuration
- 25.36 CSV DataSet configuration
- 25.37 LDAP Sampler configuration
- 25.38 Miscellaneous configuration
- 25.39 Classpath configuration
- 25.40 Reporting configuration
- 25.41 Additional property files to load
- 25.42 Thread Group Validation feature
25 Introduction¶
This document describes JMeter properties. The properties present in jmeter.properties or reportgenerator.properties should be set in the user.properties file. These properties are only taken into account after restarting JMeter as they are usually resolved when the class is loaded.
25.1 Language¶
Parameters
Attribute
Description
Required
language
Preferred GUI language. Comment out to use the JVM default locale's language.
, example:
, example:
language=en
No
locales.add
Additional locale(s) to add to the displayed list.
The current default list is: en, fr, de, no, es, tr, ja, zh_CN, zh_TW, pl, pt_BR
see JMeterMenuBar#makeLanguageMenu()]
The entries are a comma-separated list of language names
, Example:
The current default list is: en, fr, de, no, es, tr, ja, zh_CN, zh_TW, pl, pt_BR
see JMeterMenuBar#makeLanguageMenu()]
The entries are a comma-separated list of language names
, Example:
locales.add=zu
No
25.2 XML Parser¶
Parameters
Attribute
Description
Required
xpath.namespace.config
Path to a Properties file containing Namespace mapping in the form prefix=Namespace, Example:
ns=http://biz.aol.com/schema/2006-12-18
No
25.3 SSL configuration¶
SSL (Java) System properties are now in system.properties
JMeter no longer converts javax.xxx property entries in this file into System properties.
These must now be defined in the system.properties file or on the command-line.
The system.properties file gives more flexibility.
JMeter no longer converts javax.xxx property entries in this file into System properties.
These must now be defined in the system.properties file or on the command-line.
The system.properties file gives more flexibility.
https.sessioncontext.shared
By default, SSL session contexts are now created per-thread, rather than being shared.
The old behaviour can be enabled by setting this property to true. Defaults to: false
The old behaviour can be enabled by setting this property to true. Defaults to: false
No
https.default.protocol
Be aware that https default protocol may vary depending on the version of JVM
See Diagnosing TLS, SSL and HTTPS and
Bug
58236
-
Default HTTPS protocol level:
https.default.protocol=TLSThis may need to be changed to:
https.default.protocol=SSLv3
No
Parameters
Attribute
Description
Required
https.socket.protocols
List of protocols to enable. You may have to select only a subset if you find issues with target server.
This is needed when server does not support Socket version negotiation, this can lead to errors like: javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated or java.net.SocketException: Connection reset
, see Bug 54759 - , example:
This is needed when server does not support Socket version negotiation, this can lead to errors like: javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated or java.net.SocketException: Connection reset
, see Bug 54759 - , example:
https.socket.protocols=SSLv2Hello SSLv3 TLSv1
No
https.use.cached.ssl.context
Control if we allow reuse of cached SSL context between iterations
set the value to 'false' to reset the SSL context each iteration
, defaults to:true
set the value to 'false' to reset the SSL context each iteration
, defaults to:true
No
https.keyStoreStartIndex
Start index to be used with keystores with many entries
The default is to use entry 0, i.e. the first
, defaults to:0
The default is to use entry 0, i.e. the first
, defaults to:0
No
https.keyStoreEndIndex
End index to be used with keystores with many entries
, defaults to:0
, defaults to:0
No
25.4 Look and Feel configuration¶
Parameters
Attribute
Description
Required
jmeter.laf.windows_xp
Classname of the Swing default UI
The LAF classnames that are available are now displayed as ToolTip text
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 UIManager.get<name>LookAndFeelClassName().
LAF can be overridden by os.name (lowercased, spaces replaced by '_')
Sample os.name LAF:
, example:
, example
The LAF classnames that are available are now displayed as ToolTip text
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 UIManager.get<name>LookAndFeelClassName().
LAF can be overridden by os.name (lowercased, spaces replaced by '_')
Sample os.name LAF:
, example:
jmeter.laf.windows_xp=javax.swing.plaf.metal.MetalLookAndFeelFailing that, the OS family = os.name, but only up to first space: Sample OS family LAF:
, example
jmeter.laf.windows=com.sun.java.swing.plaf.windows.WindowsLookAndFeelMac apparently looks better with the System LAF set through
jmeter.laf.mac=System. Failing that, the JMeter default laf can be defined through:
jmeter.laf=SystemIf 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 Bug 52026 - for details
No
jmeter.loggerpanel.display
LoggerPanel display
defaults to:false
defaults to:false
No
jmeter.loggerpanel.enable_when_closed
Enable LogViewer Panel to receive log event even if closed
Enabled since 2.12
Note this has some impact on performances, but as GUI mode must
not be used for Load Test it is acceptable
, defaults to:true
Enabled since 2.12
Note this has some impact on performances, but as GUI mode must
not be used for Load Test it is acceptable
, defaults to:true
No
jmeter.loggerpanel.maxlength
Max characters kept in LoggerPanel, 0 means no limit
, defaults to:80000
, defaults to:80000
No
25.5 Toolbar display¶
Parameters
Attribute
Description
Required
jmeter.toolbar.icons
Toolbar icon definitions
, defaults to org/apache/jmeter/images/toolbar/icons-toolbar.properties
, defaults to org/apache/jmeter/images/toolbar/icons-toolbar.properties
No
jmeter.toolbar
Toolbar list
, defaults to:
, defaults to:
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
No
jmeter.toolbar.icons.size
Available sizes are: 22x22, 32x32, 48x48. Suggested value for HiDPI mode is
jmeter.toolbar.icons.size=48x48, defaults to:22x22
No
jmeter.icons
Icon definitions. Alternate set:
defaults to:org/apache/jmeter/images/icon.properties
jmeter.icons=org/apache/jmeter/images/icon_1.properties, Historical icon set (deprecated):
jmeter.icons=org/apache/jmeter/images/icon_old.properties
defaults to:org/apache/jmeter/images/icon.properties
No
jmeter.tree.icons.size
Available sizes are: 19x19, 24x24, 32x32, 48x48. Useful for HiDPI display (see below)
, defaults to:19x19Suggested value for HiDPI screen like 3200x1800 is defaults to:32x32
, defaults to:19x19Suggested value for HiDPI screen like 3200x1800 is defaults to:32x32
No
jmeter.hidpi.mode
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
, defaults to:false
, defaults to:false
No
jmeter.hidpi.scale.factor
HiDPI scale factor, suggested value for HiDPI: 2.0, defaults to:1.0
No
not_in_menu
Components to not display in JMeter GUI (GUI class name or static label)
These elements are deprecated and will be removed in next version:
These elements are deprecated and will be removed in next version:
MongoDB Script, MongoDB Source Config, Distribution Graph, Spline Visualizerdefaults to:
org.apache.jmeter.protocol.mongodb.sampler.MongoScriptSampler, org.apache.jmeter.protocol.mongodb.config.MongoSourceElement, org.apache.jmeter.visualizers.DistributionGraphVisualizer, org.apache.jmeter.visualizers.SplineVisualizer
No
undo.history.size
Number of items in undo history
Feature is disabled by default (0) due to known and not fixed bugs Bug 57043 - , Bug 57039 - and Bug 57040 - . Set it to a number > 0 (25 can be a good default)
The bigger it is, the more it consumes memory, defaults to:0
Feature is disabled by default (0) due to known and not fixed bugs Bug 57043 - , Bug 57039 - and Bug 57040 - . Set it to a number > 0 (25 can be a good default)
The bigger it is, the more it consumes memory, defaults to:0
No
gui.quick_X
Hotkeys to add JMeter components where X is the shortcut key, for example:
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=ViewResultsFullVisualizerAbove code will add elements when you press Ctrl+0 .. Ctrl+9 (Command+0 .. Command+9 on Mac)
No
25.6 JMX Backup configuration¶
Parameters
Attribute
Description
Required
jmeter.gui.action.save.backup_on_save
Enable auto backups of the .jmx file when a test plan is saved.
When enabled, before the .jmx is saved, it will be backed up to the directory pointed
by the jmeter.gui.action.save.backup_directory property (see below). Backup file names are built
after the jmx file being saved. For example, saving test-plan.jmx will create a test-plan-000012.jmx
in the backup directory provided that the last created backup file is test-plan-000011.jmx.
Default value is true indicating that auto backups are enabled
, defaults to:true
When enabled, before the .jmx is saved, it will be backed up to the directory pointed
by the jmeter.gui.action.save.backup_directory property (see below). Backup file names are built
after the jmx file being saved. For example, saving test-plan.jmx will create a test-plan-000012.jmx
in the backup directory provided that the last created backup file is test-plan-000011.jmx.
Default value is true indicating that auto backups are enabled
, defaults to:true
No
jmeter.gui.action.save.backup_directory
Set the backup directory path where JMX backups will be created upon save in the GUI.
If not set (what it defaults to) then backup files will be created in
a sub-directory of the JMeter base installation. If set and the directory does not exist, it will be created.
, defaults to:${JMETER_HOME}/backups
If not set (what it defaults to) then backup files will be created in
a sub-directory of the JMeter base installation. If set and the directory does not exist, it will be created.
, defaults to:${JMETER_HOME}/backups
No
jmeter.gui.action.save.keep_backup_max_hours
Set the maximum time (in hours) that backup files should be preserved since the save time.
By default no expiration time is set which means we keep backups for ever.
, defaults to:0
By default no expiration time is set which means we keep backups for ever.
, defaults to:0
No
jmeter.gui.action.save.keep_backup_max_count
Set the maximum number of backup files that should be preserved. By default 10 backups will be preserved.
Setting this to zero will cause the backups to not being deleted (unless keep_backup_max_hours is set to a non zero value)
, defaults to:10
Setting this to zero will cause the backups to not being deleted (unless keep_backup_max_hours is set to a non zero value)
, defaults to:10
No
25.7 Remote hosts and RMI configuration¶
Parameters
Attribute
Description
Required
remote_hosts
Remote Hosts - comma delimited, example
remote_hosts=localhost:1099,localhost:2010, defaults to:127.0.0.1.
No
server_port
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):
On the client: set remote_hosts=server:1234
defaults to:1099
- set server_port=1234
- start rmiregistry with port 1234
- SET SERVER_PORT=1234
- JMETER-SERVER
On the client: set remote_hosts=server:1234
defaults to:1099
No
client.rmi.localport
Parameter that controls the RMI port used by the RemoteSampleListenerImpl (The Controler)
Default value is 0 which means port is randomly assigned
You may need to open Firewall port on the Controller machine
, defaults to:0
Default value is 0 which means port is randomly assigned
You may need to open Firewall port on the Controller machine
, defaults to:0
No
client.tries
When distributed test is starting, there may be several attempts to initialize
remote engines. By default, only single try is made. Increase following property
to make it retry for additional times
, defaults to:1
remote engines. By default, only single try is made. Increase following property
to make it retry for additional times
, defaults to:1
No
client.retries_delay
If there is initialization retries, following property sets delay between attempts
, defaults to:5000
, defaults to:5000
No
client.continue_on_fail
When all initialization tries was made, test will fail if some remote engines are failed
Set following property to true to ignore failed nodes and proceed with test
, defaults to:false
Set following property to true to ignore failed nodes and proceed with test
, defaults to:false
No
server.rmi.port
To change the default port (1099) used to access the server:
, defaults to:1234
, defaults to:1234
No
server.rmi.localport
To use a specific port for the JMeter server engine, define
the following property before starting the server:
, defaults to:4000
the following property before starting the server:
, defaults to:4000
No
server.rmi.create
From JMeter 2.3.1, the jmeter server creates the RMI registry as part of the server process.
To stop the server creating the RMI registry:
, defaults to:false
To stop the server creating the RMI registry:
, defaults to:false
No
server.exitaftertest
From JMeter 2.3.1, define the following property to cause JMeter to exit after the first test
, defaults to:true
, defaults to:true
No
25.8 Include Controller¶
Parameters
Attribute
Description
Required
includecontroller.prefix
Prefix used by IncludeController when building file name
, defaults to empty value
, defaults to empty value
No
25.9 Logging Configuration¶
JMeter uses Avalon (Excalibur) LogKit
The Logging Format is described here
Default format:
log_format=%{time:yyyy/MM/dd HH:mm:ss} %5.5{priority} - %{category}: %{message} %{throwable}\n is automatically added to the end of the string Predefined formats in the JMeter LoggingManager:
#log_format_type=default #log_format_type=thread_prefix #log_format_type=thread_suffixdefault is as above. thread_prefix adds the thread name as a prefix to the category. thread_suffix adds the thread name as a suffix to the category
Thread name is not included by default, as it requires extra processing.
To change the logging format, define either log_format_type or log_format
If both are defined, the type takes precedence. Note that these properties cannot be defined using the -J or -D 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:
- FATAL_ERROR
- ERROR
- WARN
- INFO
- DEBUG
log_level.[package_name].[classname]=[PRIORITY_LEVEL]But omit org.apache from the package name. The classname is optional. Further examples below.
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# You can specify a different log file for different categories via:
log_file.[category]=[filename]category is equivalent to the package/class names described above Combined log file (for jmeter and jorphan)
log_file=jmeter.logTo redirect logging to standard output, try the following (it will probably report an error, but output will be to stdout):
log_file=Or define separate logs if required:
log_file.jorphan=jorphan.log log_file.jmeter=jmeter.logIf the filename contains paired single-quotes, then the name is processed as a SimpleDateFormat format applied to the current date, for example:
log_file='jmeter_'yyyyMMddHHmmss'.tmp'When JMeter starts, it sets the system property: org.apache.commons.logging.Log to org.apache.commons.logging.impl.LogKitLogger 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.
log_config=logkit.xml
25.10 HTTP Java configuration¶
Parameters
Attribute
Description
Required
http.java.sampler.retries
Number of connection retries performed by HTTP Java sampler before giving up. 0 means no retry since version 3.0, defaults to:0
No
25.11 Commons and Apache HttpClient common properties¶
Parameters
Attribute
Description
Required
httpclient.timeout
set the socket timeout (or use the parameter http.socket.timeout)
for AJP Sampler and HttpClient3 implementation.
Note for HttpClient3 implementation it is better to use GUI to set timeout or use http.socket.timeout in httpclient.parameters. Value is in milliseconds, 0 means no timeout, defaults to:0
for AJP Sampler and HttpClient3 implementation.
Note for HttpClient3 implementation it is better to use GUI to set timeout or use http.socket.timeout in httpclient.parameters. Value is in milliseconds, 0 means no timeout, defaults to:0
No
httpclient.version
Set the http version, defaults to:1.1 (or use the parameter http.protocol.version)
No
httpclient.socket.http.cps
Set characters per second to a value > 0 to emulate slow connections
, defaults to:0
, defaults to:0
No
httpclient.socket.https.cps
Same as before but for https, defaults to:0
No
httpclient.loopback
Enable loopback protocol
, defaults to:true
, defaults to:true
No
httpclient.localaddress
Define the local host address to be used for multi-homed hosts, example
httpclient.localaddress=1.2.3.4
No
25.12 Kerberos properties¶
Parameters
Attribute
Description
Required
kerberos_jaas_application
AuthManager Kerberos configuration
Name of application module used in jaas.conf, defaults to:JMeter
Name of application module used in jaas.conf, defaults to:JMeter
No
kerberos.spnego.strip_port
Should ports be stripped from urls before constructing SPNs for spnego authentication, defaults to:true
No
25.13 Sample logging levels for Commons HttpClient¶
Commons HttpClient Logging information can be found at Logging
Note that full category names are used, i.e. must include the org.apache.
Info level produces no output.
Set debug level:
log_level.org.apache.commons.httpclient=debugMight be useful:
log_level.org.apache.commons.httpclient.Authenticator=traceShow headers only
log_level.httpclient.wire.header=debugFull wire debug produces a lot of output; consider using separate file:
log_level.httpclient.wire=debug log_file.httpclient=httpclient.log
25.14 Apache HttpClient logging examples¶
Enable header wire + context logging - Best for Debugging
log_level.org.apache.http=DEBUG log_level.org.apache.http.wire=ERROREnable full wire + context logging
log_level.org.apache.http=DEBUGEnable context logging for connection management
log_level.org.apache.http.impl.conn=DEBUGEnable context logging for connection management / request execution
log_level.org.apache.http.impl.conn=DEBUG log_level.org.apache.http.impl.client=DEBUG log_level.org.apache.http.client=DEBUG
25.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)¶
Parameters
Attribute
Description
Required
hc.parameters.file
define a properties file for overriding Apache HttpClient parameters
Uncomment this line if you put anything in hc.parameters file
, defaults to:hc.parameters
Uncomment this line if you put anything in hc.parameters file
, defaults to:hc.parameters
No
httpclient4.retrycount
Number of retries to attempt
, defaults to:0
, defaults to:0
No
httpclient4.idletimeout
Idle connection timeout (Milliseconds) to apply if the server does not send Keep-Alive headers, defaults to:0 (no suggested duration for Keep-Alive))
No
httpclient4.validate_after_inactivity
Check connections if the elapsed time (Milliseconds) since the last use of the connection exceeds this value
, defaults to:2000
, defaults to:2000
No
httpclient4.time_to_live
TTL (in Milliseconds) represents an absolute value. No matter what, the connection will not be re-used beyond its TTL.
, defaults to:2000
, defaults to:2000
No
25.16 Apache HttpComponents Commons HTTPClient configuration (HTTPClient 3.1)¶
Parameters
Attribute
Description
Required
httpclient.parameters.file
define a properties file for overriding Commons HttpClient parameters
See this.
Uncomment this line if you put anything in httpclient.parameters file
No
httpclient3.retrycount
Number of retries to attempt, defaults to:0
No
25.17 HTTP Cache Manager configuration¶
Parameters
Attribute
Description
Required
cacheable_methods
Space or comma separated list of methods that can be cached
, defaults to:GET
No
cache_manager.cached_resource_mode
N.B. This property is currently a temporary solution for Bug 56162
Since 2.12, JMeter does not create anymore a Sample Result with 204 response
code for a resource found in cache which is inline with what browser do.
, defaults to:RETURN_NO_SAMPLE
Since 2.12, JMeter does not create anymore a Sample Result with 204 response
code for a resource found in cache which is inline with what browser do.
, defaults to:RETURN_NO_SAMPLE
No
RETURN_200_CACHE.message
You can choose between 3 modes:
RETURN_NO_SAMPLE (default)
RETURN_200_CACHE
RETURN_CUSTOM_STATUS
Those mode have the following behaviours:
RETURN_NO_SAMPLE : this mode returns no Sample Result, it has no additional configuration
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
, defaults to:(ex cache)
RETURN_NO_SAMPLE (default)
RETURN_200_CACHE
RETURN_CUSTOM_STATUS
Those mode have the following behaviours:
RETURN_NO_SAMPLE : this mode returns no Sample Result, it has no additional configuration
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
, defaults to:(ex cache)
No
RETURN_CUSTOM_STATUS.code
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
, defaults to:
, defaults to:
No
RETURN_CUSTOM_STATUS.message
, defaults to:
No
25.18 Results file configuration¶
Parameters
Attribute
Description
Required
jmeter.save.saveservice.output_format
This section helps determine how result data will be saved.
The commented out values are the defaults.
legitimate values: xml, csv, db. Only xml and csv are currently supported.
, defaults to:csv
The commented out values are the defaults.
legitimate values: xml, csv, db. Only xml and csv are currently supported.
, defaults to:csv
No
jmeter.save.saveservice.assertion_results_failure_message
true when field should be saved; false otherwise
assertion_results_failure_message only affects CSV output
, defaults to:true
assertion_results_failure_message only affects CSV output
, defaults to:true
No
jmeter.save.saveservice.assertion_results
legitimate values: none, first, all
, defaults to:none
No
jmeter.save.saveservice.data_type
, defaults to:true
No
jmeter.save.saveservice.label
, defaults to:true
No
jmeter.save.saveservice.response_code
, defaults to:true
No
jmeter.save.saveservice.response_data
response_data is not currently supported for CSV output
, defaults to:false
, defaults to:false
No
jmeter.save.saveservice.response_data.on_error
Save ResponseData for failed samples
, defaults to:false
, defaults to:false
No
jmeter.save.saveservice.response_message
, defaults to:true
No
jmeter.save.saveservice.successful
, defaults to:true
No
jmeter.save.saveservice.thread_name
, defaults to:true
No
jmeter.save.saveservice.time
, defaults to:true
No
jmeter.save.saveservice.subresults
, defaults to:true
No
jmeter.save.saveservice.assertions
, defaults to:true
No
jmeter.save.saveservice.latency
, defaults to:true
No
jmeter.save.saveservice.connect_time
, defaults to:false
No
jmeter.save.saveservice.samplerData
, defaults to:false
No
jmeter.save.saveservice.responseHeaders
, defaults to:false
No
jmeter.save.saveservice.requestHeaders
, defaults to:false
No
jmeter.save.saveservice.encoding
, defaults to:false
No
jmeter.save.saveservice.bytes
, defaults to:true
No
jmeter.save.saveservice.url
, defaults to:false
No
jmeter.save.saveservice.filename
, defaults to:false
No
jmeter.save.saveservice.hostname
, defaults to:false
No
jmeter.save.saveservice.thread_counts
, defaults to:true
No
jmeter.save.saveservice.sample_count
, defaults to:false
No
jmeter.save.saveservice.idle_time
, defaults to:true
No
jmeter.save.saveservice.timestamp_format
Timestamp format - this only affects CSV output files
legitimate values: none, ms, or a format suitable for SimpleDateFormat
, defaults to:ms
legitimate values: none, ms, or a format suitable for SimpleDateFormat
, defaults to:ms
No
jmeter.save.saveservice.timestamp_format
, defaults to:yyyy/MM/dd HH:mm:ss.SSS
No
jmeter.save.saveservice.default_delimiter
For use with Comma-separated value (CSV) files or other formats
where the fields' values are separated by specified delimiters.
Default:
, defaults to:,
where the fields' values are separated by specified delimiters.
Default:
, defaults to:,
No
jmeter.save.saveservice.default_delimiter
For TAB, since JMeter 2.3 one can use:
, defaults to:\t
, defaults to:\t
No
jmeter.save.saveservice.print_field_names
Only applies to CSV format files:
Print field names as first line in CSV
, defaults to:true
Print field names as first line in CSV
, defaults to:true
No
sample_variables
Optional list of JMeter variable names whose values are to be saved in the result data files.
Use commas to separate the names. For example:
, defaults to:SESSION_ID,REFERENCE
Use commas to separate the names. For example:
, defaults to:SESSION_ID,REFERENCE
No
jmeter.save.saveservice.xml_pi
N.B. The current implementation saves the values in XML as attributes,
so the names must be valid XML names.
Versions of JMeter after 2.3.2 send the variable to all servers
to ensure that the correct data is available at the client.
Optional xml processing instruction for line 2 of the file:
Example:
, defaults to:
so the names must be valid XML names.
Versions of JMeter after 2.3.2 send the variable to all servers
to ensure that the correct data is available at the client.
Optional xml processing instruction for line 2 of the file:
Example:
, defaults to:
No
jmeter.save.saveservice.base_prefix
Prefix used to identify filenames that are relative to the current base
, defaults to:~/
, defaults to:~/
No
jmeter.save.saveservice.autoflush
AutoFlush on each line written in XML or CSV output
Setting this to true will result in less test results data loss in case of Crash
but with impact on performances, particularly for intensive tests (low or no pauses)
Since JMeter 2.10, this is false by default
, defaults to:false
Setting this to true will result in less test results data loss in case of Crash
but with impact on performances, particularly for intensive tests (low or no pauses)
Since JMeter 2.10, this is false by default
, defaults to:false
No
25.19 Settings that affect SampleResults¶
Parameters
Attribute
Description
Required
sampleresult.timestamp.start
Save the start time stamp instead of the end
This also affects the timestamp stored in result files
, defaults to:true
This also affects the timestamp stored in result files
, defaults to:true
No
sampleresult.useNanoTime
Whether to use System.nanoTime() - otherwise only use System.currentTimeMillis()
, defaults to:true
, defaults to:true
No
No
sampleresult.nanoThreadSleep
Use a background thread to calculate the nanoTime offset
. Set this to a value < 0 to disable the background thread, defaults to:5000
. Set this to a value < 0 to disable the background thread, defaults to:5000
No
25.20 Upgrade¶
Parameters
Attribute
Description
Required
upgrade_properties
File that holds a record of name changes for backward compatibility issues
, defaults to:/bin/upgrade.properties
, defaults to:/bin/upgrade.properties
No
25.21 JMeter Test Script recorder configuration¶
Parameters
Attribute
Description
Required
proxy.pause
N.B. The element was originally called the Proxy recorder, which is why the
properties have the prefix "proxy".
If the recorder detects a gap of at least 5s (default) between HTTP requests,
it assumes that the user has clicked a new URL
, defaults to:5000
No
proxy.number.requests
Add numeric prefix to Sampler names (default true)
, defaults to:true
, defaults to:true
No
proxy.excludes.suggested
List of URL patterns that will be added to URL Patterns to exclude
Separate multiple lines with ;
, defaults to:.*\\.(bmp|css|js|gif|ico|jpe?g|png|swf|woff)
Separate multiple lines with ;
, defaults to:.*\\.(bmp|css|js|gif|ico|jpe?g|png|swf|woff)
No
jmeter.httpsampler
Change the default HTTP Sampler (currently HttpClient4)
Java:
, defaults to:HTTPSampler
Java:
, defaults to:HTTPSampler
No
jmeter.httpsampler
or
, defaults to:Java
, defaults to:Java
No
jmeter.httpsampler
Apache HTTPClient:
, defaults to:HTTPSampler2
No
jmeter.httpsampler
or
, defaults to:HttpClient3.1
, defaults to:HttpClient3.1
No
jmeter.httpsampler
HttpClient4.x
, defaults to:HttpClient4
No
jmeter.httpclient.strict_rfc2616
By default JMeter tries to be more lenient with RFC2616 redirects and allows
relative paths.
If you want to test strict conformance, set this value to true
When the property is true, JMeter follows http://tools.ietf.org/html/rfc3986#section-5.2
, defaults to:false
relative paths.
If you want to test strict conformance, set this value to true
When the property is true, JMeter follows http://tools.ietf.org/html/rfc3986#section-5.2
, defaults to:false
No
proxy.content_type_include
Default content-type include filter to use
, defaults to:text/html|text/plain|text/xml
, defaults to:text/html|text/plain|text/xml
No
proxy.content_type_exclude
Default content-type exclude filter to use
, defaults to:image/.*|text/css|application/.*
, defaults to:image/.*|text/css|application/.*
No
proxy.headers.remove
Default headers to remove from Header Manager elements
(Cookie and Authorization are always removed)
, defaults to:If-Modified-Since,If-None-Match,Host
(Cookie and Authorization are always removed)
, defaults to:If-Modified-Since,If-None-Match,Host
No
proxy.binary.types
Binary content-type handling
These content-types will be handled by saving the request in a file:
, defaults to:application/x-amf,application/x-java-serialized-object
These content-types will be handled by saving the request in a file:
, defaults to:application/x-amf,application/x-java-serialized-object
No
proxy.binary.directory
The files will be saved in this directory:
, defaults to:user.dir
, defaults to:user.dir
No
proxy.binary.filesuffix
The files will be created with this file filesuffix:
, defaults to:.binary
, defaults to:.binary
No
proxy.redirect.disabling
Whether to attempt disabling of samples that resulted from redirects
where the generated samples use auto-redirection
, defaults to:true
where the generated samples use auto-redirection
, defaults to:true
No
proxy.ssl.protocol
SSL configuration
, defaults to:TLS
, defaults to:TLS
No
25.22 Test Script Recorder certificate configuration¶
Parameters
Attribute
Description
Required
proxy.cert.directory
, defaults to:<JMeter bin directory>
No
proxy.cert.file
, defaults to:proxyserver.jks
No
proxy.cert.type
, defaults to:JKS
No
proxy.cert.keystorepass
, defaults to:password
No
proxy.cert.keypassword
, defaults to:password
No
proxy.cert.factory
, defaults to:SunX509
No
proxy.cert.alias
define this property if you wish to use your own keystore
, defaults to:none
, defaults to:none
No
proxy.cert.validity
The default validity for certificates created by JMeter
, defaults to:7
, defaults to:7
No
proxy.cert.dynamic_keys
Use dynamic key generation (if supported by JMeter/JVM)
If false, will revert to using a single key with no certificate
, defaults to:true
If false, will revert to using a single key with no certificate
, defaults to:true
No
25.23 JMeter Proxy configuration¶
Parameters
Attribute
Description
Required
http.proxyDomain
use command-line flags for user-name and password
, defaults to:NTLM domain, if required by HTTPClient sampler
, defaults to:NTLM domain, if required by HTTPClient sampler
No
25.24 HTML Parser configuration¶
Parameters
Attribute
Description
Required
HTTPResponse.parsers
Space-separated list of parser groups
, defaults to:htmlParser wmlParser cssParser
, defaults to:htmlParser wmlParser cssParser
No
cssParser.className
for each parser, there should be a parser.types and a parser.className property
CSS Parser based on ph-css
, defaults to:org.apache.jmeter.protocol.http.parser.CssParser
CSS Parser based on ph-css
, defaults to:org.apache.jmeter.protocol.http.parser.CssParser
No
cssParser.types
, defaults to:text/css
No
see https://bz.apache.org/bugzilla/show_bug.cgi?id
Define the HTML parser to be used.
Default parser:
This new parser (since 2.10) should perform better than all others
, defaults to:55632
Default parser:
This new parser (since 2.10) should perform better than all others
, defaults to:55632
No
htmlParser.className
Do not comment this property
, defaults to:org.apache.jmeter.protocol.http.parser.LagartoBasedHtmlParser
, defaults to:org.apache.jmeter.protocol.http.parser.LagartoBasedHtmlParser
No
htmlParser.className
Other parsers:
Default parser before 2.10
, defaults to:org.apache.jmeter.protocol.http.parser.JTidyHTMLParser
Default parser before 2.10
, defaults to:org.apache.jmeter.protocol.http.parser.JTidyHTMLParser
No
htmlParser.className
Note that Regexp extractor may detect references that have been commented out.
In many cases it will work OK, but you should be aware that it may generate
additional references.
, defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser
In many cases it will work OK, but you should be aware that it may generate
additional references.
, defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser
No
htmlParser.className
This parser is based on JSoup, it should be the most accurate but less performant
than LagartoBasedHtmlParser
, defaults to:org.apache.jmeter.protocol.http.parser.JsoupBasedHtmlParser
than LagartoBasedHtmlParser
, defaults to:org.apache.jmeter.protocol.http.parser.JsoupBasedHtmlParser
No
htmlParser.types
Used by HTTPSamplerBase to associate htmlParser with content types below
, defaults to:text/html application/xhtml+xml application/xml text/xml
, defaults to:text/html application/xhtml+xml application/xml text/xml
No
wmlParser.className
, defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser
No
wmlParser.types
Used by HTTPSamplerBase to associate wmlParser with content types below
, defaults to:text/vnd.wap.wml
, defaults to:text/vnd.wap.wml
No
25.25 Remote batching configuration¶
Parameters
Attribute
Description
Required
sample_sender_client_configured
How is Sample sender implementations configured:
- true (default) means client configuration will be used
- false means server configuration will be used
, defaults to:true
- true (default) means client configuration will be used
- false means server configuration will be used
, defaults to:true
No
but can now also be defined using mode
Remote batching support
Since JMeter 2.9, default is MODE_STRIPPED_BATCH, which returns samples in
batch mode (every 100 samples or every minute by default)
Note also that MODE_STRIPPED_BATCH strips response data from SampleResult, so if you need it change to
another mode
Hold retains samples until end of test (may need lots of memory)
Batch returns samples in batches
Statistical returns sample summary statistics
hold_samples was originally defined as a separate property,
, defaults to:Hold
Since JMeter 2.9, default is MODE_STRIPPED_BATCH, which returns samples in
batch mode (every 100 samples or every minute by default)
Note also that MODE_STRIPPED_BATCH strips response data from SampleResult, so if you need it change to
another mode
Hold retains samples until end of test (may need lots of memory)
Batch returns samples in batches
Statistical returns sample summary statistics
hold_samples was originally defined as a separate property,
, defaults to:Hold
No
mode
mode can also be the class name of an implementation of org.apache.jmeter.samplers.SampleSender
, defaults to:Standard
, defaults to:Standard
No
mode
, defaults to:Batch
No
mode
, defaults to:Hold
No
mode
, defaults to:Statistical
No
key_on_threadname
Set to true to key statistical samples on threadName rather than threadGroup
, defaults to:false
, defaults to:false
No
mode
, defaults to:Stripped
No
mode
, defaults to:StrippedBatch
No
mode
, defaults to:org.example.load.MySampleSender
No
num_sample_threshold
, defaults to:100
No
time_threshold
Value is in milliseconds
, defaults to:60000
, defaults to:60000
No
mode
Asynchronous sender; uses a queue and background worker process to return the samples
, defaults to:Asynch
No
asynch.batch.queue.size
default queue size
, defaults to:100
, defaults to:100
No
mode
Same as Asynch but strips response data from SampleResult
, defaults to:StrippedAsynch
, defaults to:StrippedAsynch
No
mode
DiskStore: as for Hold mode, but serialises the samples to disk, rather than saving in memory
, defaults to:DiskStore
No
mode
Same as DiskStore but strips response data from SampleResult
, defaults to:StrippedDiskStore
, defaults to:StrippedDiskStore
No
monitor.buffer.size
Note: the mode is currently resolved on the client;
other properties (e.g. time_threshold) are resolved on the server.
To set the Monitor Health Visualiser buffer size, enter the desired value
, defaults to:800
other properties (e.g. time_threshold) are resolved on the server.
To set the Monitor Health Visualiser buffer size, enter the desired value
, defaults to:800
No
25.26 JDBC Request configuration¶
Parameters
Attribute
Description
Required
jdbcsampler.maxopenpreparedstatements
Max number of PreparedStatements per Connection for PreparedStatement cache
, defaults to:100
, defaults to:100
No
jdbcsampler.nullmarker
String used to indicate a null value
, defaults to:]NULL[
, defaults to:]NULL[
No
25.27 OS Process Sampler configuration¶
Parameters
Attribute
Description
Required
os_sampler.poll_for_timeout
Polling to see if process has finished its work, used when a timeout is configured on sampler
, defaults to:100
, defaults to:100
No
25.28 TCP Sampler configuration¶
Parameters
Attribute
Description
Required
tcp.handler
The default handler class
, defaults to:TCPClientImpl
, defaults to:TCPClientImpl
No
eolByte
, defaults to: byte value for end of line
No
tcp.eolByte
set this to a value outside the range -128 to +127 to skip eol checking
, defaults to:1000
, defaults to:1000
No
tcp.charset
TCP Charset, used by org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl
default to Platform defaults charset as returned by Charset.defaultCharset().name()
, defaults to:
No
status.prefix and suffix
, defaults to: strings that enclose the status response code
No
tcp.status.prefix
, defaults to:Status
No
tcp.status.suffix
, defaults to:.
No
status.properties
, defaults to: property file to convert codes to messages
No
tcp.status.properties
, defaults to:mytestfiles/tcpstatus.properties
No
tcp.binarylength.prefix.length
The length prefix used by LengthPrefixedBinaryTCPClientImpl implementation
defaults to 2 bytes.
, defaults to:2
defaults to 2 bytes.
, defaults to:2
No
25.29 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)¶
Parameters
Attribute
Description
Required
summariser.name
Comment the following property to disable the default non-GUI summariser
[or change the value to rename it]
(applies to non-GUI mode only)
, defaults to:summary
No
summariser.interval
interval between summaries (in seconds) default 30 seconds
, defaults to:30
No
summariser.log
Write messages to log file
, defaults to:true
No
summariser.out
Write messages to System.out
, defaults to:true
No
25.30 Aggregate Report and Aggregate Graph - configuration¶
Parameters
Attribute
Description
Required
aggregate_rpt_pct1
Percentiles to display in reports
Can be float value between 0 and 100
First percentile to display, defaults to 90%
, defaults to:90
No
aggregate_rpt_pct2
Second percentile to display, defaults to 95%
, defaults to:95
, defaults to:95
No
aggregate_rpt_pct3
Second percentile to display, defaults to 99%
, defaults to:99
, defaults to:99
No
25.31 BackendListener - configuration¶
Parameters
Attribute
Description
Required
backend_metrics_window
Backend metrics sliding window size for Percentiles, Min, Max
, defaults to:100
No
25.32 BeanShell configuration¶
Parameters
Attribute
Description
Required
beanshell.server.port
BeanShell Server properties
Define the port number as non-zero to start the http server on that port
, defaults to:9000
Define the port number as non-zero to start the http server on that port
, defaults to:9000
No
beanshell.server.file
The telnet server will be started on the next port
Define the server initialisation file
, defaults to:../extras/startup.bsh
Define the server initialisation file
, defaults to:../extras/startup.bsh
No
beanshell.init.file
Define a file to be processed at startup
This is processed using its own interpreter.
, defaults to:
No
beanshell.sampler.init
Define the intialisation files for BeanShell Sampler, Function and other BeanShell elements
N.B. Beanshell test elements do not share interpreters.
Each element in each thread has its own interpreter.
This is retained between samples.
, defaults to:BeanShellSampler.bshrc
No
beanshell.function.init
, defaults to:BeanShellFunction.bshrc
No
beanshell.assertion.init
, defaults to:BeanShellAssertion.bshrc
No
beanshell.listener.init
, defaults to:etc
No
beanshell.postprocessor.init
, defaults to:etc
No
beanshell.preprocessor.init
, defaults to:etc
No
beanshell.timer.init
, defaults to:etc
No
25.33 MailerModel configuration¶
Parameters
Attribute
Description
Required
mailer.successlimit
The file BeanShellListeners.bshrc contains sample definitions
of Test and Thread Listeners.
Number of successful samples before a message is sent
, defaults to:2
of Test and Thread Listeners.
Number of successful samples before a message is sent
, defaults to:2
No
mailer.failurelimit
Number of failed samples before a message is sent
, defaults to:2
No
25.34 CSVRead configuration¶
Parameters
Attribute
Description
Required
csvread.delimiter
CSVRead delimiter setting (default ",")
Make sure that there are no trailing spaces or tabs after the delimiter
characters, or these will be included in the list of valid delimiters
, defaults to:,
Make sure that there are no trailing spaces or tabs after the delimiter
characters, or these will be included in the list of valid delimiters
, defaults to:,
No
csvread.delimiter
, defaults to:;
No
csvread.delimiter
, defaults to:!
No
csvread.delimiter
, defaults to:~
No
The following line has a tab after the
, defaults to:
No
csvread.delimiter
, defaults to:
No
25.35 __time() function configuration¶
Parameters
Attribute
Description
Required
time.YMD
The properties below can be used to redefine the default formats
, defaults to:yyyyMMdd
No
time.HMS
, defaults to:HHmmss
No
time.YMDHMS
, defaults to:yyyyMMdd-HHmmss
No
time.USER1
, defaults to:
No
time.USER2
, defaults to:
No
25.36 CSV DataSet configuration¶
Parameters
Attribute
Description
Required
csvdataset.eofstring
String to return at EOF (if recycle not used)
, defaults to:<EOF>
, defaults to:<EOF>
No
25.37 LDAP Sampler configuration¶
Parameters
Attribute
Description
Required
ldapsampler.max_sorted_results
Maximum number of search results returned by a search that will be sorted
to guarantee a stable ordering (if more results then this limit are retruned
then no sorting is done). Set to 0 to turn off all sorting, in which case
"Equals" response assertions will be very likely to fail against search results.
, defaults to:1000
to guarantee a stable ordering (if more results then this limit are retruned
then no sorting is done). Set to 0 to turn off all sorting, in which case
"Equals" response assertions will be very likely to fail against search results.
, defaults to:1000
No
assertion.equals_section_diff_len
Number of characters to log for each of three sections (starting matching section, diff section,
ending matching section where not all sections will appear for all diffs) diff display when an Equals
assertion fails. So a value of 100 means a maximum of 300 characters of diff text will be displayed
(+ a number of extra characters like "..." and "[[["/"]]]" which are used to decorate it).
, defaults to:100
ending matching section where not all sections will appear for all diffs) diff display when an Equals
assertion fails. So a value of 100 means a maximum of 300 characters of diff text will be displayed
(+ a number of extra characters like "..." and "[[["/"]]]" which are used to decorate it).
, defaults to:100
No
assertion.equals_diff_delta_start
test written out to log to signify start/end of diff delta
, defaults to:[[[
, defaults to:[[[
No
assertion.equals_diff_delta_end
, defaults to:]]]
No
25.38 Miscellaneous configuration¶
Parameters
Attribute
Description
Required
mirror.server.port
If defined, then start the mirror server on the port
, defaults to:8081
, defaults to:8081
No
oro.patterncache.size
ORO PatternCacheLRU size
, defaults to:1000
, defaults to:1000
No
propertyEditorSearchPath
TestBeanGui
, defaults to:null
, defaults to:null
No
jmeter.expertMode
Turn expert mode on/off: expert mode will show expert-mode beans and properties
, defaults to:true
, defaults to:true
No
httpsampler.max_redirects
Maximum redirects to follow in a single sequence (default 5)
, defaults to:5
, defaults to:5
No
httpsampler.max_frame_depth
Maximum frame/iframe nesting depth (default 5)
, defaults to:5
, defaults to:5
No
httpsampler.separate.container
Revert to BUG 51939 behaviour (no separate container for embedded resources) by setting the following false:
, defaults to:true
, defaults to:true
No
httpsampler.ignore_failed_embedded_resources
If embedded resources download fails due to missing resources or other reasons, if this property is true
Parent sample will not be marked as failed
, defaults to:false
Parent sample will not be marked as failed
, defaults to:false
No
httpsampler.parallel_download_thread_keepalive_inseconds
keep alive time for the parallel download threads (in seconds)
, defaults to:60
, defaults to:60
No
httpsampler.embedded_resources_use_md5
Don't keep the embedded resources response data : just keep the size and the md5
default to false
, defaults to:false
default to false
, defaults to:false
No
httpsampler.user_defined_methods
List of extra HTTP methods that should be available in select box
, defaults to:VERSION-CONTROL,REPORT,CHECKOUT,CHECKIN,UNCHECKOUT,MKWORKSPACE,UPDATE,LABEL,MERGE,BASELINE-CONTROL,MKACTIVITY
, defaults to:VERSION-CONTROL,REPORT,CHECKOUT,CHECKIN,UNCHECKOUT,MKWORKSPACE,UPDATE,LABEL,MERGE,BASELINE-CONTROL,MKACTIVITY
No
sampleresult.default.encoding
The encoding to be used if none is provided (default ISO-8859-1)
, defaults to:ISO-8859-1
, defaults to:ISO-8859-1
No
sampleresult.getbytes.body_real_size
Network response size calculation method
Use real size: number of bytes for response body return by webserver
(i.e. the network bytes received for response)
if set to false, the (uncompressed) response data size will used (default before 2.5)
Include headers: add the headers size in real size
, defaults to:true
Use real size: number of bytes for response body return by webserver
(i.e. the network bytes received for response)
if set to false, the (uncompressed) response data size will used (default before 2.5)
Include headers: add the headers size in real size
, defaults to:true
No
sampleresult.getbytes.headers_size
, defaults to:true
No
CookieManager.delete_null_cookies
CookieManager behaviour - should cookies with null/empty values be deleted?
Default is true. Use false to revert to original behaviour
, defaults to:true
Default is true. Use false to revert to original behaviour
, defaults to:true
No
CookieManager.allow_variable_cookies
CookieManager behaviour - should variable cookies be allowed?
Default is true. Use false to revert to original behaviour
, defaults to:true
Default is true. Use false to revert to original behaviour
, defaults to:true
No
CookieManager.save.cookies
CookieManager behaviour - should Cookies be stored as variables?
Default is false
, defaults to:false
Default is false
, defaults to:false
No
CookieManager.name.prefix
CookieManager behaviour - prefix to add to cookie name before storing it as a variable
Default is COOKIE_; to remove the prefix, define it as one or more spaces
, defaults to:
Default is COOKIE_; to remove the prefix, define it as one or more spaces
, defaults to:
No
CookieManager.check.cookies
CookieManager behaviour - check received cookies are valid before storing them?
Default is true. Use false to revert to previous behaviour
, defaults to:true
Default is true. Use false to revert to previous behaviour
, defaults to:true
No
cookies
Netscape HTTP Cookie file
, defaults to:cookies
, defaults to:cookies
No
- JDK >
Ability to switch to Nashorn as default Javascript Engine used by IfController and __javaScript function
JMeter works as following:
- JDK < 8 : Rhino
, defaults to: 8 and javascript.use_rhino
JMeter works as following:
- JDK < 8 : Rhino
, defaults to: 8 and javascript.use_rhino
No
javascript.use_rhino
If you want to use Nashorn on JDK8, set this property to false
, defaults to:true
, defaults to:true
No
jmeterengine.threadstop.wait
Number of milliseconds to wait for a thread to stop
, defaults to:5000
, defaults to:5000
No
jmeterengine.remote.system.exit
Whether to invoke System.exit(0) in server exit code after stopping RMI
, defaults to:false
, defaults to:false
No
jmeterengine.stopfail.system.exit
Whether to call System.exit(1) on failure to stop threads in non-GUI mode.
This only takes effect if the test was explictly requested to stop.
If this is disabled, it may be necessary to kill the JVM externally
, defaults to:true
This only takes effect if the test was explictly requested to stop.
If this is disabled, it may be necessary to kill the JVM externally
, defaults to:true
No
jmeterengine.force.system.exit
Whether to force call System.exit(0) at end of test in non-GUI mode, even if
there were no failures and the test was not explicitly asked to stop.
Without this, the JVM may never exit if there are other threads spawned by
the test which never exit.
, defaults to:false
there were no failures and the test was not explicitly asked to stop.
Without this, the JVM may never exit if there are other threads spawned by
the test which never exit.
, defaults to:false
No
jmeter.exit.check.pause
How long to pause (in ms) in the daemon thread before reporting that the JVM has failed to exit.
, If the value is < 0, the JMeter does not start the daemon thread, defaults to:2000
, If the value is < 0, the JMeter does not start the daemon thread, defaults to:2000
No
jmeterengine.nongui.port
If running non-GUI, then JMeter listens on the following port for a shutdown message.
To disable, set the port to 1000 or less.
, defaults to:4445
To disable, set the port to 1000 or less.
, defaults to:4445
No
jmeterengine.nongui.maxport
If the initial port is busy, keep trying until this port is reached
(to disable searching, set the value less than or equal to the .port property)
, defaults to:4455
No
jmeterthread.rampup.granularity
How often to check for shutdown during ramp-up (milliseconds)
, defaults to:1000
, defaults to:1000
No
onload.expandtree
Should JMeter expand the tree when loading a test plan?
default value is false since JMeter 2.7
, defaults to:false
default value is false since JMeter 2.7
, defaults to:false
No
jsyntaxtextarea.wrapstyleword
JSyntaxTextArea configuration
, defaults to:true
, defaults to:true
No
jsyntaxtextarea.linewrap
, defaults to:true
No
jsyntaxtextarea.codefolding
, defaults to:true
No
jsyntaxtextarea.maxundos
Set 0 to disable undo feature in JSyntaxTextArea
, defaults to:50
, defaults to:50
No
jsyntaxtextarea.font.family
Change the font on the (JSyntax) Text Areas. (Useful for HiDPI screens)
, defaults to:Hack
, defaults to:Hack
No
jsyntaxtextarea.font.size
, defaults to:14
No
loggerpanel.usejsyntaxtext
Set this to false to disable the use of JSyntaxTextArea for the Console Logger panel
, defaults to:true
, defaults to:true
No
Maximum size of HTML page that can be displayed; default
, defaults to:10 mbytes
No
view.results.tree.max_size
Set to 0 to disable the size check and display the whole response
, defaults to:10485760
, defaults to:10485760
No
view.results.tree.renderers_order
Order of Renderers in View Results Tree
Note full class names should be used for non jmeter core renderers
For JMeter core renderers, class names start with . and are automatically
prefixed with org.apache.jmeter.visualizers
, defaults to:.RenderAsText,.RenderAsRegexp,.RenderAsCssJQuery,.RenderAsXPath,.RenderAsHTML,.RenderAsHTMLWithEmbedded,.RenderAsDocument,.RenderAsJSON,.RenderAsXML
Note full class names should be used for non jmeter core renderers
For JMeter core renderers, class names start with . and are automatically
prefixed with org.apache.jmeter.visualizers
, defaults to:.RenderAsText,.RenderAsRegexp,.RenderAsCssJQuery,.RenderAsXPath,.RenderAsHTML,.RenderAsHTMLWithEmbedded,.RenderAsDocument,.RenderAsJSON,.RenderAsXML
No
Maximum size of Document that can be parsed by Tika engine; defaut
, defaults to:10 * 1024 * 1024 (10MB)
No
document.max_size
Set to 0 to disable the size check
, defaults to:0
, defaults to:0
No
JMSSampler.useSecurity.properties
JMS options
Enable the following property to stop JMS Point-to-Point Sampler from using
the properties java.naming.security.[principal|credentials] when creating the queue connection
, defaults to:false
Enable the following property to stop JMS Point-to-Point Sampler from using
the properties java.naming.security.[principal|credentials] when creating the queue connection
, defaults to:false
No
confirm.delete.skip
Set the following value to true in order to skip the delete confirmation dialogue
, defaults to:false
, defaults to:false
No
jsr223.compiled_scripts_cache_size
Used by JSR223 elements
Size of compiled scripts cache
, defaults to:100
Size of compiled scripts cache
, defaults to:100
No
25.39 Classpath configuration¶
Parameters
Attribute
Description
Required
search_paths
List of directories (separated by ;) to search for additional JMeter plugin classes,
for example new GUI elements and samplers.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib/ext directory.
Do not use this for utility or plugin dependency jars.
, defaults to:/app1/lib;/app2/lib
for example new GUI elements and samplers.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib/ext directory.
Do not use this for utility or plugin dependency jars.
, defaults to:/app1/lib;/app2/lib
No
user.classpath
List of directories that JMeter will search for utility and plugin dependency classes.
Use your platform path separator to separate multiple paths.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib directory.
All entries will be added to the class path of the system class loader
and also to the path of the JMeter internal loader.
Paths with spaces may cause problems for the JVM
, defaults to:../classes;../lib
Use your platform path separator to separate multiple paths.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib directory.
All entries will be added to the class path of the system class loader
and also to the path of the JMeter internal loader.
Paths with spaces may cause problems for the JVM
, defaults to:../classes;../lib
No
plugin_dependency_paths
List of directories (separated by ;) that JMeter will search for utility
and plugin dependency classes.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib directory
or given by the user.classpath property.
All entries will be added to the path of the JMeter internal loader only.
For plugin dependencies this property should be used instead of user.classpath.
, defaults to:../dependencies/lib;../app1/;../app2/
and plugin dependency classes.
Any jar file in such a directory will be automatically included,
jar files in sub directories are ignored.
The given value is in addition to any jars found in the lib directory
or given by the user.classpath property.
All entries will be added to the path of the JMeter internal loader only.
For plugin dependencies this property should be used instead of user.classpath.
, defaults to:../dependencies/lib;../app1/;../app2/
No
Classpath finder
, defaults to:
, defaults to:
No
classfinder.functions.contain
The classpath finder currently needs to load every single JMeter class to find
the classes it needs.
For non-GUI mode, it's only necessary to scan for Function classes, but all classes
are still loaded.
All current Function classes include ".function." in their name,
and none include ".gui." in the name, so the number of unwanted classes loaded can be
reduced by checking for these. However, if a valid function class name does not match
these restrictions, it will not be loaded. If problems are encountered, then comment
or change the following properties:
, defaults to:.functions.
the classes it needs.
For non-GUI mode, it's only necessary to scan for Function classes, but all classes
are still loaded.
All current Function classes include ".function." in their name,
and none include ".gui." in the name, so the number of unwanted classes loaded can be
reduced by checking for these. However, if a valid function class name does not match
these restrictions, it will not be loaded. If problems are encountered, then comment
or change the following properties:
, defaults to:.functions.
No
classfinder.functions.notContain
, defaults to:.gui.
No
25.40 Reporting configuration¶
Parameters
Attribute
Description
Required
jmeter.reportgenerator.apdex_satisfied_threshold
Sets the satisfaction threshold for the APDEX calculation (in milliseconds).
, defaults to:500
, defaults to:500
No
jmeter.reportgenerator.apdex_tolerated_threshold
Sets the tolerance threshold for the APDEX calculation (in milliseconds).
, defaults to:1500
, defaults to:1500
No
jmeter.reportgenerator.sample_filter
Regular Expression which Indicates which samples to keep for graphs and statistics generation.
Empty value means no filtering
, defaults to:
Empty value means no filtering
, defaults to:
No
jmeter.reportgenerator.temp_dir
Sets the temporary directory used by the generation processus if it needs file I/O operations.
, defaults to:temp
, defaults to:temp
No
jmeter.reportgenerator.statistic_window
Sets the size of the sliding window used by percentile evaluation.
Caution : higher value provides a better accurency but needs more memory.
, defaults to: 200000
Caution : higher value provides a better accurency but needs more memory.
, defaults to: 200000
No
jmeter.reportgenerator.report_title
Configure this property to change the report title
, defaults to:Apache JMeter Dashboard
, defaults to:Apache JMeter Dashboard
No
jmeter.reportgenerator.overall_granularity
Defines the overall granularity for over time graphs
, defaults to:60000
, defaults to:60000
No
jmeter.reportgenerator.graph.responseTimePercentiles.classname
Response Time Percentiles graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimePercentilesGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimePercentilesGraphConsumer
No
jmeter.reportgenerator.graph.responseTimePercentiles.title
, defaults to:Response Time Percentiles
No
jmeter.reportgenerator.graph.responseTimeDistribution.classname
Response Time Distribution graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeDistributionGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeDistributionGraphConsumer
No
jmeter.reportgenerator.graph.responseTimeDistribution.title
, defaults to:Response Time Distribution
No
jmeter.reportgenerator.graph.responseTimeDistribution.property.set_granularity
, defaults to:500
No
jmeter.reportgenerator.graph.activeThreadsOverTime.classname
Active Threads Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ActiveThreadsGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.ActiveThreadsGraphConsumer
No
jmeter.reportgenerator.graph.activeThreadsOverTime.title
, defaults to:Active Threads Over Time
No
jmeter.reportgenerator.graph.activeThreadsOverTime.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.timeVsThreads.classname
Time VS Threads graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.TimeVSThreadGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.TimeVSThreadGraphConsumer
No
jmeter.reportgenerator.graph.timeVsThreads.title
, defaults to:Time VS Threads
No
jmeter.reportgenerator.graph.bytesThroughputOverTime.classname
Bytes Throughput Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.BytesThroughputGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.BytesThroughputGraphConsumer
No
jmeter.reportgenerator.graph.bytesThroughputOverTime.title
, defaults to:Bytes Throughput Over Time
No
jmeter.reportgenerator.graph.bytesThroughputOverTime.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.responseTimesOverTime.classname
Response Time Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeOverTimeGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeOverTimeGraphConsumer
No
jmeter.reportgenerator.graph.responseTimesOverTime.title
, defaults to:Response Time Over Time
No
jmeter.reportgenerator.graph.responseTimesOverTime.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.latenciesOverTime.classname
Latencies Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyOverTimeGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyOverTimeGraphConsumer
No
jmeter.reportgenerator.graph.latenciesOverTime.title
, defaults to:Latencies Over Time
No
jmeter.reportgenerator.graph.latenciesOverTime.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.responseTimeVsRequest.classname
Response Time Vs Request graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeVSRequestGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeVSRequestGraphConsumer
No
jmeter.reportgenerator.graph.responseTimeVsRequest.title
, defaults to:Response Time Vs Request
No
jmeter.reportgenerator.graph.responseTimeVsRequest.exclude_controllers
, defaults to:true
No
jmeter.reportgenerator.graph.responseTimeVsRequest.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.latencyVsRequest.classname
Latencies Vs Request graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyVSRequestGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyVSRequestGraphConsumer
No
jmeter.reportgenerator.graph.latencyVsRequest.title
, defaults to:Latencies Vs Request
No
jmeter.reportgenerator.graph.latencyVsRequest.exclude_controllers
, defaults to:true
No
jmeter.reportgenerator.graph.latencyVsRequest.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.hitsPerSecond.classname
Hits Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.HitsPerSecondGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.HitsPerSecondGraphConsumer
No
jmeter.reportgenerator.graph.hitsPerSecond.title
, defaults to:Hits Per Second
No
jmeter.reportgenerator.graph.hitsPerSecond.exclude_controllers
, defaults to:true
No
jmeter.reportgenerator.graph.hitsPerSecond.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.codesPerSecond.classname
Codes Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.CodesPerSecondGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.CodesPerSecondGraphConsumer
No
jmeter.reportgenerator.graph.codesPerSecond.title
, defaults to:Codes Per Second
No
jmeter.reportgenerator.graph.codesPerSecond.exclude_controllers
, defaults to:true
No
jmeter.reportgenerator.graph.codesPerSecond.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.graph.transactionsPerSecond.classname
Transactions Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.TransactionsPerSecondGraphConsumer
, defaults to:org.apache.jmeter.report.processor.graph.impl.TransactionsPerSecondGraphConsumer
No
jmeter.reportgenerator.graph.transactionsPerSecond.title
, defaults to:Transactions Per Second
No
jmeter.reportgenerator.graph.transactionsPerSecond.property.set_granularity
, defaults to:${jmeter.reportgenerator.overall_granularity}
No
jmeter.reportgenerator.exporter.html.classname
HTML Export
, defaults to:org.apache.jmeter.report.dashboard.HtmlTemplateExporter
, defaults to:org.apache.jmeter.report.dashboard.HtmlTemplateExporter
No
jmeter.reportgenerator.exporter.html.property.template_dir
Sets the source directory of templated files from which the html pages are generated.
, defaults to:report-template
, defaults to:report-template
No
jmeter.reportgenerator.exporter.html.property.output_dir
Sets the destination directory for generated html pages.
This will be overriden by the command line option -o
, defaults to:report-output
This will be overriden by the command line option -o
, defaults to:report-output
No
jmeter.reportgenerator.exporter.html.series_filter
Regular Expression which Indicates which graph series are filtered in display
Empty value means no filtering
, defaults to:
Empty value means no filtering
, defaults to:
No
jmeter.reportgenerator.exporter.html.filters_only_sample_series
Indicates whether series filter apply only on sample series
, defaults to:true
, defaults to:true
No
jmeter.reportgenerator.exporter.html.show_controllers_only
Indicates whether only controller samples are displayed on graphs that support it.
, defaults to:false
, defaults to:false
No
25.41 Additional property files to load¶
Parameters
Attribute
Description
Required
user.properties
Should JMeter automatically load additional JMeter properties?
File name to look for (comment to disable)
, defaults to:user.properties
File name to look for (comment to disable)
, defaults to:user.properties
No
system.properties
Should JMeter automatically load additional system properties?
File name to look for (comment to disable)
, defaults to:system.properties
File name to look for (comment to disable)
, defaults to:system.properties
No
template.files
Comma separated list of files that contain reference to templates and their description
Path must be relative to jmeter root folder
, defaults to:/bin/templates/templates.xml
Path must be relative to jmeter root folder
, defaults to:/bin/templates/templates.xml
No
25.42 Thread Group Validation feature¶
Validation is the name of the feature used to rapidly validate a Thread Group runs fine
Parameters
Attribute
Description
Required
testplan_validation.tree_cloner_class
Default implementation is org.apache.jmeter.gui.action.validation.TreeClonerForValidation
It runs validation without timers, with 1 thread and 1 iteration
You can implement your own policy that must extend org.apache.jmeter.engine.TreeCloner
JMeter will instanciate it and use it to create the Tree used to run validation on Thread Group
, defaults to:org.apache.jmeter.gui.action.validation.TreeClonerForValidation
It runs validation without timers, with 1 thread and 1 iteration
You can implement your own policy that must extend org.apache.jmeter.engine.TreeCloner
JMeter will instanciate it and use it to create the Tree used to run validation on Thread Group
, defaults to:org.apache.jmeter.gui.action.validation.TreeClonerForValidation
No
testplan_validation.nb_threads_per_thread_group
Number of threads to use to validate a Thread Group
, defaults to:1
, defaults to:1
No
testplan_validation.ignore_timers
Ignore timers when validating the thread group of plan
, defaults to:true
, defaults to:true
No
testplan_validation.number_iterations
Number of iterations to use to validate a Thread Group
, defaults to:1
, defaults to:1
No