Dubbo 压测插件 2.0 —— 基于普通 API 调用

插件已开源，详见 gatling-dubbo：https://github.com/youzan/gatling-dubbo.git

上一篇《Dubbo压测插件的实现——基于Gatling》中，我们介绍了基于 dubbo 泛化调用实现的 gatling dubbo 压测插件，使用泛化调用发起 dubbo 压测请求，consumer 端不需要拿到 provider 端的 API 包，使用上很便利，但是众所周知，dubbo 泛化调用的性能不如普通 API 调用，虽然可以优化并使之达到与普通 API 调用相近的性能，但仍存在一些局限性。生产中除了网关等特殊应用外，一般很少使用泛化调用，如果以泛化调用的性能来表征生产中普通 API 调用的性能，其压测结论很难令人信服。做压测的时候，一般要求各种条件如环境等都尽可能保持一致。所以，我们又开发了基于普通 API 调用的 gatling dubbo 压测插件，即 gatling-dubbo2.0。此外，依托于 gatling 强大的基础能力， gatling-dubbo2.0 相比于 Jmeter 还存在以下几方面的优势：

更强的场景编排能力，支持多场景同时编排，如仿真电商业务中同时存在普通下单、团购、秒杀等多种交易类型的场景
支持设置场景内流量模型，如漏斗模型，仿真用户从商品浏览 -> 加入购物车 -> 下单 -> 支付过程中的各级转化率
不需要安装额外插件，原生支持设置压力模型，如设置压测需要达到的目标 RPS，甚至逐级加压进行梯度压力测试
更低的资源消耗，更高的并发能力

一、插件主要组成

Action 和 ActionBuild
执行部分，这里的作用是发起 dubbo 请求，校验请求结果并记录日志以便后续生成压测报告。ActionBuild 则为 DSL 使用 Action 的辅助类

Check 和 CheckBuild
校验部分，全链路压测中我们使用 json path 校验 HTTP 请求结果，这里我们实现了一样的校验方法，而且，对于一些不规范的返回结果（如返回了基本数据类型），还增加了自定义校验方法。CheckBuild 则为 DSL 使用 Check 的辅助类。

DSL
插件的领域特定语言，提供简单易用的 API 方便编写 dubbo 压测脚本。

1.1 Action

dubboAction 包含了发起 dubbo 请求、请求结果校验以及压力控制逻辑，需要扩展 gatling 的 ExitableAction 并实现 execute 方法。

dubboAction 的入参 f 是一个函数，从压测脚本传入，函数负责组织 dubbo 请求，从 session 中取值并动态构造请求参数。这一过程类似于使用 Jmeter 压测 Java 接口，即扩展 AbstractJavaSamplerClient。所以，gatling-dubbo 2.0 也支持非 dubbo 的其他 java 调用压测，因为 f 怎么写的控制权完全掌握在写压测脚本的人手里（本质上，远程调用和本地调用的客户端使用方式上并没有区别）。

所有虚拟用户以并发方式执行 execute 方法，每个用户又以异步方式执行 dubbo 请求，且无论请求是否正确返回，都需要记录相应的成功或失败日志，失败可能是由于请求失败了，也可能是请求成功了，但是校验请求结果失败了。下一步就是准备发起新的 dubbo 请求，如果开启了 Rps 阀门（throttled），则会根据当前的 Rps 和 Rps 阀门阈值动态调整发送请求的频率，在施压机（consumer）未达到性能瓶颈的情况下，可以很稳定的保持在设置的 Rps 目标值上进行压测。如果 Rps 阀门未开启，则直接发起新的 dubbo 请求（通过 AKKA Message 触发）。

class dubboAction[A]( requestName: Expression[String],
f: (Session) => A,
val executor: ExecutorService,
val objectMapper: ObjectMapper,
checks: List[dubboCheck],
coreComponents: CoreComponents,
throttled: Boolean,
val next: Action
) extends ExitableAction with NameGen {
......
override def execute(session: Session): Unit = recover(session) {
requestName(session) map { reqName =>
val startTime = System.currentTimeMillis()
val fu = Future {
try {
f(session)
} finally {
}
}
fu.onComplete {
case Success(result) =>
val endTime = System.currentTimeMillis()
val resultJson = objectMapper.writeValueAsstring(result)
val (newSession, error) = Check.check(resultJson, session, checks)
error match {
case None =>
statsEngine.logResponse(session, reqName, ResponseTimings(startTime, endTime), Status("OK"), None, None)
throttle(newSession(session))
case Some(Failure(errorMessage)) =>
statsEngine.logResponse(session, reqName, ResponseTimings(startTime, endTime), Status("KO"), None, Some(errorMessage))
throttle(newSession(session).markAsFailed)
}
case UFailure(e) =>
val endTime = System.currentTimeMillis()
statsEngine.logResponse(session, reqName, ResponseTimings(startTime, endTime), Status("KO"), None, Some(e.getMessage))
throttle(session.markAsFailed)
}
}
}
private def throttle(s: Session): Unit = {
if (throttled) {
coreComponents.throttler.throttle(s.scenario, () => next ! s)
} else {
next ! s
}
}
}

