User's Manual: Properties Reference

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.

Preferred GUI language. Comment out to use the JVM default locale's language.
, example:language=en 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: locales.add=zu

Path to a Properties file containing Namespace mapping in the form prefix=Namespace, Example: ns=http://biz.aol.com/schema/2006-12-18

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. 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 Be aware that https default protocol may vary depending on the version of JVM See Diagnosing TLS, SSL and HTTPS and 58236 Default HTTPS protocol level: https.default.protocol=TLS This may need to be changed to:https.default.protocol=SSLv3 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 54759, example: https.socket.protocols=SSLv2Hello SSLv3 TLSv1 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 Start index to be used with keystores with many entries
The default is to use entry 0, i.e. the first
, defaults to:0 End index to be used with keystores with many entries
, defaults to:0

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:jmeter.laf.windows_xp=javax.swing.plaf.metal.MetalLookAndFeel Failing 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.WindowsLookAndFeel Mac 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=System 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 52026 for details LoggerPanel display
defaults to:false 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 Max characters kept in LoggerPanel, 0 means no limit
, defaults to:80000

Toolbar icon definitions
, defaults to org/apache/jmeter/images/toolbar/icons-toolbar.properties Toolbar list
, 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 Available sizes are: 22x22, 32x32, 48x48. Suggested value for HiDPI mode is jmeter.toolbar.icons.size=48x48, defaults to:22x22 Icon definitions. Alternate set: 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 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 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 HiDPI scale factor, suggested value for HiDPI: 2.0, defaults to:1.0 Components to not display in JMeter GUI (GUI class name or static label)
These elements are deprecated and will be removed in next version: MongoDB Script, MongoDB Source Config, Distribution Graph, Spline Visualizer defaults 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 Number of items in undo history
Feature is disabled by default (0) due to known and not fixed bugs 57043,57039 and 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 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=ViewResultsFullVisualizer Above code will add elements when you press Ctrl+0 .. Ctrl+9 (Command+0 .. Command+9 on Mac)

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 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 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 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

Remote Hosts - comma delimited, example remote_hosts=localhost:1099,localhost:2010, defaults to:127.0.0.1. 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):

set server_port=1234

start rmiregistry with port 1234

On Windows this can be done by:

SET SERVER_PORT=1234

JMETER-SERVER

On Unix: SERVER_PORT=1234 jmeter-server
On the client: set remote_hosts=server:1234
defaults to:1099 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 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 If there is initialization retries, following property sets delay between attempts
, defaults to:5000 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 To change the default port (1099) used to access the server:
, defaults to:1234 To use a specific port for the JMeter server engine, define
the following property before starting the server:
, defaults to:4000 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 From JMeter 2.3.1, define the following property to cause JMeter to exit after the first test
, defaults to:true

Prefix used by IncludeController when building file name
, defaults to empty value

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_suffix default 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

To set the log level for a package or individual class, use: 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.log To 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.log If 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

Number of connection retries performed by HTTP Java sampler before giving up. 0 means no retry since version 3.0, defaults to:0

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 Set the http version, defaults to:1.1 (or use the parameter http.protocol.version) Set characters per second to a value > 0 to emulate slow connections
, defaults to:0 Same as before but for https, defaults to:0 Enable loopback protocol
, defaults to:true Define the local host address to be used for multi-homed hosts, example httpclient.localaddress=1.2.3.4

AuthManager Kerberos configuration
Name of application module used in jaas.conf, defaults to:JMeter Should ports be stripped from urls before constructing SPNs for spnego authentication, defaults to:true

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=debug Might be useful: log_level.org.apache.commons.httpclient.Authenticator=trace Show headers only log_level.httpclient.wire.header=debug Full wire debug produces a lot of output; consider using separate file: log_level.httpclient.wire=debug log_file.httpclient=httpclient.log

Enable header wire + context logging - Best for Debugging log_level.org.apache.http=DEBUG log_level.org.apache.http.wire=ERROR Enable full wire + context logging log_level.org.apache.http=DEBUG Enable context logging for connection management log_level.org.apache.http.impl.conn=DEBUG Enable 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

define a properties file for overriding Apache HttpClient parameters
Uncomment this line if you put anything in hc.parameters file
, defaults to:hc.parameters Number of retries to attempt
, defaults to:0 Idle connection timeout (Milliseconds) to apply if the server does not send Keep-Alive headers, defaults to:0 (no suggested duration for Keep-Alive)) Check connections if the elapsed time (Milliseconds) since the last use of the connection exceeds this value
, defaults to:2000 TTL (in Milliseconds) represents an absolute value. No matter what, the connection will not be re-used beyond its TTL.
, defaults to:2000

