[jmeter] branch master updated: Add a note to the dashboard docs about the new property

[fs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fschumacher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jmeter.git


The following commit(s) were added to refs/heads/master by this push:
     new ec1d462  Add a note to the dashboard docs about the new property
ec1d462 is described below

commit ec1d462f362a9475384db38c0bd75dfb766336d2
Author: Felix Schumacher <fe...@internetallee.de>
AuthorDate: Sat Jun 5 15:21:31 2021 +0200

    Add a note to the dashboard docs about the new property
    
    Part of Bugzilla Id: 65353
---
 xdocs/usermanual/generating-dashboard.xml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/xdocs/usermanual/generating-dashboard.xml b/xdocs/usermanual/generating-dashboard.xml
index 9a50b6b..912b925 100644
--- a/xdocs/usermanual/generating-dashboard.xml
+++ b/xdocs/usermanual/generating-dashboard.xml
@@ -241,6 +241,17 @@ jmeter.save.saveservice.timestamp_format = ms
                             <dd><source>${jmeter.reportgenerator.overall_granularity}</source></dd>
                         </dl>
                     </note>
+                    <note>
+                       <p>The calculated percentiles might differ from those from the Aggregate Report in the GUI.
+                       This is because the dashboard uses a different formula to estimate the percentiles.
+                       It will be most observable when the distribution of the timing values is spread
+                       too wide. That can happen if too few samples were taken. If you want the numbers
+                       to be more or less the same as those from the Aggregate Report, you will have to switch the used
+                       <a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6/org/apache/commons/math3/stat/descriptive/rank/Percentile.EstimationType.html">estimator</a>
+                       from <code>LEGACY</code> to <code>R_3</code>, by specifying the JMeter property
+                       <code>backend_metrics_percentile_estimator=R_3</code> (this time without any
+                       prefix).</p>
+                    </note>
                 </subsection>
 
                 <subsection name="&sect-num;.2.3 Graph settings" anchor="configure_graph">