dubboActionBuilder 负责创建线程池并实例化 dubboAction：

case class dubboActionBuilder[A](requestName: Expression[String], f: (Session) => A, checks: List[dubboCheck], threadPoolSize: Int) extends ActionBuilder {  override def build(ctx: ScenarioContext, next: Action): Action = {    import ctx._    val executor = Executors.newFixedThreadPool(threadPoolSize)    val objectMapper: ObjectMapper = new ObjectMapper()    new dubboAction[A](requestName, f, executor, objectMapper, checks, coreComponents, throttled, next)  }}

LambdaProcessBuilder 提供了设置 check 条件的 DSL 和设置线程池大小的 DSL：

有赞的施压机是 4 核 8Gb 内存的，我们为其设置的默认线程池大小为 200，与 dubbo 应用部署环境一致。你可以使用 DSL threadPoolSize(threadPoolSize: Int) 按照你的机器配置设置一个合适的线程池大小。如果施压机成了性能瓶颈，你可以考虑将其改造成集群来施压，具体可参考《有赞全链路压测引擎的设计与实现》

case class dubboProcessBuilder[A](requestName: Expression[String], f: (Session) => A, checks: List[dubboCheck] = Nil, threadPoolSize: Int = 200) extends dubboCheckSupport {
def check(dubboChecks: dubboCheck*): dubboProcessBuilder[A] = copy[A](checks = checks ::: dubboChecks.toList)
def threadPoolSize(threadPoolSize: Int): dubboProcessBuilder[A] = copy[A](threadPoolSize = threadPoolSize)
def build(): ActionBuilder = dubboActionBuilder[A](requestName, f, checks, threadPoolSize)
}

1.2 Check

全链路压测中，我们使用 json path 校验 HTTP 请求结果，dubbo 压测插件中，我们也实现了基于 json path 的校验方法：

package object dubbo {
type dubboCheck = Check[String]
val dubboStringExtender: Extender[dubboCheck, String] =
(check: dubboCheck) => check
val dubboStringPreparer: Preparer[String, String] =
(result: String) => Success(result)
}

trait dubboJsonPathOfType {
self: dubboJsonPathCheckBuilder[String] =>
def ofType[X: JsonFilter](implicit extractorFactory: JsonPathExtractorFactory) = new dubboJsonPathCheckBuilder[X](path, jsonParsers)
}
object dubboJsonPathCheckBuilder {
val CharsParsingThreshold = 200 * 1000
def preparer(jsonParsers: JsonParsers): Preparer[String, Any] =
response => {
if (response.length() > CharsParsingThreshold || jsonParsers.preferJackson)
jsonParsers.safeParseJackson(response)
else
jsonParsers.safeParseBoon(response)
}
def jsonPath(path: Expression[String])(implicit extractorFactory: JsonPathExtractorFactory, jsonParsers: JsonParsers) =
new dubboJsonPathCheckBuilder[String](path, jsonParsers) with dubboJsonPathOfType
}
class dubboJsonPathCheckBuilder[X: JsonFilter](
private[check] val path: Expression[String],
private[check] val jsonParsers: JsonParsers
)(implicit extractorFactory: JsonPathExtractorFactory)
extends DefaultMultipleFindCheckBuilder[dubboCheck, String, Any, X](
dubboStringExtender,
dubboJsonPathCheckBuilder.preparer(jsonParsers)
) {
import extractorFactory._
def findExtractor(occurrence: Int) = path.map(newSingleExtractor[X](_, occurrence))
def findAllExtractor = path.map(newMultipleExtractor[X])
def countExtractor = path.map(newCountExtractor)
}

但有时候存在一些不规范的情况，dubbo 接口的返回结果并不能直接转化为 json，如返回了基本数据类型，所以我们还提供了自定义校验方法，可以将这样的返回结果转化为 String 类型，并使用字符串比较、正则表达式匹配等方法校验返回结果：