define a properties file for overriding Commons HttpClient parameters See this. Uncomment this line if you put anything in httpclient.parameters file Number of retries to attempt, defaults to:0

Space or comma separated list of methods that can be cached
, defaults to:GET 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 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_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:

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 true when field should be saved; false otherwise
assertion_results_failure_message only affects CSV output
, defaults to:true
legitimate values: none, first, all
, defaults to:none
, defaults to:true , defaults to:true , defaults to:true response_data is not currently supported for CSV output
, defaults to:false Save ResponseData for failed samples
, defaults to:false , defaults to:true , defaults to:true , defaults to:true , defaults to:true , defaults to:true , defaults to:true , defaults to:true , defaults to:false , defaults to:false , defaults to:false , defaults to:false , defaults to:false , defaults to:true , defaults to:false , defaults to:false , defaults to:false , defaults to:true , defaults to:false , defaults to:true Timestamp format - this only affects CSV output files
legitimate values: none, ms, or a format suitable for SimpleDateFormat
, defaults to:ms , defaults to:yyyy/MM/dd HH:mm:ss.SSS For use with Comma-separated value (CSV) files or other formats
where the fields' values are separated by specified delimiters.
Default:
, defaults to:, For TAB, since JMeter 2.3 one can use:
, defaults to:\t Only applies to CSV format files:
Print field names as first line in CSV
, defaults to:true 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 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: Prefix used to identify filenames that are relative to the current base
, defaults to:~/ 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

Save the start time stamp instead of the end
This also affects the timestamp stored in result files
, defaults to:true Whether to use System.nanoTime() - otherwise only use System.currentTimeMillis()
, defaults to:true Use a background thread to calculate the nanoTime offset
. Set this to a value < 0 to disable the background thread, defaults to:5000

File that holds a record of name changes for backward compatibility issues
, defaults to:/bin/upgrade.properties

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 Add numeric prefix to Sampler names (default true)
, defaults to:true 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) Change the default HTTP Sampler (currently HttpClient4)
Java:
, defaults to:HTTPSampler or
, defaults to:Java
Apache HTTPClient:
, defaults to:HTTPSampler2 or
, defaults to:HttpClient3.1
HttpClient4.x
, defaults to:HttpClient4 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 Default content-type include filter to use
, defaults to:text/html|text/plain|text/xml Default content-type exclude filter to use
, defaults to:image/.*|text/css|application/.* Default headers to remove from Header Manager elements
(Cookie and Authorization are always removed)
, defaults to:If-Modified-Since,If-None-Match,Host 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 The files will be saved in this directory:
, defaults to:user.dir The files will be created with this file filesuffix:
, defaults to:.binary Whether to attempt disabling of samples that resulted from redirects
where the generated samples use auto-redirection
, defaults to:true SSL configuration
, defaults to:TLS

, defaults to:<JMeter bin directory> , defaults to:proxyserver.jks , defaults to:JKS , defaults to:password , defaults to:password , defaults to:SunX509 define this property if you wish to use your own keystore
, defaults to:none The default validity for certificates created by JMeter
, defaults to:7 Use dynamic key generation (if supported by JMeter/JVM)
If false, will revert to using a single key with no certificate
, defaults to:true

use command-line flags for user-name and password
, defaults to:NTLM domain, if required by HTTPClient sampler

Space-separated list of parser groups
, defaults to:htmlParser wmlParser cssParser 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 , defaults to:text/css Define the HTML parser to be used.
Default parser:
This new parser (since 2.10) should perform better than all others
, defaults to:55632 Do not comment this property
, defaults to:org.apache.jmeter.protocol.http.parser.LagartoBasedHtmlParser Other parsers:
Default parser before 2.10
, defaults to:org.apache.jmeter.protocol.http.parser.JTidyHTMLParser 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 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 Used by HTTPSamplerBase to associate htmlParser with content types below
, defaults to:text/html application/xhtml+xml application/xml text/xml , defaults to:org.apache.jmeter.protocol.http.parser.RegexpHTMLParser Used by HTTPSamplerBase to associate wmlParser with content types below
, defaults to:text/vnd.wap.wml

