giltene/wrk2 性能测试工具中的Lua脚本开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00109/article/details/148527041

giltene/wrk2 性能测试工具中的Lua脚本开发指南

wrk2 A constant throughput, correct latency recording variant of wrk 项目地址: https://gitcode.com/gh_mirrors/wr/wrk2

前言

wrk2是一个高性能的HTTP基准测试工具，它通过LuaJIT脚本提供了强大的自定义能力。本文将深入解析wrk2中的脚本系统，帮助开发者充分利用这一特性来构建复杂的性能测试场景。

脚本执行阶段概述

wrk2的Lua脚本执行分为三个关键阶段：

Setup阶段：线程初始化时执行，用于线程级配置
Running阶段：实际测试运行时执行，处理每个请求周期
Done阶段：测试完成后执行，用于结果处理和分析

每个wrk2线程都有独立的脚本执行环境，确保测试的隔离性和准确性。

全局API详解

wrk2提供了丰富的Lua全局API，这些API是脚本开发的基础：

wrk全局表

wrk = {
    scheme  = "http",    -- 协议方案
    host    = "localhost", -- 目标主机
    port    = nil,       -- 目标端口
    method  = "GET",     -- HTTP方法
    path    = "/",       -- 请求路径
    headers = {},        -- HTTP头信息
    body    = nil,       -- 请求体
    thread  = <userdata> -- 线程用户数据
}

核心功能函数

wrk.format(method, path, headers, body)
- 功能：生成HTTP请求字符串
- 特点：自动合并wrk表中的默认值
- 使用场景：动态构建请求时特别有用
wrk.lookup(host, service)
- 功能：解析主机和服务对
- 返回值：包含所有已知地址的表
- 底层实现：对应POSIX的getaddrinfo()函数
wrk.connect(addr)
- 功能：测试地址连接性
- 参数：必须来自wrk.lookup()的返回结果
- 返回值：布尔值表示连接是否成功

阶段函数详解

Setup阶段函数

function setup(thread)

功能：在每个线程初始化时调用，用于线程级配置。

可用操作：

thread.addr：获取或设置线程的服务器地址
thread:get(name)：获取线程环境中的全局变量值
thread:set(name, value)：设置线程环境中的全局变量值
thread:stop()：停止线程（仅在线程运行时有效）

数据传输限制：仅支持布尔值、nil、数字、字符串及其表结构。

典型应用场景：

为不同线程分配不同的测试参数
实现动态负载均衡
自定义线程停止条件

Running阶段函数

初始化函数

function init(args)

接收脚本专属命令行参数（通过"--"分隔）
适合进行一次性初始化操作

请求生成函数

function request()

返回HTTP请求字符串
性能优化建议：在init()中预生成请求，在此函数中快速查找

响应处理函数

function response(status, headers, body)

解析响应头和数据可能影响性能
若不需要处理响应，可在init()后将response设为nil

性能优化技巧：

避免在request()中动态构建请求
合理使用响应处理，不需要时禁用

Done阶段函数

function done(summary, latency, requests)

参数说明：

summary表：

{
    duration = N,  -- 测试持续时间(微秒)
    requests = N,  -- 完成的总请求数
    bytes    = N,  -- 接收的总字节数
    errors   = {
        connect = N, -- 连接错误数
        read    = N, -- 读取错误数
        write   = N, -- 写入错误数
        status  = N, -- HTTP状态码>399的数量
        timeout = N  -- 请求超时数
    }
}