You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by mi...@apache.org on 2016/11/05 14:26:11 UTC
svn commit: r1768221 [8/11] - in /jmeter/trunk: docs/
docs/images/screenshots/ docs/images/screenshots/dashboard/
docs/images/screenshots/http-config/ docs/localising/ docs/usermanual/
src/core/org/apache/jmeter/util/ xdocs/
Modified: jmeter/trunk/docs/usermanual/generating-dashboard.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/generating-dashboard.html?rev=1768221&r1=1768220&r2=1768221&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/generating-dashboard.html (original)
+++ jmeter/trunk/docs/usermanual/generating-dashboard.html Sat Nov 5 14:26:10 2016
@@ -5,11 +5,11 @@
APACHE LOGO
--><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_
tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="main" id="content">
<div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="remote-test.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="realtime-results.html">Next ></a></li></ul><div class="section"><h1 id="generation">16. Generating Report Dashboard<a class="sectionlink" href="#generation" title="Link to here">¶</a></h1>
+ --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../e
xtending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="mai
n" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="remote-test.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="realtime-results.html">Next ></a></li></ul><div class="section"><h1 id="generation">15. Generating Report Dashboard<a class="sectionlink" href="#generation" title="Link to here">¶</a></h1>
<p>JMeter supports dashboard report generation to get graphs and
statistics from a test plan.<br>
This chapter describes how to configure and use the generator.</p>
- <div class="subsection"><h2 id="overview">16.1 Overview<a class="sectionlink" href="#overview" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="overview">15.1 Overview<a class="sectionlink" href="#overview" title="Link to here">¶</a></h2>
<p>The dashboard generator is a modular extension of JMeter.
Its default behavior is to read and process samples from
CSV files to generate HTML files containing graph views.
@@ -19,30 +19,36 @@
This report provides the following metrics:
<ul>
<li><a href="https://en.wikipedia.org/wiki/Apdex" title="Application Performance Index" target="_blank">APDEX</a> (Application Performance Index) table that computes for every transaction the APDEX based on configurable values for tolerated and satisfied thresholds</li>
- <li>A request summary graph showing the Success and failed transaction percentage: <figure><a href="../images/screenshots/dashboard/report_apdex_and_summary.png"><img src="../images/screenshots/dashboard/report_apdex_and_summary.png" width="1658" height="650" alt=""></a><figcaption></figcaption></figure></li>
- <li>A Statistics table providing in one table a summary of all metrics per transaction including 3 configurable percentiles : <figure><a href="../images/screenshots/dashboard/report_statistics.png"><img src="../images/screenshots/dashboard/report_statistics.png" width="1376" height="433" alt=""></a><figcaption></figcaption></figure></li>
+ <li>A request summary graph showing the Success and failed requests (Transaction Controller Sample Results are not taken into account) percentage: <figure><a href="../images/screenshots/dashboard/report_apdex_and_summary.png"><img src="../images/screenshots/dashboard/report_apdex_and_summary.png" width="1636" height="982" alt=""></a><figcaption></figcaption></figure></li>
+ <li>A Statistics table providing in one table a summary of all metrics per transaction including 3 configurable percentiles : <figure><a href="../images/screenshots/dashboard/report_statistics.png"><img src="../images/screenshots/dashboard/report_statistics.png" width="1639" height="467" alt=""></a><figcaption></figcaption></figure></li>
<li>An error table providing a summary of all errors and their proportion in the total requests : <figure><a href="../images/screenshots/dashboard/report_errors.png"><img src="../images/screenshots/dashboard/report_errors.png" width="1344" height="455" alt=""></a><figcaption></figcaption></figure></li>
+ <li>A Top 5 Errors by Sampler table providing for every Sampler (excluding Transaction Controller by default) the top 5 Errors : <figure><a href="../images/screenshots/dashboard/top_5_errors_by_sampler.png"><img src="../images/screenshots/dashboard/top_5_errors_by_sampler.png" width="1609" height="508" alt=""></a><figcaption></figcaption></figure></li>
<li>Zoomable chart where you can check/uncheck every transaction to show/hide it for:
<ul>
- <li>Response times Over Time : <figure><a href="../images/screenshots/dashboard/report_response_times_over_time.png"><img src="../images/screenshots/dashboard/report_response_times_over_time.png" width="1398" height="566" alt=""></a><figcaption></figcaption></figure></li>
- <li>Bytes throughput Over Time : <figure><a href="../images/screenshots/dashboard/report_bytes_throughput_over_time.png"><img src="../images/screenshots/dashboard/report_bytes_throughput_over_time.png" width="1373" height="543" alt=""></a><figcaption></figcaption></figure></li>
- <li>Latencies Over Time : <figure><a href="../images/screenshots/dashboard/report_latencies_over_time.png"><img src="../images/screenshots/dashboard/report_latencies_over_time.png" width="1373" height="547" alt=""></a><figcaption></figcaption></figure></li>
- <li>Hits per second : <figure><a href="../images/screenshots/dashboard/report_hits_per_second.png"><img src="../images/screenshots/dashboard/report_hits_per_second.png" width="1375" height="552" alt=""></a><figcaption></figcaption></figure></li>
- <li>Response codes per second : <figure><a href="../images/screenshots/dashboard/report_codes_per_second.png"><img src="../images/screenshots/dashboard/report_codes_per_second.png" width="1380" height="558" alt=""></a><figcaption></figcaption></figure></li>
- <li>Transactions per second : <figure><a href="../images/screenshots/dashboard/report_transactions_per_second.png"><img src="../images/screenshots/dashboard/report_transactions_per_second.png" width="1372" height="577" alt=""></a><figcaption></figcaption></figure></li>
- <li>Response Time vs Request per second : <figure><a href="../images/screenshots/dashboard/report_response_time_vs_request.png"><img src="../images/screenshots/dashboard/report_response_time_vs_request.png" width="1380" height="545" alt=""></a><figcaption></figcaption></figure></li>
- <li>Latency vs Request per second : <figure><a href="../images/screenshots/dashboard/report_latencies_vs_request.png"><img src="../images/screenshots/dashboard/report_latencies_vs_request.png" width="1373" height="543" alt=""></a><figcaption></figcaption></figure></li>
- <li>Response times percentiles : <figure><a href="../images/screenshots/dashboard/report_response_time_percentiles.png"><img src="../images/screenshots/dashboard/report_response_time_percentiles.png" width="1374" height="551" alt=""></a><figcaption></figcaption></figure></li>
- <li>Active Threads Over Time : <figure><a href="../images/screenshots/dashboard/report_active_threads_over_time.png"><img src="../images/screenshots/dashboard/report_active_threads_over_time.png" width="1370" height="542" alt=""></a><figcaption></figcaption></figure></li>
- <li>Times vs Threads : <figure><a href="../images/screenshots/dashboard/report_time_vs_threads.png"><img src="../images/screenshots/dashboard/report_time_vs_threads.png" width="1373" height="567" alt=""></a><figcaption></figcaption></figure></li>
- <li>Response Time Distribution : <figure><a href="../images/screenshots/dashboard/report_response_time_distribution.png"><img src="../images/screenshots/dashboard/report_response_time_distribution.png" width="1373" height="549" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response times Over Time (Includes Transaction Controller Sample Results) : <figure><a href="../images/screenshots/dashboard/report_response_times_over_time.png"><img src="../images/screenshots/dashboard/report_response_times_over_time.png" width="1398" height="566" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response times Percentiles Over Time (successful responses only) : <figure><a href="../images/screenshots/dashboard/response_time_percentiles_over_time.png"><img src="../images/screenshots/dashboard/response_time_percentiles_over_time.png" width="1640" height="539" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Active Threads Over Time : <figure><a href="../images/screenshots/dashboard/report_active_threads_over_time.png"><img src="../images/screenshots/dashboard/report_active_threads_over_time.png" width="1638" height="544" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Bytes throughput Over Time (Ignores Transaction Controller Sample Results) : <figure><a href="../images/screenshots/dashboard/report_bytes_throughput_over_time.png"><img src="../images/screenshots/dashboard/report_bytes_throughput_over_time.png" width="1373" height="543" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Latencies Over Time (Includes Transaction Controller Sample Results) : <figure><a href="../images/screenshots/dashboard/report_latencies_over_time.png"><img src="../images/screenshots/dashboard/report_latencies_over_time.png" width="1373" height="547" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Connect Time Over Time (Includes Transaction Controller Sample Results) : <figure><a href="../images/screenshots/dashboard/report_connect_time_over_time.png"><img src="../images/screenshots/dashboard/report_connect_time_over_time.png" width="1635" height="520" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Hits per second (Ignores Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_hits_per_second.png"><img src="../images/screenshots/dashboard/report_hits_per_second.png" width="1375" height="552" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response codes per second (Ignores Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_codes_per_second.png"><img src="../images/screenshots/dashboard/report_codes_per_second.png" width="1380" height="558" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Transactions per second (Includes Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_transactions_per_second.png"><img src="../images/screenshots/dashboard/report_transactions_per_second.png" width="1372" height="577" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response Time vs Request per second (Ignores Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_response_time_vs_request.png"><img src="../images/screenshots/dashboard/report_response_time_vs_request.png" width="1380" height="545" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Latency vs Request per second (Ignores Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_latencies_vs_request.png"><img src="../images/screenshots/dashboard/report_latencies_vs_request.png" width="1373" height="543" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response time Overview (Excludes Transaction Controller Sample Results) : <figure><a href="../images/screenshots/dashboard/response_time_overview.png"><img src="../images/screenshots/dashboard/response_time_overview.png" width="1645" height="562" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Response times percentiles (Includes Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_response_time_percentiles.png"><img src="../images/screenshots/dashboard/report_response_time_percentiles.png" width="1374" height="551" alt=""></a><figcaption></figcaption></figure></li>
+ <li>Times vs Threads (Includes Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_time_vs_threads.png"><img src="../images/screenshots/dashboard/report_time_vs_threads.png" width="1373" height="567" alt=""></a><figcaption></figcaption></figure>
+ <div class="clear"></div><div class="note">In distributed mode, this graph shows a horizontal axis the number of threads for 1 server. It's a current limitation</div><div class="clear"></div>
+ </li>
+ <li>Response Time Distribution (Includes Transaction Controller Sample Results): <figure><a href="../images/screenshots/dashboard/report_response_time_distribution.png"><img src="../images/screenshots/dashboard/report_response_time_distribution.png" width="1373" height="549" alt=""></a><figcaption></figcaption></figure></li>
</ul>
</li>
</ul>
</p>
</div>
- <div class="subsection"><h2 id="configuration">16.2 Configuring Dashboard Generation<a class="sectionlink" href="#configuration" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="configuration">15.2 Configuring Dashboard Generation<a class="sectionlink" href="#configuration" title="Link to here">¶</a></h2>
<p>
Dashboard generation uses JMeter properties to customize the
report. Some properties are used for general settings and others are
@@ -50,13 +56,15 @@
<div class="clear"></div><div class="note">All report generator properties can be found in file <span class="code">reportgenerator.properties</span>.
To customize these properties, you should copy them in <span class="code">user.properties</span> file and modify them.</div><div class="clear"></div>
</p>
- <div class="subsection"><h2 id="configuration_requirements">16.2.1 Requirements<a class="sectionlink" href="#configuration_requirements" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="configuration_requirements">15.2.1 Requirements<a class="sectionlink" href="#configuration_requirements" title="Link to here">¶</a></h2>
<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):
<pre class="source">
jmeter.save.saveservice.bytes = true
+# Only available with HttpClient4
+#jmeter.save.saveservice.sent_bytes=true
jmeter.save.saveservice.label = true
jmeter.save.saveservice.latency = true
jmeter.save.saveservice.response_code = true
@@ -65,6 +73,7 @@ jmeter.save.saveservice.successful = tru
jmeter.save.saveservice.thread_counts = true
jmeter.save.saveservice.thread_name = true
jmeter.save.saveservice.time = true
+jmeter.save.saveservice.connect_time = 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
@@ -75,6 +84,11 @@ jmeter.save.saveservice.timestamp_format
The input CSV file must include the timeStamp
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
+ To ensure most accurate results, if you use a transaction controller, uncheck the box:
+ <span class="code">Generate parent sample</span>
+ <figure><a href="../images/screenshots/transactioncontroller.png"><img src="../images/screenshots/transactioncontroller.png" width="" height="" alt=""></a><figcaption></figcaption></figure>
+ </div><div class="clear"></div>
+ <div class="clear"></div><div class="note">
The "<span class="code">Errors</span>" summary table shows more
accurate data if these settings are fulfilled:
<ul>
@@ -86,10 +100,15 @@ jmeter.save.saveservice.timestamp_format
</li>
</ul>
</div><div class="clear"></div>
+ <div class="clear"></div><div class="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:
+ <pre class="source">ThreadXXX_${__P(JVM_ID)}</pre>
+ where you pass a different JVM_ID property for each jmeter-server through:
+ <pre class="source">-JJVM_ID=i</pre> where <span class="code">i</span> varies between 1 and the number of jmeter-server you are using.
+ </div><div class="clear"></div>
</p>
</div>
- <div class="subsection"><h2 id="configuration_general">16.2.2 General settings<a class="sectionlink" href="#configuration_general" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="configuration_general">15.2.2 General settings<a class="sectionlink" href="#configuration_general" title="Link to here">¶</a></h2>
<div class="clear"></div><div class="note">
All properties must be prefixed with
<pre class="source">jmeter.reportgenerator.</pre>
@@ -98,41 +117,61 @@ jmeter.save.saveservice.timestamp_format
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">report_title</div><div class="description req-false">
- Title used in the generated report.
+ Title used in the generated report.<br>
Default: "Apache JMeter Dashboard"
</div><div class="required req-false">No</div></div>
+ <div class="property"><div class="name req-false">date_format</div><div class="description req-false">
+ Default date format from <a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">
+ SimpleDateFormat Java API</a> with Locale.ENGLISH.<br>
+ Date format is <span class="code">yyyyMMddHHmmss</span><br>
+ Useful when you would generate a report after the load test, and the results file contains timestamp in
+ another time zone. In this case the date format must include the time zone (zzz).<br>
+ Example: <span class="code">dd/MM/yyyy HH:mm:ss zzz</span>
+ </div><div class="required req-false">No</div></div>
+ <div class="property"><div class="name req-false">start_date</div><div class="description req-false">
+ Start date of the range of data to use for report.<br>
+ Date format is defined by date_format property.<br>
+ Default: not filled which means data range will be used from the beginning
+ </div><div class="required req-false">No</div></div>
+ <div class="property"><div class="name req-false">end_date</div><div class="description req-false">
+ End date of the range of data to use for report.<br>
+ Date format is defined by date_format property.<br>
+ Default: not filled which means data range will be used until the end
+ </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">overall_granularity</div><div class="description req-false">
- Granularity of over time graphs. Data is aggregated to have 1 minute ticks.
+ Granularity of over time graphs. Data is aggregated to have 1 minute ticks.<br>
+ <div class="clear"></div><div class="note">Granularity must be higher than 1 second (1000) otherwise throughput graphs will be incorrect</div><div class="clear"></div>
Default: "60000" (1 minute)
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">apdex_satisfied_threshold</div><div class="description req-false">
Sets the satisfaction threshold for the
<a href="https://en.wikipedia.org/wiki/Apdex" target="_blank">APDEX</a>
- calculation (in ms).
+ calculation (in ms).<br>
Default: <span class="code">500</span>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">apdex_tolerated_threshold</div><div class="description req-false">
Sets the tolerance threshold for the APDEX calculation
- (in ms).
+ (in ms).<br>
Default: <span class="code">1500</span>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">sample_filter</div><div class="description req-false">
Sets the filter of samples to keep for generating
graphs and statistics. An empty value deactivates the
- filtering.
- Format: Regular expression.
+ filtering.<br>
+ Format: Regular expression.<br>
Default: ""
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">temp_dir</div><div class="description req-false">
Sets the temporary directory used by the generation
process if it needs file I/O
- operations. Default: <span class="code">temp</span>
+ operations.<br>
+ Default: <span class="code">temp</span>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">statistic_window</div><div class="description req-false">
Sets the size of the sliding window used by percentile
evaluation. Caution: higher value provides a
- better accuracy but needs more memory.
- Default: <span class="code">200000</span>
+ better accuracy but needs more memory.<br>
+ Default: <span class="code">20000</span>
</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">Percentiles used by Summary table and Percentile graphs can be adjusted to different values by using the 3 properties:
@@ -165,7 +204,7 @@ jmeter.save.saveservice.timestamp_format
</div><div class="clear"></div>
</div>
- <div class="subsection"><h2 id="configure_graph">16.2.3 Graph settings<a class="sectionlink" href="#configure_graph" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="configure_graph">15.2.3 Graph settings<a class="sectionlink" href="#configure_graph" title="Link to here">¶</a></h2>
<p>
Each property describing a graph configuration must be prefixed
with
@@ -174,7 +213,7 @@ jmeter.save.saveservice.timestamp_format
</p>
- <div class="subsection"><h2 id="general_graph_properties">16.2.3.1 General properties<a class="sectionlink" href="#general_graph_properties" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="general_graph_properties">15.2.3.1 General properties<a class="sectionlink" href="#general_graph_properties" title="Link to here">¶</a></h2>
<p>All graphs support these properties:</p>
<div class="properties"><h3>
Parameters
@@ -200,7 +239,7 @@ jmeter.save.saveservice.timestamp_format
</div>
</div>
- <div class="subsection"><h2 id="specific_graph_properties">16.2.3.2 Specific properties<a class="sectionlink" href="#specific_graph_properties" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="specific_graph_properties">15.2.3.2 Specific properties<a class="sectionlink" href="#specific_graph_properties" title="Link to here">¶</a></h2>
<p>
Specific graph properties must use the prefix:
<pre class="source">jmeter.reportgenerator.graph.<graph_id>.property</pre>
@@ -218,7 +257,7 @@ jmeter.save.saveservice.timestamp_format
</div>
- <div class="subsection"><h2 id="configure_export">16.2.4 Export settings<a class="sectionlink" href="#configure_export" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="configure_export">15.2.4 Export settings<a class="sectionlink" href="#configure_export" title="Link to here">¶</a></h2>
<p>
Each property describing an exporter configuration must be
prefixed with
@@ -226,7 +265,7 @@ jmeter.save.saveservice.timestamp_format
followed by the exporter identifier.
</p>
- <div class="subsection"><h2 id="general_export_properties">16.2.4.1 General properties<a class="sectionlink" href="#general_export_properties" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="general_export_properties">15.2.4.1 General properties<a class="sectionlink" href="#general_export_properties" title="Link to here">¶</a></h2>
<p>All exporters support these properties:</p>
<div class="properties"><h3>
Parameters
@@ -255,7 +294,7 @@ jmeter.save.saveservice.timestamp_format
</div>
</div>
- <div class="subsection"><h2 id="specific_export_properties">16.2.4.2 Specific properties<a class="sectionlink" href="#specific_export_properties" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="specific_export_properties">15.2.4.2 Specific properties<a class="sectionlink" href="#specific_export_properties" title="Link to here">¶</a></h2>
<p>
Specific exporter properties must use the prefix
<pre class="source">jmeter.reportgenerator.exporter.<exporter_id>.property</pre>
@@ -275,7 +314,7 @@ jmeter.save.saveservice.timestamp_format
</div>
</div>
- <div class="subsection"><h2 id="graph_export_properties">16.2.4.3 Graph properties<a class="sectionlink" href="#graph_export_properties" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="graph_export_properties">15.2.4.3 Graph properties<a class="sectionlink" href="#graph_export_properties" title="Link to here">¶</a></h2>
<p>
Graph properties allow exporters to overwrite some graph data.
<br>
@@ -296,7 +335,7 @@ jmeter.save.saveservice.timestamp_format
</div>
</div>
- <div class="subsection"><h2 id="export_filtering">16.2.4.4 Filtering mechanisms<a class="sectionlink" href="#export_filtering" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="export_filtering">15.2.4.4 Filtering mechanisms<a class="sectionlink" href="#export_filtering" title="Link to here">¶</a></h2>
<p>
Unlike the filtering in the section
<a href="#configure_general">General properties</a>
@@ -452,7 +491,7 @@ jmeter.save.saveservice.timestamp_format
</div>
</div>
- <div class="subsection"><h2 id="sample_configuration">16.2.5 Sample configuration<a class="sectionlink" href="#sample_configuration" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="sample_configuration">15.2.5 Sample configuration<a class="sectionlink" href="#sample_configuration" title="Link to here">¶</a></h2>
<p>You can copy the following configuration to your user.properties
file in order to test the report generator.</p>
<pre class="source">
@@ -460,6 +499,8 @@ jmeter.save.saveservice.timestamp_format
#jmeter.reportgenerator.report_title=Apache JMeter Dashboard
# Change this parameter if you want to change the granularity of over time graphs.
+# Granularity must be higher than 1000 (1second) otherwise Throughput graphs will be incorrect
+# see Bug 60149
#jmeter.reportgenerator.overall_granularity=60000
Change this parameter if you want to change the granularity of Response time distribution
@@ -506,20 +547,20 @@ jmeter.reportgenerator.exporter.html.fil
</div>
- <div class="subsection"><h2 id="report">16.3 Generating reports<a class="sectionlink" href="#report" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="report">15.3 Generating reports<a class="sectionlink" href="#report" title="Link to here">¶</a></h2>
<p>
The report generation can be done as a stand alone process from a
sample log file or automatically after running load test.
</p>
- <div class="subsection"><h2 id="report_only">16.3.1 Generation from an existing sample CSV log file<a class="sectionlink" href="#report_only" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="report_only">15.3.1 Generation from an existing sample CSV log file<a class="sectionlink" href="#report_only" title="Link to here">¶</a></h2>
<p>
Use the following command:
<pre class="source">jmeter -g <log file> -o <Path to output folder></pre>
</p>
</div>
- <div class="subsection"><h2 id="report_after_load_test">16.3.2 Generation after load test<a class="sectionlink" href="#report_after_load_test" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="report_after_load_test">15.3.2 Generation after load test<a class="sectionlink" href="#report_after_load_test" title="Link to here">¶</a></h2>
<p>
Use the following command:
<pre class="source">jmeter -n -t <test JMX file> -l <test log file> -e -o <Path to output folder></pre>
@@ -527,7 +568,7 @@ jmeter.reportgenerator.exporter.html.fil
</div>
</div>
- <div class="subsection"><h2 id="default_graphs">16.4 Default graphs<a class="sectionlink" href="#default_graphs" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="default_graphs">15.4 Default graphs<a class="sectionlink" href="#default_graphs" title="Link to here">¶</a></h2>
<div class="clear"></div><div class="note">Due to limitations of this early version, each default graph
must be declared in JMeter properties. Otherwise, the graph
views will be empty.</div><div class="clear"></div>
@@ -575,6 +616,11 @@ jmeter.reportgenerator.exporter.html.fil
<td>True</td>
</tr>
<tr>
+ <td>ConnectTimeOverTimeGraphConsumer</td>
+ <td>This graph represents the connection time over time.</td>
+ <td>True</td>
+ </tr>
+ <tr>
<td>LatencyVSRequestGraphConsumer</td>
<td>This graph represents the median and average latency time
depending on the number of current requests.</td>
@@ -598,6 +644,11 @@ jmeter.reportgenerator.exporter.html.fil
<td>True</td>
</tr>
<tr>
+ <td>ResponseTimePercentilesOverTimeGraphConsumer</td>
+ <td>This graph shows Min/Max and 3 percentiles response time over time.</td>
+ <td>True</td>
+ </tr>
+ <tr>
<td>ResponseTimeVSRequestGraphConsumer</td>
<td>This graph represents the median and average response time
depending on the number of current requests.</td>
@@ -638,7 +689,7 @@ jmeter.reportgenerator.exporter.html.fil
</tbody>
</table>
</div>
- <div class="subsection"><h2 id="development">16.5 Want to improve Report Dashboard ?<a class="sectionlink" href="#development" title="Link to here">¶</a></h2>
+ <div class="subsection"><h2 id="development">15.5 Want to improve Report Dashboard ?<a class="sectionlink" href="#development" title="Link to here">¶</a></h2>
If you want to contribute new graphs or improve current ones, you
can read this <a href="../devguide-dashboard.html">developer documentation</a>.<br>
Read this <a href="../building.html">documentation</a> on contributing.
Modified: jmeter/trunk/docs/usermanual/get-started.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/get-started.html?rev=1768221&r1=1768220&r2=1768221&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/get-started.html (original)
+++ jmeter/trunk/docs/usermanual/get-started.html Sat Nov 5 14:26:10 2016
@@ -5,7 +5,51 @@
APACHE LOGO
--><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_
tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="main" id="content">
<div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="intro.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul><div class="section"><h1 id="get_started">2. Getting Started<a class="sectionlink" href="#get_started" title="Link to here">¶</a></h1>
+ --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../e
xtending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="mai
n" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul><div class="section"><h1 id="get_started">1. Getting Started<a class="sectionlink" href="#get_started" title="Link to here">¶</a></h1>
+<div class="section"><h1 id="overview">1.0 Overview<a class="sectionlink" href="#overview" title="Link to here">¶</a></h1>
+When using JMeter you will usually follow this process:
+<div class="subsection"><h2 id="test_plan_building">1.0.1 Test plan building<a class="sectionlink" href="#test_plan_building" title="Link to here">¶</a></h2>
+<p>To do that, you will <a href="get-started.html#running">run JMeter in GUI Mode.</a><br>
+Then you can either choose to record the application from a browser, or native application.
+You can use for that the menu <span class="menuchoice"><span class="guimenuitem">File</span> → <span class="guimenuitem">Templates...</span> → <span class="guimenuitem">Recording</span></span><br>
+</p>
+<p>
+Note you can also manually build your plan. Ensure you read this <a href="test_plan.html">documentation</a> to understand major concepts.
+</p>
+You will also debug it using one of these options:
+<ul>
+ <li><span class="menuchoice"><span class="guimenuitem">Run</span> → <span class="guimenuitem">Start no pauses</span></span></li>
+ <li><span class="menuchoice"><span class="guimenuitem">Run</span> → <span class="guimenuitem">Start</span></span></li>
+ <li><span class="menuchoice"><span class="guimenuitem">Validate</span></span> on <a href="component_reference.html#Thread_Group">Thread Group</a></li>
+</ul>
+<p>
+and <a href="component_reference.html#View_Results_Tree">View Results Tree</a> renderers or Testers (CSS/JQUERY, JSON, Regexp, XPath).<br>
+Ensure you follow <a href="best-practices.html">best-practices</a> when building your Test Plan.
+</p>
+</div>
+<div class="subsection"><h2 id="load_test_running">1.0.2 Load Test running<a class="sectionlink" href="#load_test_running" title="Link to here">¶</a></h2>
+<p>Once your Test Plan is ready, you can start your Load Test.
+The first step is to configure the injectors that will run JMeter, this as for any other Load Testing tool includes:
+<ul>
+ <li>Correct machine sizing in terms of CPU, memory and network</li>
+ <li>OS Tuning</li>
+ <li>Java setup: Ensure you install the latest version of Java supported by JMeter</li>
+ <li><b>Correct sizing of Java Heap</b>. By default JMeter runs with a heap of 512MB, this might not be enough for your test and depends on your test plan and number of threads you want to run</li>
+</ul>
+
+Once everything is ready, you will use Command-line mode (called <a href="#non_gui">Non-GUI mode</a>) to run it for the Load Test.
+<div class="clear"></div><div class="note">Don't run load test using GUI mode !</div><div class="clear"></div><br>
+Using Non-GUI mode, you can generate a CSV (or XML) file containing results and have JMeter <a href="generating-dashboard.html">generate an HTML report</a> at end of Load Test.
+JMeter will by default provide a summary of load test while it's running. <br>
+You can also have <a href="realtime-results.html">real-time results</a> during your test using <a href="component_reference.html#Backend_Listener">Backend Listener</a>.
+</p>
+</div>
+<div class="subsection"><h2 id="load_test_analysis">1.0.3 Load Test analysis<a class="sectionlink" href="#load_test_analysis" title="Link to here">¶</a></h2>
+Once your Load Test is finished, you can use the HTML report to analyze your load test. <br>
+</div>
+</div>
+
+<div class="subsection"><h2 id="lets_start">1.0.4 Let's start<a class="sectionlink" href="#lets_start" title="Link to here">¶</a></h2>
<p>The easiest way to begin using JMeter is to first
<a href="http://jmeter.apache.org/download_jmeter.cgi">download the latest production release</a> and install it.
The release contains all of the files you need to build and run most types of tests,
@@ -40,18 +84,19 @@ The other specific Test Plan sections ar
<p>Once you are comfortable with building and running JMeter Test Plans, you can look into the
various configuration elements (timers, listeners, assertions, and others) which give you more control
over your Test Plans.</p>
-
-</div><div class="section"><h1 id="requirements">2.1 Requirements<a class="sectionlink" href="#requirements" title="Link to here">¶</a></h1>
+</div>
+</div><div class="section"><h1 id="requirements">1.1 Requirements<a class="sectionlink" href="#requirements" title="Link to here">¶</a></h1>
<p>JMeter requires that your computing environment meets some minimum requirements.</p>
-<div class="subsection"><h2 id="java_versions">2.1.1 Java Version<a class="sectionlink" href="#java_versions" title="Link to here">¶</a></h2>
-<div class="clear"></div><div class="note">JMeter requires a fully compliant JVM 7 or higher.
+<div class="subsection"><h2 id="java_versions">1.1.1 Java Version<a class="sectionlink" href="#java_versions" title="Link to here">¶</a></h2>
+<div class="clear"></div><div class="note">JMeter requires a fully compliant JVM 7 or 8, we advise that you install latest minor version of those major versions.
+Java 9 is not tested completely as of JMeter 3.1.
</div><div class="clear"></div>
<p>Because JMeter uses only standard Java APIs, please do not file bug reports if your JRE fails to run
JMeter because of JRE implementation issues.</p>
</div>
-<div class="subsection"><h2 id="os">2.1.2 Operating Systems<a class="sectionlink" href="#os" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="os">1.1.2 Operating Systems<a class="sectionlink" href="#os" title="Link to here">¶</a></h2>
<p>JMeter is a 100% Java application and should run correctly on any system
that has a compliant Java implementation.</p>
<p>Operating systems tested with JMeter can be viewed on
@@ -59,29 +104,29 @@ that has a compliant Java implementation
on JMeter wiki.</p>
<p>Even if your OS is not listed on the wiki page, JMeter should run on it provided that the JVM is compliant.</p>
</div>
-</div><div class="section"><h1 id="optional">2.2 Optional<a class="sectionlink" href="#optional" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="optional">1.2 Optional<a class="sectionlink" href="#optional" title="Link to here">¶</a></h1>
<p>If you plan on doing JMeter development, then you will need one or more optional packages listed below.</p>
-<div class="subsection"><h2 id="opt_compiler">2.2.1 Java Compiler<a class="sectionlink" href="#opt_compiler" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_compiler">1.2.1 Java Compiler<a class="sectionlink" href="#opt_compiler" title="Link to here">¶</a></h2>
<p>If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK 7 or higher.</p>
</div>
-<div class="subsection"><h2 id="opt_sax">2.2.2 SAX XML Parser<a class="sectionlink" href="#opt_sax" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_sax">1.2.2 SAX XML Parser<a class="sectionlink" href="#opt_sax" title="Link to here">¶</a></h2>
<p>JMeter comes with Apache's <a href="http://xml.apache.org/">Xerces XML parser</a>. You have the option of telling JMeter
to use a different XML parser. To do so, include the classes for the third-party parser in JMeter's <a href="#classpath">classpath</a>,
and update the <a href="#configuring_jmeter">jmeter.properties</a> file with the full classname of the parser
implementation.</p>
</div>
-<div class="subsection"><h2 id="opt_email">2.2.3 Email Support<a class="sectionlink" href="#opt_email" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_email">1.2.3 Email Support<a class="sectionlink" href="#opt_email" title="Link to here">¶</a></h2>
<p>JMeter has extensive Email capabilities.
It can send email based on test results, and has a POP3(S)/IMAP(S) sampler.
It also has an SMTP(S) sampler.
</p>
</div>
-<div class="subsection"><h2 id="opt_ssl">2.2.4 SSL Encryption<a class="sectionlink" href="#opt_ssl" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_ssl">1.2.4 SSL Encryption<a class="sectionlink" href="#opt_ssl" title="Link to here">¶</a></h2>
<p>To test a web server using SSL encryption (HTTPS), JMeter requires that an
implementation of SSL be provided, as is the case with Sun Java 1.4 and above.
If your version of Java does not include SSL support, then it is possible to add an external implementation.
@@ -102,13 +147,13 @@ The SMTP sampler can optionally use a lo
</p>
</div>
-<div class="subsection"><h2 id="opt_jdbc">2.2.5 JDBC Driver<a class="sectionlink" href="#opt_jdbc" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_jdbc">1.2.5 JDBC Driver<a class="sectionlink" href="#opt_jdbc" title="Link to here">¶</a></h2>
<p>You will need to add your database vendor's JDBC driver to the <a href="#classpath">classpath</a> if you want to do JDBC testing.
Make sure the file is a jar file, not a zip.
</p>
</div>
-<div class="subsection"><h2 id="opt_jms">2.2.6 JMS client<a class="sectionlink" href="#opt_jms" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="opt_jms">1.2.6 JMS client<a class="sectionlink" href="#opt_jms" title="Link to here">¶</a></h2>
<p>
JMeter now includes the JMS API from Apache Geronimo, so you just need to add the appropriate JMS Client implementation
jar(s) from the JMS provider. Please refer to their documentation for details.
@@ -116,7 +161,7 @@ There may also be some information on th
</p>
</div>
-<div class="subsection"><h2 id="libraries_activemq">2.2.7 Libraries for ActiveMQ JMS<a class="sectionlink" href="#libraries_activemq" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="libraries_activemq">1.2.7 Libraries for ActiveMQ JMS<a class="sectionlink" href="#libraries_activemq" title="Link to here">¶</a></h2>
<p>
You will need to add the jar <span class="code">activemq-all-X.X.X.jar</span> to your classpath, e.g. by storing it in the <span class="code">lib/</span> directory.
</p>
@@ -132,7 +177,7 @@ for details.
<div class="clear"></div><div class="note">
See the <a href="#classpath">JMeter Classpath</a> section for more details on installing additional jars.
</div><div class="clear"></div>
-</div><div class="section"><h1 id="install">2.3 Installation<a class="sectionlink" href="#install" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="install">1.3 Installation<a class="sectionlink" href="#install" title="Link to here">¶</a></h1>
<p>We recommend that most users run the <a href="http://jmeter.apache.org/download_jmeter.cgi">latest release</a>.</p>
<p>To install a release build, simply unzip the zip/tar file into the directory
@@ -156,11 +201,12 @@ apache-jmeter-X.Y/printable_docs
</pre>
You can rename the parent directory (i.e. <span class="code">apache-jmeter-X.Y</span>) if you want, but do not change any of the sub-directory names.
</p>
-</div><div class="section"><h1 id="running">2.4 Running JMeter<a class="sectionlink" href="#running" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="running">1.4 Running JMeter<a class="sectionlink" href="#running" title="Link to here">¶</a></h1>
<br>
<p>To run JMeter, run the <span class="code">jmeter.bat</span> (for Windows) or <span class="code">jmeter</span> (for Unix) file.
These files are found in the bin directory.
After a short time, the JMeter GUI should appear.
+<div class="clear"></div><div class="note">GUI mode should only be used for creating the test script, NON GUI mode must be used for load testing</div><div class="clear"></div>
</p>
<p>
@@ -210,7 +256,7 @@ The <span class="code">JVM_ARGS</span> e
JVM_ARGS="-Xms1024m -Xmx1024m" jmeter -t test.jmx [etc.]
</pre>
will override the HEAP settings in the script.
-<div class="subsection"><h2 id="classpath">2.4.1 JMeter's Classpath<a class="sectionlink" href="#classpath" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="classpath">1.4.1 JMeter's Classpath<a class="sectionlink" href="#classpath" title="Link to here">¶</a></h2>
<p>JMeter automatically finds classes from jars in the following directories:</p>
<dl>
<dt><span class="code">JMETER_HOME/lib</span></dt><dd>used for utility jars</dd>
@@ -244,7 +290,7 @@ options when <span class="code">-jar</sp
<div class="clear"></div><div class="note">This occurs with all Java programs, not just JMeter.</div><div class="clear"></div>
</div>
-<div class="subsection"><h2 id="template">2.4.2 Create Test Plan from Template<a class="sectionlink" href="#template" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="template">1.4.2 Create Test Plan from Template<a class="sectionlink" href="#template" title="Link to here">¶</a></h2>
<p>You have the ability to create a new Test Plan from existing template.</p>
<p>To do so you use the menu
<span class="menuchoice"><span class="guimenuitem">File</span> → <span class="guimenuitem">Templates…</span></span> or Templates icon:
@@ -256,7 +302,7 @@ options when <span class="code">-jar</sp
<p>A documentation for each template explains what to do once test plan is created from template.</p>
</div>
-<div class="subsection"><h2 id="proxy_server">2.4.3 Using JMeter behind a proxy<a class="sectionlink" href="#proxy_server" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="proxy_server">1.4.3 Using JMeter behind a proxy<a class="sectionlink" href="#proxy_server" title="Link to here">¶</a></h2>
<p>If you are testing from behind a firewall/proxy server, you may need to provide JMeter with
the firewall/proxy server hostname and port number. To do so, run the <span class="code">jmeter[.bat]</span> file
from a command line with the following parameters:</p>
@@ -300,8 +346,8 @@ This is only used for recording HTTP or
This is not to be confused with the proxy settings described above, which are used when JMeter makes HTTP or HTTPS requests itself.</div><div class="clear"></div>
</div>
-<div class="subsection"><h2 id="non_gui">2.4.4 Non-GUI Mode (Command Line mode)<a class="sectionlink" href="#non_gui" title="Link to here">¶</a></h2>
-<p>For non-interactive testing, you may choose to run JMeter without the GUI. To do so, use
+<div class="subsection"><h2 id="non_gui">1.4.4 Non-GUI Mode (Command Line mode)<a class="sectionlink" href="#non_gui" title="Link to here">¶</a></h2>
+<p>For load testing, you must run JMeter in this mode (Without the GUI) to get the optimal results from it. To do so, use
the following command options:</p>
<dl>
<dt><span class="code">-n</span></dt><dd>This specifies JMeter is to run in non-gui mode</dd>
@@ -328,7 +374,7 @@ Normally this is not necessary.
</p>
</div>
-<div class="subsection"><h2 id="server">2.4.5 Server Mode<a class="sectionlink" href="#server" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="server">1.4.5 Server Mode<a class="sectionlink" href="#server" title="Link to here">¶</a></h2>
<p>For <a href="remote-test.html">distributed testing</a>, run JMeter in server mode on the remote node(s), and then control the server(s) from the GUI.
You can also use non-GUI mode to run remote tests.
To start the server(s), run <span class="code">jmeter-server[.bat]</span> on each server host.</p>
@@ -359,7 +405,7 @@ Normally this is not necessary.
</p>
</div>
-<div class="subsection"><h2 id="override">2.4.6 Overriding Properties Via The Command Line<a class="sectionlink" href="#override" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="override">1.4.6 Overriding Properties Via The Command Line<a class="sectionlink" href="#override" title="Link to here">¶</a></h2>
<p>Java system properties, JMeter properties, and logging properties can be overridden directly on the command line
(instead of modifying <span class="code">jmeter.properties</span>).
To do so, use the following options:</p>
@@ -383,7 +429,7 @@ jmeter -Duser.dir=/home/mstover/jmeter_s
Attempts to use the <span class="code">-J</span> flag to update <span class="code">log_level</span> or <span class="code">log_file</span> properties will have no effect.
</div><div class="clear"></div>
</div>
-<div class="subsection"><h2 id="logging">2.4.7 Logging and error messages<a class="sectionlink" href="#logging" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="logging">1.4.7 Logging and error messages<a class="sectionlink" href="#logging" title="Link to here">¶</a></h2>
<div class="clear"></div><div class="note">
JMeter does not generally use pop-up dialog boxes for errors, as these would interfere with
running tests. Nor does it report any error for a mis-spelt variable or function; instead the
@@ -427,7 +473,7 @@ jmeter -Duser.dir=/home/mstover/jmeter_s
<p>The log file can be helpful in determining the cause of an error,
as JMeter does not interrupt a test to display an error dialogue.</p>
</div>
-<div class="subsection"><h2 id="options">2.4.8 Full list of command-line options<a class="sectionlink" href="#options" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="options">1.4.8 Full list of command-line options<a class="sectionlink" href="#options" title="Link to here">¶</a></h2>
<p>Invoking JMeter as "<span class="code">jmeter -?</span>" will print a list of all the command-line options.
These are shown below.</p>
<pre class="source">
@@ -497,7 +543,7 @@ that was run in interactive mode.
</p>
</div>
-<div class="subsection"><h2 id="shutdown">2.4.9 non-GUI shutdown<a class="sectionlink" href="#shutdown" title="Link to here">¶</a></h2>
+<div class="subsection"><h2 id="shutdown">1.4.9 non-GUI shutdown<a class="sectionlink" href="#shutdown" title="Link to here">¶</a></h2>
<p>
Prior to version 2.5.1, JMeter invoked <span class="code">System.exit()</span> when a non-GUI test completed.
This caused problems for applications that invoke JMeter directly, so JMeter no longer invokes <span class="code">System.exit()</span>
@@ -514,7 +560,7 @@ If set to <span class="code">0</span>, t
</p>
</div>
-</div><div class="section"><h1 id="configuring_jmeter">2.5 Configuring JMeter<a class="sectionlink" href="#configuring_jmeter" title="Link to here">¶</a></h1>
+</div><div class="section"><h1 id="configuring_jmeter">1.5 Configuring JMeter<a class="sectionlink" href="#configuring_jmeter" title="Link to here">¶</a></h1>
<p>If you wish to modify the properties with which JMeter runs you need to
either modify the <span class="code">user.properties</span> in the <span class="code">/bin</span> directory or create
your own copy of the <span class="code">jmeter.properties</span> and specify it in the command line.
@@ -614,7 +660,7 @@ If set to <span class="code">0</span>, t
<p><b>
See also the comments in the <span class="code">jmeter.properties</span>, <span class="code">user.properties</span> and <span class="code">system.properties</span> files for further information on other settings you can change.
</b></p>
-</div><ul class="pagelinks"><li><a href="intro.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul><div class="share-links">
+</div><ul class="pagelinks"><li><a href="../index.html">Index</a></li><li><a href="build-test-plan.html">Next ></a></li></ul><div class="share-links">
Share this page:
<ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
Copyright ©
Modified: jmeter/trunk/docs/usermanual/glossary.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/glossary.html?rev=1768221&r1=1768220&r2=1768221&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/glossary.html (original)
+++ jmeter/trunk/docs/usermanual/glossary.html Sat Nov 5 14:26:10 2016
@@ -5,7 +5,7 @@
APACHE LOGO
--><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_
tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="main" id="content">
<div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="section"><h1 id="glossary">24. Glossary<a class="sectionlink" href="#glossary" title="Link to here">¶</a></h1>
+ --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.
html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../e
xtending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="mai
n" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="history_future.html">Next ></a></li></ul><div class="section"><h1 id="glossary">24. Glossary<a class="sectionlink" href="#glossary" title="Link to here">¶</a></h1>
<p>
<a name="Elapsed"><b>Elapsed time</b></a>. JMeter measures the elapsed time from just before sending the request to
@@ -28,7 +28,7 @@ browser or other application client.
<p>
<a name="Connect"><b>Connect Time</b></a>. JMeter measures the time it took to establish the connection, including SSL handshake. Note that connect time is not automatically subtracted from <a href="#Latency">latency</a>.
In case of connection error, the metric will be equal to the time it took to face the error, for example in case of Timeout, it should be equal to connection timeout.
-<div class="clear"></div><div class="note">As of JMeter 3.0, this metric is only computed to TCP Sampler and HTTP Request.</div><div class="clear"></div>
+<div class="clear"></div><div class="note">As of JMeter 3.1, this metric is only computed for TCP Sampler, HTTP Request and JDBC Request.</div><div class="clear"></div>
</p>
<p>
@@ -82,7 +82,7 @@ The formula is: Throughput = (number of
</p>
-</div><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="share-links">
+</div><ul class="pagelinks"><li><a href="hints_and_tips.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="history_future.html">Next ></a></li></ul><div class="share-links">
Share this page:
<ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
Copyright ©