How is Sample sender implementations configured:
- true (default) means client configuration will be used
- false means server configuration will be used
, defaults to:true 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 mode can also be the class name of an implementation of org.apache.jmeter.samplers.SampleSender
, defaults to:Standard , defaults to:Batch , defaults to:Hold , defaults to:Statistical Set to true to key statistical samples on threadName rather than threadGroup
, defaults to:false , defaults to:Stripped , defaults to:StrippedBatch , defaults to:org.example.load.MySampleSender
, defaults to:100 Value is in milliseconds
, defaults to:60000
Asynchronous sender; uses a queue and background worker process to return the samples
, defaults to:Asynch default queue size
, defaults to:100 Same as Asynch but strips response data from SampleResult
, defaults to:StrippedAsynch
DiskStore: as for Hold mode, but serialises the samples to disk, rather than saving in memory
, defaults to:DiskStore Same as DiskStore but strips response data from SampleResult
, defaults to:StrippedDiskStore 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

Max number of PreparedStatements per Connection for PreparedStatement cache
, defaults to:100 String used to indicate a null value
, defaults to:]NULL[

Polling to see if process has finished its work, used when a timeout is configured on sampler
, defaults to:100

The default handler class
, defaults to:TCPClientImpl
, defaults to: byte value for end of line set this to a value outside the range -128 to +127 to skip eol checking
, defaults to:1000
TCP Charset, used by org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl
default to Platform defaults charset as returned by Charset.defaultCharset().name()
, defaults to:
, defaults to: strings that enclose the status response code , defaults to:Status , defaults to:.
, defaults to: property file to convert codes to messages , defaults to:mytestfiles/tcpstatus.properties The length prefix used by LengthPrefixedBinaryTCPClientImpl implementation
defaults to 2 bytes.
, defaults to:2

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
interval between summaries (in seconds) default 30 seconds
, defaults to:30
Write messages to log file
, defaults to:true
Write messages to System.out
, defaults to:true

Percentiles to display in reports
Can be float value between 0 and 100
First percentile to display, defaults to 90%
, defaults to:90 Second percentile to display, defaults to 95%
, defaults to:95 Second percentile to display, defaults to 99%
, defaults to:99

Backend metrics sliding window size for Percentiles, Min, Max
, defaults to:100

BeanShell Server properties

Define the port number as non-zero to start the http server on that port
, defaults to:9000 The telnet server will be started on the next port

Define the server initialisation file
, defaults to:../extras/startup.bsh
Define a file to be processed at startup
This is processed using its own interpreter.
, defaults to:
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 , defaults to:BeanShellFunction.bshrc , defaults to:BeanShellAssertion.bshrc , defaults to:etc , defaults to:etc , defaults to:etc , defaults to:etc

The file BeanShellListeners.bshrc contains sample definitions
of Test and Thread Listeners.
Number of successful samples before a message is sent
, defaults to:2
Number of failed samples before a message is sent
, defaults to:2

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:, , defaults to:; , defaults to:! , defaults to:~ , defaults to: , defaults to:

The properties below can be used to redefine the default formats
, defaults to:yyyyMMdd , defaults to:HHmmss , defaults to:yyyyMMdd-HHmmss , defaults to: , defaults to:

String to return at EOF (if recycle not used)
, defaults to:<EOF>

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 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 test written out to log to signify start/end of diff delta
, defaults to:[[[ , defaults to:]]]

If defined, then start the mirror server on the port
, defaults to:8081 ORO PatternCacheLRU size
, defaults to:1000 TestBeanGui

, defaults to:null Turn expert mode on/off: expert mode will show expert-mode beans and properties
, defaults to:true Maximum redirects to follow in a single sequence (default 5)
, defaults to:5 Maximum frame/iframe nesting depth (default 5)
, defaults to:5 Revert to BUG 51939 behaviour (no separate container for embedded resources) by setting the following false:
, defaults to:true 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 keep alive time for the parallel download threads (in seconds)
, defaults to:60 Don't keep the embedded resources response data : just keep the size and the md5
default to false
, defaults to:false 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 The encoding to be used if none is provided (default ISO-8859-1)
, defaults to:ISO-8859-1 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 , defaults to:true CookieManager behaviour - should cookies with null/empty values be deleted?
Default is true. Use false to revert to original behaviour
, defaults to:true CookieManager behaviour - should variable cookies be allowed?
Default is true. Use false to revert to original behaviour
, defaults to:true CookieManager behaviour - should Cookies be stored as variables?
Default is false
, defaults to:false 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: CookieManager behaviour - check received cookies are valid before storing them?
Default is true. Use false to revert to previous behaviour
, defaults to:true Netscape HTTP Cookie file
, defaults to:cookies 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 If you want to use Nashorn on JDK8, set this property to false
, defaults to:true Number of milliseconds to wait for a thread to stop
, defaults to:5000 Whether to invoke System.exit(0) in server exit code after stopping RMI
, defaults to:false 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 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 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 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
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 How often to check for shutdown during ramp-up (milliseconds)
, defaults to:1000 Should JMeter expand the tree when loading a test plan?
default value is false since JMeter 2.7
, defaults to:false JSyntaxTextArea configuration
, defaults to:true , defaults to:true , defaults to:true Set 0 to disable undo feature in JSyntaxTextArea
, defaults to:50 Change the font on the (JSyntax) Text Areas. (Useful for HiDPI screens)
, defaults to:Hack , defaults to:14 Set this to false to disable the use of JSyntaxTextArea for the Console Logger panel
, defaults to:true , defaults to:10 mbytes Set to 0 to disable the size check and display the whole response
, defaults to:10485760 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 , defaults to:10 * 1024 * 1024 (10MB) Set to 0 to disable the size check
, defaults to:0 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 Set the following value to true in order to skip the delete confirmation dialogue
, defaults to:false Used by JSR223 elements
Size of compiled scripts cache
, defaults to:100

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 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 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/ Classpath finder
, defaults to: 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. , defaults to:.gui.

Sets the satisfaction threshold for the APDEX calculation (in milliseconds).
, defaults to:500 Sets the tolerance threshold for the APDEX calculation (in milliseconds).
, defaults to:1500 Regular Expression which Indicates which samples to keep for graphs and statistics generation.
Empty value means no filtering
, defaults to: Sets the temporary directory used by the generation processus if it needs file I/O operations.
, defaults to:temp 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 Configure this property to change the report title
, defaults to:Apache JMeter Dashboard Defines the overall granularity for over time graphs
, defaults to:60000 Response Time Percentiles graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimePercentilesGraphConsumer , defaults to:Response Time Percentiles Response Time Distribution graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeDistributionGraphConsumer , defaults to:Response Time Distribution , defaults to:500 Active Threads Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ActiveThreadsGraphConsumer , defaults to:Active Threads Over Time , defaults to:${jmeter.reportgenerator.overall_granularity} Time VS Threads graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.TimeVSThreadGraphConsumer , defaults to:Time VS Threads Bytes Throughput Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.BytesThroughputGraphConsumer , defaults to:Bytes Throughput Over Time , defaults to:${jmeter.reportgenerator.overall_granularity} Response Time Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeOverTimeGraphConsumer , defaults to:Response Time Over Time , defaults to:${jmeter.reportgenerator.overall_granularity} Latencies Over Time graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyOverTimeGraphConsumer , defaults to:Latencies Over Time , defaults to:${jmeter.reportgenerator.overall_granularity} Response Time Vs Request graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.ResponseTimeVSRequestGraphConsumer , defaults to:Response Time Vs Request , defaults to:true , defaults to:${jmeter.reportgenerator.overall_granularity} Latencies Vs Request graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.LatencyVSRequestGraphConsumer , defaults to:Latencies Vs Request , defaults to:true , defaults to:${jmeter.reportgenerator.overall_granularity} Hits Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.HitsPerSecondGraphConsumer , defaults to:Hits Per Second , defaults to:true , defaults to:${jmeter.reportgenerator.overall_granularity} Codes Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.CodesPerSecondGraphConsumer , defaults to:Codes Per Second , defaults to:true , defaults to:${jmeter.reportgenerator.overall_granularity} Transactions Per Second graph definition
, defaults to:org.apache.jmeter.report.processor.graph.impl.TransactionsPerSecondGraphConsumer , defaults to:Transactions Per Second , defaults to:${jmeter.reportgenerator.overall_granularity} HTML Export
, defaults to:org.apache.jmeter.report.dashboard.HtmlTemplateExporter Sets the source directory of templated files from which the html pages are generated.
, defaults to:report-template Sets the destination directory for generated html pages.
This will be overriden by the command line option -o
, defaults to:report-output Regular Expression which Indicates which graph series are filtered in display
Empty value means no filtering
, defaults to: Indicates whether series filter apply only on sample series
, defaults to:true Indicates whether only controller samples are displayed on graphs that support it.
, defaults to:false

Should JMeter automatically load additional JMeter properties?
File name to look for (comment to disable)
, defaults to:user.properties Should JMeter automatically load additional system properties?
File name to look for (comment to disable)
, defaults to:system.properties 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

Validation is the name of the feature used to rapidly validate a Thread Group runs fine 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 Number of threads to use to validate a Thread Group
, defaults to:1 Ignore timers when validating the thread group of plan
, defaults to:true Number of iterations to use to validate a Thread Group
, defaults to:1 ^