Modified: jmeter/trunk/docs/usermanual/listeners.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/listeners.html?rev=1789801&r1=1789800&r2=1789801&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/listeners.html (original) +++ jmeter/trunk/docs/usermanual/listeners.html Sat Apr 1 14:01:02 2017 @@ -5,7 +5,7 @@ APACHE LOGO -->

13. Introduction to listeners

+ -->

13. Introduction to listeners

A listener is a component that shows the results of the samples. The results can be shown in a tree, tables, graphs or simply written to a log file. To view the contents of a response from any given sampler, add either of the Listeners "View @@ -464,7 +464,7 @@ e.g. a spreadsheet or text editor.

20.11 Commons and Apache HttpClient common properties

+

20.10 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.
+ AJP Sampler.
Value is in milliseconds, 0 means no timeout.
Defaults to: 0
@@ -541,7 +456,7 @@ log_file.jmeter=jmeter.log No
-

20.12 Kerberos properties

+

20.11 Kerberos properties

Parameters

Attribute
Description
Required
@@ -559,42 +474,27 @@ log_file.jmeter=jmeter.log No
-

20.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=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
-
-
-

20.14 Apache HttpClient logging examples

+

20.12 Apache HttpClient logging examples

Enable header wire and context logging - Best for Debugging + In log4j2.xml, set:
-log_level.org.apache.http=DEBUG
-log_level.org.apache.http.wire=ERROR
+<Logger name="org.apache.http" level="debug" />
+<Logger name="org.apache.http.wire" level="error" />
 
Enable full wire and context logging -
log_level.org.apache.http=DEBUG
+ In log4j2.xml, set: +
<Logger name="org.apache.http" level="debug" />
Enable context logging for connection management -
log_level.org.apache.http.impl.conn=DEBUG
+
<Logger name="org.apache.http.impl.conn" level="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
+<Logger name="org.apache.http.impl.conn" level="debug" />
+<Logger name="org.apache.http.impl.client" level="debug" />
+<Logger name="org.apache.http.client" level="debug" />
 
-

20.15 Apache HttpComponents HTTPClient configuration (HTTPClient4)

+

20.13 Apache HttpComponents HTTPClient configuration (HTTPClient4)

Parameters

Attribute
Description
Required
@@ -605,22 +505,39 @@ log_level.org.apache.http.client=DEBUG
No
+
httpclient4.auth.preemptive
+ Preemptively send Authorization Header when BASIC auth is used + Defaults to: true +
+ No +
httpclient4.retrycount
- Number of retries to attempt.
+ Number of retries to attempt. + Retry will be done on Idempotent Http Methods by default. + If you want to retry for all methods, see property httpclient4.request_sent_retry_enabled +
Defaults to: 0
No
+
httpclient4.request_sent_retry_enabled
+ Set this property to true if it's OK to retry requests that have been sent. + This mean that both Idempotent and non Idempotent requests will be retried. + This should usually be false, but it can be useful when testing against some Load Balancers like Amazon ELB.
+ Defaults to: false +
+ No +
httpclient4.idletimeout
- Idle connection timeout (in milliseconds) to apply if the server does not send Keep-Alive headers.
- Defaults to: 0 (no suggested duration for Keep-Alive) + Idle connection timeout (in milliseconds) to apply if the server does not send Keep-Alive timeout headers.
+ Defaults to: 0 (no suggested duration for Keep-Alived connections)
No
httpclient4.validate_after_inactivity
- Check connections if the elapsed time (in milliseconds) since the last use of the connection - exceeds this value.
- Defaults to: 2000 + Check connection if the elapsed time (in milliseconds) since the last use of the connection + exceeds this value. Ensure this value is always lower by at least 150 ms than httpclient4.time_to_live
+ Defaults to: 1700
No
@@ -639,25 +556,7 @@ log_level.org.apache.http.client=DEBUG No -

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

20.17 HTTP Cache Manager configuration

+

20.14 HTTP Cache Manager configuration

Parameters

Attribute
Description
Required
@@ -703,7 +602,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.18 Results file configuration

+

20.15 Results file configuration

Parameters

Attribute
Description
Required
@@ -888,7 +787,7 @@ log_level.org.apache.http.client=DEBUG
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 two of the file.
+ Optional XML processing instruction for line two of the file.
Defaults to empty value
No @@ -909,7 +808,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.19 Settings that affect SampleResults

+

20.16 Settings that affect SampleResults

Parameters

Attribute
Description
Required
@@ -934,7 +833,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.20 Upgrade

+

20.17 Upgrade

Parameters

Attribute
Description
Required
@@ -945,7 +844,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.21 JMeter Test Script recorder configuration

+

20.18 JMeter Test Script recorder configuration

Parameters

