Skip to content

Commit

Permalink
Prepare next release 3.0: update docs tree and overview (RC5)
Browse files Browse the repository at this point in the history 
git-svn-id: https://svn.apache.org/repos/asf/jmeter/trunk@1743805 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
@milamberspace
milamberspace committed May 14, 2016
1 parent 09dda20 commit 20a5563
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
5 changes: 5 additions & 0 deletions docs/usermanual/component_reference.html
View file
Expand Up @@ -5793,6 +5793,11 @@ <h4>Installing the JMeter CA certificate for HTTPS recording</h4>
The passwords are stored in the local preferences area.
Please ensure that only trusted users have access to the host with the keystore.
</p>
<div class="clear"></div><div class="note">
The popup that displays once you start the Recorder is an informational popup:
<figure><a href="../images/screenshots/recorder_popup_info.png"><img src="../images/screenshots/recorder_popup_info.png" width="1024" height="749" alt="Recorder Install Certificate Popup"></a><figcaption>Recorder Install Certificate Popup</figcaption></figure>
Just click ok and proceed further.
</div><div class="clear"></div>
<h5>Installing the certificate in Firefox</h5>
<p>
Choose the following options:
Expand Down
37 changes: 23 additions & 14 deletions docs/usermanual/generating-dashboard.html
View file
Expand Up @@ -18,7 +18,7 @@
<p>
This report provides the following metrics:
<ul>
<li><a href="https://en.wikipedia.org/wiki/Apdex" target="_blank">APDEX</a> table that computes for every transaction the APDEX based on configurable values for tolerated and satisfied thresholds</li>
<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>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>
Expand Down Expand Up @@ -53,8 +53,8 @@
<div class="subsection"><h2 id="configuration_requirements">16.2.1 Requirements<a class="sectionlink" href="#configuration_requirements" title="Link to here">&para;</a></h2>
<p>
To enable the generator to operate, the input CSV files
must include required data. Check that your JMeter
configuration follows these settings:
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
jmeter.save.saveservice.label = true
Expand All @@ -65,11 +65,14 @@
jmeter.save.saveservice.thread_counts = true
jmeter.save.saveservice.thread_name = true
jmeter.save.saveservice.time = true
# You can use any other format than the one shown here
# 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
</pre>
<div class="clear"></div><div class="note">
Property <span class="code">jmeter.save.saveservice.timestamp_format</span> must be set
The input CSV file must include the timeStamp
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
The "<span class="code">Errors</span>" summary table shows more
Expand Down Expand Up @@ -132,7 +135,13 @@
Default: <span class="code">200000</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:
<ul>
<li>aggregate_rpt_pct1 : Defaults to 90</li>
<li>aggregate_rpt_pct2 : Defaults to 95</li>
<li>aggregate_rpt_pct3 : Defaults to 99</li>
</ul>
</div><div class="clear"></div>
<div class="clear"></div><div class="note">Relative paths are built from the JMeter working directory
(default: <span class="code">bin</span>).</div><div class="clear"></div>

Expand All @@ -142,7 +151,7 @@
generator configuration. These properties are freely named
but you should use the prefix
<pre class="source">jmeter.reportgenerator.</pre>
in order to avoid properties overlap.
in order to avoid property overlap.
</p>
<p>
E.g.:
Expand Down Expand Up @@ -293,7 +302,7 @@
<a href="#configure_general">General properties</a>
which discards data before calculations, here the
filtering is performed after the calculations and serves
to lighten the final report.
to simplify the final report.
</p>
<p>
The property <span class="code">series_filter</span>
Expand Down Expand Up @@ -423,13 +432,13 @@
</table>
</p>
<div class="clear"></div><div class="note">
A wrong filtering configuration can lead to generate empty
Incorrect filter configuration can lead to generate empty
graphs/summary tables:
<ul>
<li>
If you set the property
<span class="code">show_controllers_only</span>
whereas the graph is configured to exclude
and the graph is configured to exclude
controllers.
</li>
<li>
Expand All @@ -444,14 +453,14 @@
</div>

<div class="subsection"><h2 id="sample_configuration">16.2.5 Sample configuration<a class="sectionlink" href="#sample_configuration" title="Link to here">&para;</a></h2>
<p>You can copy the following configuration in your user.properties
<p>You can copy the following configuration to your user.properties
file in order to test the report generator.</p>
<pre class="source">
# Configure this property to change the report title
#jmeter.reportgenerator.report_title=Apache JMeter Dashboard

# Change this parameter if you want to change the granularity of over time graphs.
jmeter.reportgenerator.overall_granularity=60000
#jmeter.reportgenerator.overall_granularity=60000

Change this parameter if you want to change the granularity of Response time distribution
# Set to 500 ms by default
Expand Down Expand Up @@ -503,7 +512,7 @@
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 log file<a class="sectionlink" href="#report_only" title="Link to here">&para;</a></h2>
<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">&para;</a></h2>
<p>
Use the following command:
<pre class="source">jmeter -g &lt;log file&gt; -o &lt;Path to output folder&gt;</pre>
Expand All @@ -520,7 +529,7 @@

<div class="subsection"><h2 id="default_graphs">16.4 Default graphs<a class="sectionlink" href="#default_graphs" title="Link to here">&para;</a></h2>
<div class="clear"></div><div class="note">Due to limitations of this early version, each default graph
must be declared among the JMeter properties. Otherwise, the graph
must be declared in JMeter properties. Otherwise, the graph
views will be empty.</div><div class="clear"></div>

<p>
Expand Down

0 comments on commit 20a5563

Please sign in to comment.