如何为JMeter开发自定义后端监听器，将自定义变量等数据发送至InfluxDB

核心逻辑说明 #

你在user.properties中配置的sample_variables参数，JMeter会自动将对应变量的值绑定到每个采样的SampleResult对象中，开发自定义后端监听器时可以直接读取该对象的内置方法获取所有自定义变量，无需额外做变量采集逻辑。

具体开发步骤 #

• 第一步：创建Java项目，引入对应版本的JMeter核心依赖和InfluxDB客户端依赖，示例Maven依赖如下：

<!-- JMeter核心依赖 -->
<dependency>
    <groupId>org.apache.jmeter</groupId>
    <artifactId>ApacheJMeter_core</artifactId>
    <version>5.6</version>
    <scope>provided</scope>
</dependency>
<!-- InfluxDB客户端依赖，根据你使用的InfluxDB版本选择1.x或2.x版本 -->
<dependency>
    <groupId>com.influxdb</groupId>
    <artifactId>influxdb-client-java</artifactId>
    <version>6.10.0</version>
</dependency>

• 第二步：实现JMeter后端监听器标准接口org.apache.jmeter.visualizers.backend.BackendListenerClient，必须实现四个核心方法：setupTest（测试启动时初始化InfluxDB连接）、handleSampleResults（处理每批采样结果）、teardownTest（测试结束时关闭InfluxDB连接）、getDefaultParameters（定义监听器可配置参数）
• 第三步：在handleSampleResults方法中遍历所有采样结果，调用sampleResult.getSampleVariables()方法即可直接获取配置的所有自定义变量的键值对
• 第四步：将JMeter默认采样字段（响应时间、响应码、成功率、线程数等）和自定义变量组合为InfluxDB的Point结构，业务标识类变量可作为tag方便查询过滤，数值类变量作为field支持聚合计算
• 第五步：将项目打包为可执行jar包，放入JMeter安装目录下的lib/ext文件夹，重启JMeter后即可在后端监听器的客户端实现下拉菜单中找到自定义监听器，配置对应InfluxDB连接参数即可使用

核心代码示例 #

@Override
public void handleSampleResults(List<SampleResult> sampleResults, BackendListenerContext context) {
    List<Point> pointList = new ArrayList<>();
    for (SampleResult sampleResult : sampleResults) {
        // 获取所有配置的sample_variables变量
        Map<String, String> customVariables = sampleResult.getSampleVariables();
        // 构造InfluxDB数据点
        Point.Builder pointBuilder = Point.measurement("jmeter_metrics")
                .time(System.currentTimeMillis(), TimeUnit.MILLISECONDS)
                .addTag("sample_label", sampleResult.getSampleLabel())
                .addTag("response_code", sampleResult.getResponseCode())
                .addField("response_time", sampleResult.getTime())
                .addField("success", sampleResult.isSuccessful() ? 1 : 0)
                .addField("bytes", sampleResult.getBytesAsLong());
        // 遍历自定义变量写入数据点
        for (Map.Entry<String, String> varEntry : customVariables.entrySet()) {
            String varValue = varEntry.getValue();
            if (varValue != null && !varValue.trim().isEmpty()) {
                // 按需调整为tag或field
                pointBuilder.addTag(varEntry.getKey(), varValue);
                // 若为数值类型可转为对应类型作为field存储：
                // pointBuilder.addField(varEntry.getKey(), Long.parseLong(varValue));
            }
        }
        pointList.add(pointBuilder.build());
    }
    // 批量写入InfluxDB降低IO开销
    if (!pointList.isEmpty()) {
        influxDBClient.getWriteApiBlocking().writePoints(pointList);
    }
}

注意事项 #

• 自定义变量为空时需要做判空处理，避免写入InfluxDB时出现格式错误
• 建议采用批量写入策略，不要单条数据单独上报，降低InfluxDB写入压力
• 可在getDefaultParameters方法中预定义InfluxDB地址、org、bucket、token、批量写入阈值等配置项，无需修改代码即可在JMeter界面调整参数
• InfluxDB 1.x和2.x的客户端API差异较大，需要根据你使用的InfluxDB版本选择对应依赖和写入方法

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