case class dubboCustomCheck(func: String => Boolean, failureMessage: String = "dubbo check Failed") extends dubboCheck {  override def check(response: String, session: Session)(implicit cache: mutable.Map[Any, Any]): Validation[CheckResult] = {    func(response) match {      case true => CheckResult.NoopCheckResultSuccess      case _    => Failure(failureMessage)    }  }}

dubboCheckSupport 则提供了 json path、 custom 两种检验方式的 DSL

trait dubboCheckSupport {
def jsonPath(path: Expression[String])(implicit extractorFactory: JsonPathExtractorFactory, jsonParsers: JsonParsers) =
dubboJsonPathCheckBuilder.jsonPath(path)
def custom = dubboCustomCheck
}

dubbo 压测脚本中可以设置一个或多个 check 来校验请求结果

1.3 DSL

dubboDsl 提供顶层 DSL，隐式方法 dubboProcessBuilder2ActionBuilderScala 用于自动从 dubboProcessBuilder 构造 ActionBuilder

trait dubboDsl extends dubboCheckSupport {
def dubbo[A](requestName: Expression[String], f: (Session) => A) = dubboProcessBuilder[A](requestName, f)
implicit def dubboProcessBuilder2ActionBuilder[A](builder: dubboProcessBuilder[A]): ActionBuilder = builder.build()
}

二、示例

2.1 压测脚本示例

class Mix extends Simulation {
val application = new ApplicationConfig()
application.setName("gatling-dubbo")
// 初始化 AService
val referenceAService = new ReferenceConfig[AService]
referenceAService.setApplication(application)
referenceAService.setUrl("dubbo://IP:PORT/com.xxx.service.AService")
referenceAService.setInterface(classOf[AService])
val aService = referenceAService.get()
// 初始化 BService
val referenceBService = new ReferenceConfig[BService]
referenceBService.setApplication(application)
referenceBService.setUrl("dubbo://IP:PORT/com.yyy.service.BService")
referenceBService.setInterface(classOf[BService])
val bService = referenceBService.get()
// 设置数据源
val jsonFileFeeder = jsonFile("data.json").shuffle.circular
val mixScenario = scenario("scenario of mix")
.forever("tripsCount") {
Feed(jsonFileFeeder)
.randomSwitch(11d -> exec(
dubbo("com.xxx.service.AService.aMethod", fAMethod)
.check(jsonPath("$.success").is("true"))
)
)
.randomSwitch(4d -> exec(
dubbo("com.yyy.service.BService.bMethod", fBMethod)
.check(jsonPath("$.success").is("true"))
)
)
.randomSwitch(5d -> exec(
......
)
......
)
}
setUp(mixScenario.inject(constantUsersPerSec(100) during (10 seconds)).throttle(reachRps(1000) in (1 seconds), holdFor(120 seconds)))
// 设置 aMethod 的请求参数并调用
def fAMethod(session: Session): Object = {
val aParam = new Aparam()
aParam.setName("A Name");
// 从 session 中获取动态参数并设置
aParam.setAId(session.attributes("aId").asInstanceOf[Integer].toLong);
aService.aMethod(aParam);
}
// 设置 bMethod 的请求参数并调用
def fBMethod(session: Session): Object = {
val bParam = new Bparam()
bParam.setAge(26)
// 从 session 中获取动态参数并设置
bParam.setBId(session.attributes("bId").asInstanceOf[Integer].toLong)
bService.bMethod(bParam);
}
def fXxx(session: Session): Object = {
......
}
}

randomSwitch 的作用：
以上示例其实是 gatling-dubbo 在有赞的一个典型使用场景，即评估一个应用的单实例性能。按生产环境真实的接口调用比例请求各个接口（该比例由场景执行各个请求的概率分布模拟），这样的压测结果就可以真实反映生产环境应用的单实例性能，并为容量报警、生产扩容等提供参考依据。

2.2 压测数据示例

[  {    "aId": 160,    "bId": 859296  },  {    "aId": 160,    "bId": 1019040  },  {    "aId": 160,    "bId": 1221792  },  ......]

压测数据使用 Json 数组保存，其中每一个 Json 对象都包含了一次压测请求所需的所有动态参数，且为了方便通过 session 设置动态参数，Json 对象中不再嵌套其他 Json 对象。

2.3 压测报告示例

1、应用基线性能评估，用于精准扩容：

2、中心化限流效果验证：