JMeter supports dashboard report generation to get graphs and
statistics from a test plan.
This chapter describes how to configure and use the generator.
14.1 Overview
|
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.
It can generate the report at end of a load test or on demand.
This report provides the following metrics:
- APDEX (Application Performance Index) table that computes for every transaction the APDEX based on configurable values for tolerated and satisfied thresholds
- A request summary graph showing the Success and failed requests (Transaction Controller Sample Results are not taken into account) percentage:
- A Statistics table providing in one table a summary of all metrics per transaction including 3 configurable percentiles:
- An error table providing a summary of all errors and their proportion in the total requests:
- A Top 5 Errors by Sampler table providing for every Sampler (excluding Transaction Controller by default) the top 5 Errors:
- Zoomable chart where you can check/uncheck every transaction to show/hide it for:
- Response times Over Time (Includes Transaction Controller Sample Results):
- Response times Percentiles Over Time (successful responses only):
- Active Threads Over Time:
- Bytes throughput Over Time (Ignores Transaction Controller Sample Results):
- Latencies Over Time (Includes Transaction Controller Sample Results):
- Connect Time Over Time (Includes Transaction Controller Sample Results):
- Hits per second (Ignores Transaction Controller Sample Results):
- Response codes per second (Ignores Transaction Controller Sample Results):
- Transactions per second (Includes Transaction Controller Sample Results):
- Response Time vs Request per second (Ignores Transaction Controller Sample Results):
- Latency vs Request per second (Ignores Transaction Controller Sample Results):
- Response time Overview (Excludes Transaction Controller Sample Results):
- Response times percentiles (Includes Transaction Controller Sample Results):
- Times vs Threads (Includes Transaction Controller Sample Results):
In distributed mode, this graph shows a horizontal axis the number of threads for 1 server. It's a current limitation |
- Response Time Distribution (Includes Transaction Controller Sample Results):
|
|
14.2 Configuring Dashboard Generation
|
Dashboard generation uses JMeter properties to customize the
report. Some properties are used for general settings and others are
used for a particular graph configuration or exporter configuration.
All report generator properties can be found in file reportgenerator.properties.
To customize these properties, you should copy them in user.properties file and modify them. |
14.2.2 General settings
|
All properties must be prefixed with
|
Parameters
Percentiles used by Summary table and Percentile graphs can be adjusted to different values by using the 3 properties:
- aggregate_rpt_pct1: Defaults to 90
- aggregate_rpt_pct2: Defaults to 95
- aggregate_rpt_pct3: Defaults to 99
|
Relative paths are built from the JMeter working directory
(default: bin). |
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
estimator
from LEGACY to R_3, by specifying the JMeter property
backend_metrics_percentile_estimator=R_3 (this time without any
prefix).
|
|
|
14.2.4 Export settings
|
Each property describing an exporter configuration must be
prefixed with
 |
 |
 |
 |
jmeter.reportgenerator.exporter |
 |
 |
 |
 |
followed by the exporter identifier.
14.2.4.1 General properties
|
All exporters support these properties:
Parameters
Attribute | Description | Required |
classname |
The fully qualified class name of the exporter
The class of the exporter must implement
org.apache.jmeter.report.dashboard.DataExporter
.
|
Yes
|
filters_only_sample_series |
Defines whether series_filter (see below)
apply only on sample series.
Default: true |
No
|
series_filter |
Sets the filter
of series. An empty value deactivates the filtering.
If not empty, regex should end with (-success|-failure)?$
Format: regular expression.
Default: ""
|
No
|
show_controllers_only |
Defines whether only controller series are shown.
Default: false
|
No
|
|
|
14.2.4.4 Filtering mechanisms
|
Unlike the filtering in the section
General properties
which discards data before calculations, here the
filtering is performed after the calculations and serves
to simplify the final report.
The property series_filter
allows to filter which series of a graph (resp. rows of
a summary table) using regular expression that matches
the name of the series (resp. of the row).
However, even if the name of the
series (resp. row) matches the filter, the setting
of the other filtering properties can lead to its
discarding. Conversely if there is no matching, the
other properties can allow to keep it.
The following tables show how the setting of filtering
properties works.
Incorrect filter configuration can lead to generate empty
graphs/summary tables:
-
If you set the property
show_controllers_only
and the graph is configured to exclude
controllers.
-
If the property
series_filter
matches none series.
|
|
|
|
|
|
|
14.3 Generating reports
|
The report generation can be done as a stand alone process from a
sample log file or automatically after running load test.
|
|
14.3.3 Generation using GUI Tools menu
|
You can generate the HTML report using menu item Tools → Generate HTML report:

Figure 14.1. HTML Report Dialog Menu |
For each parameters see the following table :
Parameters
Attribute | Description | Required |
Results file (csv or jtl) |
The CSV output of a tes run |
Yes
|
user.properties file |
The user.properties file used to run the load test |
Yes
|
Output directory |
The directory where you want the report to be created(must be empty) |
No
|
If no output directory is defined, the controller will use ${JMETER_HOME}/bin/report-output. You then only have to click on the Generate report button and wait for an information dialog to appear
If report generation takes more than two minutes, adjust the property generate_report_ui.generation_timeout |
|
|
14.4 Default graphs
|
Due to limitations of this early version, each default graph
must be declared in JMeter properties. Otherwise, the graph
views will be empty. |
All graphs provided by this report engine are located in the
package
org.apache.jmeter.report.processor.graph.impl
The dashboard generator provides the following graph classes:
|
|
|