JMeter性能测试3.0时代之-多维度的图形化HTML报告

在上一篇博客JMeter性能测试3.0时代之-全新JMeter插件管理中我说会写真正的JMeter 3.0新特性，时隔两周，总算在这个周末，暂停其他安排，来继续这个未完成的系列。
本文主要介绍JMeter3.0引入的新特性：Dashboard Report，图形化的HTML格式多维度测试报告。借助这个特性，可以很大程度上降低我们搭建基于JMeter的性能测试平台时，在结果展示上的难度，将更多的经历放在后端的平台功能而不是去临时学习前端图表库。

一.为什么谈这个新特性

在JMeter3.0之前，官方只提供在工具的UI上对测试结果部分维度的图形化展示，这对我带来了两方面的困扰：

1. 在实际使用中，在平台中集成JMeter后需要页面展示TPS曲线，平均响应时间曲线等图表时，需要我们手动操刀摆弄如Hightcharts/Echarts等前端图表库。
2. 要查看历史的测试结果，需要启动JMeter的图形化界面，导入保存的CSV结果，过程繁琐，并且当结果集较大时，JMeter需要耗费相当多的时间在界面上展示图形化报告。

本文讨论的新特性为这两个问题带来了较好的解决办法：

• 新特性良好的实现了结果数据可视化，生成的报告是HTML页面形式，并且包含大多数实际测试中关心的度量维度的，可以便捷地嵌入到平台，从浏览器来查看每次测试运行的。
• 只要保留生成的HTML页面，后期要查看该次测试的结果，只需要在浏览器打开即可，方便快捷。

二.新特性简介

JMeter3.0提供一个用于生成HTML页面格式图形化报告的扩展模块。该模块支持通过两种方式生成多维度图形化测试报告：

1. 在JMeter性能测试结束时，自动生成本次测试的HTML图形化报告
2. 使用一个已有的结果文件(如CSV文件)来生成该次结果的HTML图形化报告

其默认提供的度量维度包括：

1. APDEX(Application Performance Index)指数
2. 聚合报告

- 类似于UI上的*Aggregate Report*

3. Errors报告

- 展示不同错误类型的数量以及百分比

4. 响应时间变化曲线

- 展示平均响应时间随时间变化情况
- 类似于JMeter Plugins在UI上的*jp@gc - Response Times Over Time*

5. 数据吞吐量时间曲线

- 展示每秒数据吞吐量随时间变化的情况
- 类似于JMeter Plugins在UI上的*jp@gc - Bytes Throughput Over Time*

6. Latency time变化曲线

- 展示Latency time随时间变化的情况
- 类似于JMeter Plugins在UI上的*jp@gc - Response Latencies Over Time*

7. 每秒点击数曲线

- 类似于JMeter Plugins在UI上的*jp@gc - Hits per Second*

8. HTTP状态码时间分布曲线

- 展示响应状态码随时间的分布情况
- 类似于JMeter Plugins在UI上的*jp@gc - Response Codes per Second*

9. 事务吞吐量时间曲线(TPS)

- 展示每秒处理的事务数随时间变化情况
- 类似于JMeter Plugins在UI上的*jp@gc - Transactions per Second*

10. 平均响应时间与每秒请求数的关系图

- 展示平均响应时间与每秒请求数(可以理解为QPS)的关系

11. Latency time与每秒请求数的关系图

- 展示Latency time与每秒请求数的关系

12. 响应时间百分位图

- 响应时间的百分位分布图

13. 活动线程数变化曲线

- 展示测试过程中活动线程数随时间变化情况

14. 平均响应时间与线程数的关系图

- 展示平均响应时间与线程数的关系
- 类似于JMeter Plugins在UI上的*jp@gc - Response Times vs Threads*

15. 柱状响应时间分布图

- 展示落在各个平均响应时间区间的请求数情况

注1：Latency time没有翻译成中文，这里对其计算方式做注解：
- Latency time = 接收到响应的第一个字节的时间点 - 请求开始发送的时间点

from just before sending the request to just after the first response has been received
-- Apache JMeter Glossary

- 响应时间(JMeter术语中的Elapsed time) = 接收完所有响应内容的时间点 - 请求开始发送的时间点

from just before sending the request to just after the last response has been received
-- Apache JMeter Glossary

注2：Apdex 标准从用户的角度出发，将对应用响应时间的表现，转为用户对于应用性能的可量化为范围为 0-1 的满意度评价。。

Apdex (Application Performance Index) is an open standard developed by an alliance of companies. It defines a standard method for reporting and comparing the performance of software applications in computing.
-- wikipedia

三.快速入门

1.确认基本配置

• 在jmeter.properties或者user.properties确认如下配置项：

jmeter.save.saveservice.bytes = true
jmeter.save.saveservice.label = true
jmeter.save.saveservice.latency = true
jmeter.save.saveservice.response_code = true
jmeter.save.saveservice.response_message = true
jmeter.save.saveservice.successful = true
jmeter.save.saveservice.thread_counts = true
jmeter.save.saveservice.thread_name = true
jmeter.save.saveservice.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
# Or the following would also be suitable
jmeter.save.saveservice.timestamp_format = yyyy/MM/dd HH:mm:ss