Attribute
Description
Required
@@ -967,7 +866,7 @@ log_level.org.apache.http.client=DEBUG
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) + Defaults to: .*\\.(bmp|css|js|gif|ico|jpe?g|png|swf|woff|woff2)
No
@@ -977,8 +876,7 @@ log_level.org.apache.http.client=DEBUG
HTTPSampler or Java
Use the Java Sampler
-
HTTPSampler2 or HttpClient3.1
-
Use Apache HTTPClient version 3.1
+
HTTPSampler2
HttpClient4
Use Apache HTTPClient version 4
@@ -1048,7 +946,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.22 Test Script Recorder certificate configuration

+

20.19 Test Script Recorder certificate configuration

Parameters

Attribute
Description
Required
@@ -1102,7 +1000,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.23 JMeter Proxy configuration

+

20.20 JMeter Proxy configuration

Parameters

Attribute
Description
Required
@@ -1113,7 +1011,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.24 HTML Parser configuration

+

20.21 HTML Parser configuration

Parameters

Attribute
Description
Required
@@ -1186,7 +1084,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.25 Remote batching configuration

+

20.22 Remote batching configuration

Configure how SampleResults are sent from server to client when using distributed testing.

@@ -1292,7 +1190,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.26 JDBC Request configuration

+

20.23 JDBC Request configuration

Parameters

Attribute
Description
Required
@@ -1309,7 +1207,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.27 OS Process Sampler configuration

+

20.24 OS Process Sampler configuration

Parameters

Attribute
Description
Required
@@ -1321,7 +1219,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.28 TCP Sampler configuration

+

20.25 TCP Sampler configuration

Parameters

Attribute
Description
Required
@@ -1367,7 +1265,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.29 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)

+

20.26 Summariser - Generate Summary Results - configuration (mainly applies to non-GUI mode)

Parameters

Attribute
Description
Required
@@ -1404,7 +1302,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.30 Aggregate Report and Aggregate Graph - configuration

+

20.27 Aggregate Report and Aggregate Graph - configuration

Parameters

Attribute
Description
Required
@@ -1431,10 +1329,40 @@ log_level.org.apache.http.client=DEBUG No
-

20.31 BackendListener - configuration

+

20.28 BackendListener - configuration

Parameters

Attribute
Description
Required
+
backend_graphite.send_interval
+ Send interval in seconds.
+ Defaults to: 1 second +
+ No +
+
backend_influxdb.send_interval
+ Send interval in seconds.
+ Defaults to: 5 seconds +
+ No +
+
backend_influxdb.connection_timeout
+ InfluxDB connection timeout.
+ Defaults to: 1000 millis +
+ No +
+
backend_influxdb.socket_timeout
+ InfluxDB socket read timeout.
+ Defaults to: 3000 millis +
+ No +
+
backend_influxdb.connection_request_timeout
+ InfluxDB timeout to get a connection.
+ Defaults to: 100 millis +
+ No +
backend_metrics_window
Backend metrics sliding window size for Percentiles, Min and Max.
@@ -1442,8 +1370,28 @@ log_level.org.apache.http.client=DEBUG
No
+
backend_metrics_large_window
+ Backend metrics sliding window size for Percentiles, Min + and Max. when backend_metrics_window_mode=timed
+ Setting this value too high can lead to OOM Backend metrics sliding window size + Defaults to: 5000 +
+ No +
+ +
backend_metrics_window_mode
+ Backend metrics window mode. + Possible values: +
    +
  • fixed : fixed-size window
  • +
  • timed : time boxed
  • +
+ Defaults to: fixed +
+ No +
-

20.32 BeanShell configuration

+

20.29 BeanShell configuration

Parameters

