loadtest项目中的statusCallback参数详解

loadtest项目中的statusCallback参数详解

什么是statusCallback

在性能测试工具loadtest中，statusCallback是一个非常重要的回调函数参数。它允许开发者在每次请求完成后获取详细的请求结果信息，为性能监控和问题诊断提供了强大的支持。

statusCallback的基本用法

statusCallback函数遵循Node.js标准的错误优先回调模式，其基本签名如下：

function statusCallback(error, result) {
    // 处理逻辑
}

• error：仅在请求失败时存在
• result：总是包含请求的详细信息

版本变更注意事项

使用statusCallback时需要注意版本兼容性问题：

1. 7.0+版本移除了第三个latency参数，这是出于性能考虑
2. 2.0.0版本对参数顺序进行了调整，从原来的(latency, result, error)改为现在的(error, result)格式

result对象详解

result参数包含了丰富的请求信息，对于性能分析非常有价值：

| 属性 | 类型 | 说明 | |------|------|------| | host | string | 请求发送的目标主机 | | path | string | 请求的URL路径 | | method | string | 使用的HTTP方法 | | statusCode | number | HTTP状态码 | | body | string | 服务器返回的内容 | | headers | object | 服务器返回的头部信息 | | requestElapsed | number | 请求耗时(毫秒) | | requestIndex | number | 当前请求的序号(从0开始) | | instanceIndex | number | loadtest实例的索引 |

实际应用示例

基础使用

import {loadTest} from 'loadtest'

function statusCallback(error, result) {
    if (error) {
        console.error('请求出错:', error)
        return
    }
    
    console.log('请求详情:')
    console.log('URL:', result.host + result.path)
    console.log('状态码:', result.statusCode)
    console.log('耗时:', result.requestElapsed + 'ms')
    console.log('请求序号:', result.requestIndex)
}

const options = {
    url: 'http://api.example.com',
    concurrency: 10,
    maxRequests: 100,
    statusCallback: statusCallback
}

loadTest(options, function(error) {
    if (error) {
        return console.error('测试出错:', error)
    }
    console.log('性能测试完成')
})

高级用法：添加自定义标签

在某些场景下，我们可能需要在回调中识别特定的请求。这时可以通过requestGenerator添加自定义标签：

const options = {
    url: 'http://api.example.com/data',
    method: 'POST',
    requestGenerator: (params, options, client, callback) => {
        const requestData = {
            userId: Math.floor(Math.random() * 1000),
            timestamp: Date.now()
        };
        
        const request = client(options, callback);
        request.labels = requestData;  // 添加自定义标签
        request.write(JSON.stringify(requestData));
        return request;
    }
};

function statusCallback(error, result) {
    if (result.labels) {
        console.log('关联数据:', result.labels)
        console.log('用户ID:', result.labels.userId)
        console.log('请求时间:', new Date(result.labels.timestamp))
    }
    // 其他处理逻辑...
}

最佳实践建议

1. 错误处理：始终检查error参数，及时捕获和处理异常情况
2. 性能考虑：回调函数中避免执行耗时操作，以免影响测试本身的性能
3. 数据聚合：考虑在回调中收集关键指标，测试结束后进行统计分析
4. 日志分级：根据实际需求决定日志详细程度，高并发测试时避免过多日志输出

常见应用场景

1. 实时监控：在长时间运行的性能测试中实时显示关键指标
2. 异常检测：及时发现并记录失败的请求
3. 数据关联：将请求与业务数据关联分析
4. 自定义指标计算：基于原始数据计算更复杂的性能指标

通过合理使用statusCallback，开发者可以获取性能测试的详细数据，为系统优化提供有力依据。