• 如果希望在Errors报告中展示更详细数据，需要确保如下配置
  • jmeter.save.saveservice.assertion_results_failure_message = true
  • 如果使用了事务控制器(Transaction Controller)，确认Generate parent sample为未勾选状态

2.生成报告

a. 在压力测试结束时报告

• 基本命令格式：
  jmeter -n -t <test JMX file> -l <test log file> -e -o <Path to output folder>
• 样例：
  jmeter -n -t F:\PerformanceTest\TestCase\script\getToken.jmx -l testLogFile -e -o ./output

b. 使用已有的压力测试CSV日志文件生成报告

• 基本命令格式：
  jmeter -g <log file> -o <Path to output folder>
• 样例：
  jmeter -g D:\apache-jmeter-3.0\bin\testLogFile -o ./output

两个样例都会在\apache-jmeter-3.0\bin\output目录下产生如下文件(夹):

用浏览器打开index.html文件，即可查看各种图形化报告:

注1：在3.0版本，由于源码中字符编码的问题，可能会遇到生成的报告中，中文标签展示为乱码的问题，因篇幅限制，解决办法请戳这里看我另一篇文章。
2016-12 update ：在3.1版本中，该问题已修复

四.自定义配置

JMeter3.0在bin目录新增了reportgenerator.properties文件保存了所有关于图形化HTML报告生成模块的默认配置，要变更配置，建议不要直接编辑该文件，而是推荐在user.properties中去配置和覆盖。

1.总体配置

总体配置都是以jmeter.reportgenerator.为前缀，如：jmeter.reportgenerator.overall_granularity=60000

• overall_granularity：定义采样点粒度，默认为60000ms，通常在稳定性以外的测试中，我们可能需要定义更细的粒度，比如1000ms，我们可以在user.properties文件末尾添加如下配置：

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

• report_title:定义报告的标题，我们可能需要将标题定义为实际测试项名称
• apdex_satisfied_threshold：定义Apdex评估中满意的阈值(单位ms)
• apdex_tolerated_threshold: 定义Apdex评估中可容忍的阈值
  Apdext = (Satisfied Count + Tolerating Count / 2) / Total Samples

另外，在jmeter.properties中，有关于集合报告中的三个百分位的默认值：

aggregate_rpt_pct1 : Defaults to 90
aggregate_rpt_pct2 : Defaults to 95
aggregate_rpt_pct3 : Defaults to 99

可以在user.properties中对其进行覆盖，如：aggregate_rpt_pct1 = 70，效果如下：

2.图表配置

每个图表配置都是以jmeter.reportgenerator.graph.<图表名称>.为前缀。

• classname 图表的实现类，如果有自己定制的实现，将该配置的值写为自定义实现类的类名
• property.set_granularity 设置图标的采样点粒度，不配置时默认使用总体配置中的粒度设置

3.输出配置

输出配置都以jmeter.reportgenerator.exporter为前缀。

• property.output_dir 配置默认的报告输出路径。在命令行可以用-o选项来设置特定的路径覆盖该配置。
• html.series_filter 用于过滤展示内容。如在user.properties添加如下配置：
  jmeter.reportgenerator.exporter.html.series_filter=(^Login)(-success|-failure)?
  则最后的报告只展示名为Login这个取样器的数据。该配置包含两部分，(-success|-failure)?是Transactions per second图表所依赖的配置。前面部分接受一个正则表达式用来过滤。

4.报告定制

JMeter的HTML报告生成时是使用了固定的模板，模板文件路径为./bin/report-template。
进入该目录可以看到报告的每个页面都有一个.fmkr模板文件，包括index.html.fmkr和./content/pages路径下的几个文件。通过查看这些模板文件，就可以知道怎样去进行报告的轻度定制，比如将一些文本修改得更易懂，或者修改为中文等

• 页面的title
  • 默认为"Apache JMeter Dashboard"
  • 可以由reportgenerator.properties中的jmeter.reportgenerator.report_title来统一定义，这种方式就是所有页面的title都使用同一个。
  • 也可以直接修改对应的.fmkr文件中的title标签中双引号内的值，如<title>${reportTitle!"想要设置的title"}</title>，这中方式可以为每个页面单独定义title
• 图表的名称
  • 当前版本下，各图表的名称是直接在模板文件中定义，要修改也是直接修改模板文件中对应元素的值即可
  • 如要修改Transactions Per Second图表的名称，可以直接在./content/pages/Throughput.html.fmkr文件中修改，效果如下图
    自定义图表名称
• 页面的其他各元素也可以用相同的方法进行定制

五.总结

本次介绍的Dashboard Report特性本质上是Apache JMeter对于测试结果数据可视化方式的顺应时代的更新，虽然算是姗姗来迟，虽然并不酷炫，但至少，对于要需要基于它来执行性能测试的人来说，仍然是一个福音。最后，感谢Apache JMeter项目的各位贡献者对它的持续更新。

References

1. Apache JMeter Dashboard Report
2. Apache JMeter Glossary