Attribute
Description
Required
@@ -1451,7 +1399,12 @@ log_level.org.apache.http.client=DEBUG BeanShell Server properties.
Define the port number as non-zero to start the http server on that port.
The telnet server will be started on the next port.
- Defaults to: 0 + Defaults to: 0 (i.e. don't start the server) +
+ There is no security. Anyone who can connect to the port can issue any BeanShell commands. + These can provide unrestricted access to the JMeter application and the host. + Do not enable the server unless the ports are protected against access, e.g. by a firewall. +
No
@@ -1509,13 +1462,15 @@ log_level.org.apache.http.client=DEBUG No -

20.33 MailerModel configuration

+

+ The file BeanShellListeners.bshrc contains sample definitions + of Test and Thread Listeners.
+

+

20.30 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
@@ -1528,7 +1483,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.34 CSVRead configuration

+

20.31 CSVRead configuration

Parameters

Attribute
Description
Required
@@ -1541,7 +1496,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.35 __time() function configuration

+

20.32 __time() function configuration

Parameters

Attribute
Description
Required
@@ -1572,7 +1527,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.36 CSV DataSet configuration

+

20.33 CSV DataSet configuration

Parameters

Attribute
Description
Required
@@ -1583,7 +1538,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.37 LDAP Sampler configuration

+

20.34 LDAP Sampler configuration

Parameters

Attribute
Description
Required
@@ -1620,16 +1575,10 @@ log_level.org.apache.http.client=DEBUG No
-

20.38 Miscellaneous configuration

+

20.35 Miscellaneous configuration

Parameters

Attribute
Description
Required
-
monitor.buffer.size
- To set the Monitor Health Visualiser buffer size, enter the desired value.
- Defaults to: 800 -
- No -
mirror.server.port
If defined and greater then zero, then start the mirror server on the port.
Defaults to: 0 @@ -1776,11 +1725,11 @@ log_level.org.apache.http.client=DEBUG No
javascript.use_rhino
- Ability to switch to Nashorn as default Javascript Engine used by IfController + Ability to switch to Rhino as default Javascript Engine used by IfController and __javaScript function.
-
JMeter will prefer to use Rhino even if it detects a JRE 8 or higher. - If you want to use Nashorn, set this value to false
- Defaults to: true +
JMeter uses Nashorn since 3.2 version. + If you want to use Rhino, set this value to true
+ Defaults to: false
No
@@ -1891,6 +1840,13 @@ log_level.org.apache.http.client=DEBUG
No
+
view.results.tree.max_results
+ Maximum number of main samples, that should be stored and displayed.
+ A value of 0 will store all results. This might consume a lot of memory.
+ Defaults to: 500 +
+ No +
view.results.tree.max_size
Maximum size (in bytes) of HTML page that can be displayed.
Set to zero to disable the size check and display the whole response.
@@ -1938,7 +1894,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.39 Classpath configuration

+

20.36 Classpath configuration

Parameters

Attribute
Description
Required
@@ -1993,7 +1949,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.40 Reporting configuration

+

20.37 Reporting configuration

Parameters

Attribute
Description
Required
@@ -2294,8 +2250,26 @@ log_level.org.apache.http.client=DEBUG
No
+
jmeter.reportgenerator.date_format
+ Date format of report using by start_date and end_date properties.
+ Defaults to: yyyyMMddHHmmss +
+ No +
+
jmeter.reportgenerator.start_date
+ Start date of report using date_format property.
+ Defaults to: nothing +
+ No +
+
jmeter.reportgenerator.end_date
+ End date of report using date_format property.
+ Defaults to: nothing +
+ No +
-

20.41 Additional property files to load

+

20.38 Additional property files to load

Parameters

Attribute
Description
Required
@@ -2321,7 +2295,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.42 Thread Group Validation feature

+

20.39 Thread Group Validation feature

Validation is the name of the feature used to rapidly validate a Thread Group runs fine

Parameters @@ -2348,6 +2322,12 @@ log_level.org.apache.http.client=DEBUG

No
+
testplan_validation.ignore_backends
+ Ignore BackendListener when validating the thread group of plan.
+ Defaults to: true +
+ No +
testplan_validation.number_iterations
Number of iterations to use to validate a Thread Group.
Defaults to: 1 @@ -2361,7 +2341,7 @@ log_level.org.apache.http.client=DEBUG No
-

20.43 Timer related feature

+

20.40 Timer related feature

Timer are used to introduce think time in your plan.

Parameters @@ -2377,6 +2357,58 @@ log_level.org.apache.http.client=DEBUG

No
+
think_time_creator.impl
+ Default implementation that create the Timer structure to add to Test Plan. + Implementation of interface org.apache.jmeter.gui.action.thinktime.ThinkTimeCreator + Defaults to: org.apache.jmeter.thinktime.DefaultThinkTimeCreator +
+ No +
+
think_time_creator.default_timer_implementation
+ Default Timer GUI class added to Test Plan by DefaultThinkTimeCreator + Defaults to: org.apache.jmeter.timers.gui.UniformRandomTimerGui +
+ No +
+
think_time_creator.default_constant_pause
+ Default constant pause of Timer + Defaults to: 1000 +
+ No +
+
think_time_creator.default_range
+ Default range pause of Timer + Defaults to: 100 +
+ No +
+ +^ +

20.41 Naming Policy

+
Timer are used to introduce think time in your plan.
+

+ Parameters +

Attribute
Description
Required
+
naming_policy.prefix
+ Prefix used when naming elements. + Defaults to empty prefix +
+ No +
+
naming_policy.suffix
+ Prefix used when naming elements. + Defaults to empty suffix +
+ No +
+
naming_policy.impl
+ Implementation of interface org.apache.jmeter.gui.action.TreeNodeNamingPolicy + Default implementation that create the Timer structure to add to Test Plan. + Implementation of interface org.apache.jmeter.gui.action.thinktime.ThinkTimeCreator + Defaults to: org.apache.jmeter.gui.action.impl.DefaultTreeNodeNamingPolicy +
+ No +
^