Author: pmouawad
Date: Wed Sep 5 19:24:39 2018
New Revision: 1840153
URL: http://svn.apache.org/viewvc?rev=1840153&view=rev
Log:
Try to improve dashboard generation documentation following questions on SO and
mailing list
Added:
jmeter/trunk/xdocs/images/screenshots/apply_naming_policy1.png (with
props)
jmeter/trunk/xdocs/images/screenshots/apply_naming_policy2.png (with
props)
jmeter/trunk/xdocs/images/screenshots/thread_group_distributed.png (with
props)
Modified:
jmeter/trunk/xdocs/usermanual/generating-dashboard.xml
Added: jmeter/trunk/xdocs/images/screenshots/apply_naming_policy1.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/apply_naming_policy1.png?rev=1840153&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jmeter/trunk/xdocs/images/screenshots/apply_naming_policy1.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: jmeter/trunk/xdocs/images/screenshots/apply_naming_policy2.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/apply_naming_policy2.png?rev=1840153&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jmeter/trunk/xdocs/images/screenshots/apply_naming_policy2.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: jmeter/trunk/xdocs/images/screenshots/thread_group_distributed.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/thread_group_distributed.png?rev=1840153&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jmeter/trunk/xdocs/images/screenshots/thread_group_distributed.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: jmeter/trunk/xdocs/usermanual/generating-dashboard.xml
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/generating-dashboard.xml?rev=1840153&r1=1840152&r2=1840153&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/generating-dashboard.xml (original)
+++ jmeter/trunk/xdocs/usermanual/generating-dashboard.xml Wed Sep 5 19:24:39
2018
@@ -66,10 +66,17 @@
To customize these properties, you should copy them in
<code>user.properties</code> file and modify them.</note>
</p>
<subsection name="§-num;.2.1 Requirements"
anchor="configuration_requirements">
+ <subsection name="§-num;.2.1.1 Filtering
configuration" anchor="saveservice_requirements">
+ Ensure you set property
<code>jmeter.reportgenerator.exporter.html.series_filter</code> to keep only
the transactions
+ you want in the report if you don't want
everything.<br/>
+ In the example below you must only modify
<code>Search|Order</code>, keep the rest:
+
<source>jmeter.reportgenerator.exporter.html.series_filter=^(Search|Order)(-success|-failure)?$</source>
+ </subsection>
+ <subsection name="§-num;.2.1.2 Save Service
configuration" anchor="saveservice_requirements">
<p>
- To enable the generator to operate, the input CSV files
- must include certain required data. Check that your
JMeter
- configuration follows these settings (these are the
defaults):
+ To enable the generator to operate, the CSV file
generated by JMeter
+ must include certain required data which <b>are
correct by default in the last live version</b> of JMeter.<br/>
+ If you modified those settings, check that your JMeter
configuration follows these settings (these are the defaults):
<source>
jmeter.save.saveservice.bytes = true
# Only available with HttpClient4
@@ -83,38 +90,43 @@ jmeter.save.saveservice.thread_counts =
jmeter.save.saveservice.thread_name = true
jmeter.save.saveservice.time = true
jmeter.save.saveservice.connect_time = true
+jmeter.save.saveservice.assertion_results_failure_message = true
# the timestamp format must include the time and should include the date.
# For example the default, which is milliseconds since the epoch:
jmeter.save.saveservice.timestamp_format = ms
# Or the following would also be suitable
-jmeter.save.saveservice.timestamp_format = yyyy/MM/dd HH:mm:ss
+# jmeter.save.saveservice.timestamp_format = yyyy/MM/dd HH:mm:ss
</source>
- <note>
- The input CSV file must include the timeStamp
- </note>
- <note>
- To ensure most accurate results, if you use a
transaction controller, uncheck the box:
- <code>Generate parent sample</code>
- <figure image="transactioncontroller.png"></figure>
- </note>
- <note>
- The "<code>Errors</code>" summary table shows more
- accurate data if these settings are fulfilled:
- <ul>
-
<li><source>jmeter.save.saveservice.assertion_results_failure_message =
true</source></li>
- <li>
- If you use a transaction controller,
uncheck the box
- <code>Generate parent sample</code>
- <figure
image="transactioncontroller.png"></figure>
- </li>
- </ul>
- </note>
- <note>When using JMeter distributed mode with multiple
jmeter-server instances, ensure you add in your Thread Groups something that
uniquely identifies ThreadGroup for every JVM, example:
- <source>ThreadXXX_${__P(JVM_ID)}</source>
- where you pass a different JVM_ID property for each
jmeter-server through:
+ </p>
+ </subsection>
+ <subsection name="§-num;.2.1.3 Transaction Controller
configuration" anchor="transaction_controller_requirements">
+ <p>
+ If you use <code>Transaction Controller</code>s, to
ensure most accurate results:
+ <ul>
+ <li>uncheck the box (<b>this is the default
configuration</b>):
+ <code>Generate parent sample</code>
+ <figure image="transactioncontroller.png"></figure>
+ </li>
+ <li>
+ If <code>Transaction Controller</code> is used as
a Container to represent a request for an HTML Page that will trigger Ajax
calls and you
+ only want in your report the Transaction
Controller, then Right click on the node and Apply Naming Policy
+ <figure image="apply_naming_policy1.png"></figure>
+ You will obtain this:
+ <figure image="apply_naming_policy2.png"></figure>
+ </li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="§-num;.2.1.4 Distributed Testing
configuration" anchor="distributed_requirements">
+ <p>
+ If your are using JMeter distributed mode with
multiple jmeter-server instances, ensure you add in your Thread Groups
something that uniquely identifies ThreadGroup for every JVM, example:
+ <source>TG_${__P(JVM_ID)}</source>
+ <figure image="thread_group_distributed.png"></figure>
+ where you pass a different JVM_ID property for each
jmeter-server through <code><funclink name="__P()"/></code> function:
<source>-JJVM_ID=i</source> where <code>i</code>
varies between 1 and the number of jmeter-server you are using.
- </note>
+
</p>
+ </subsection>
</subsection>
<subsection name="§-num;.2.2 General settings"
anchor="configuration_general">
