JMeter CLI模式下如何在报告日志中添加ResponseBody列？

问题背景 #

需要在CLI模式生成的JMeter报告日志中添加responseBody列，现有列无此项，期望列顺序为：timeStamp,elapsed,label,responseCode,responseMessage,responseBody,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect。之前尝试的JSR223 PostProcessor存线程变量、BeanShell Sampler修改响应数据的方法均无效。

解决步骤 #

1. 用JSR223 PostProcessor将ResponseBody绑定到采样结果 #

在需要记录响应体的每个Sampler下添加JSR223 PostProcessor，使用以下Groovy代码：

// 获取当前采样的响应体字符串
def responseBody = prev.getResponseDataAsString()
// 将ResponseBody添加为采样结果的自定义字段
prev.addCustomField("responseBody", responseBody)

说明：prev代表当前采样的结果对象，addCustomField会将响应体作为自定义字段存入采样结果，让后续报告能识别到该数据。

2. 配置JMeter报告列（CLI模式生效） #

需要通过配置指定报告包含responseBody列并调整顺序，有两种方式：

方式一：修改user.properties文件

找到JMeter安装目录下的user.properties文件，添加以下配置：

# 指定报告要包含的列（含自定义responseBody）
jmeter.reportgenerator.exporter.html.column_names=timeStamp,elapsed,label,responseCode,responseMessage,responseBody,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect

# 指定列的显示顺序
jmeter.reportgenerator.exporter.html.column_order=timeStamp,elapsed,label,responseCode,responseMessage,responseBody,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect

# 确保响应数据被存入JTL文件
jmeter.save.saveservice.response_data=true

方式二：CLI命令行直接传递参数

在执行JMeter测试时，通过-J参数直接指定配置，示例命令：

jmeter -n -t testplan.jmx -l result.jtl -e -o report \
-Jjmeter.reportgenerator.exporter.html.column_names=timeStamp,elapsed,label,responseCode,responseMessage,responseBody,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect \
-Jjmeter.reportgenerator.exporter.html.column_order=timeStamp,elapsed,label,responseCode,responseMessage,responseBody,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect \
-Jjmeter.save.saveservice.response_data=true

之前方法无效的原因 #

• JSR223存线程变量：vars.put将响应体存入线程局部变量，但JMeter报告只会读取采样结果本身的字段，不会自动识别线程变量。
• BeanShell代码错误：SampleResult.setResponseData是实例方法，不能直接通过类调用，且仅修改响应数据未配置报告列，无法让报告显示该字段。

注意事项 #

• 若响应体体积过大，会导致JTL文件和报告体积剧增，可按需设置仅记录错误请求的响应体：将jmeter.save.saveservice.response_data.on_error设为true。
• CLI模式下必须确保jmeter.save.saveservice.response_data=true，否则JTL文件不会存储响应体数据，报告仍无法显示。

内容的提问来源于stack exchange，提问作者Javier Rodriguez