@ably-labs/locust 中文文档教程

Question

ably-locust

Locust.io 的 JavaScript 负载生成器。

---

Ably 是支持实时同步数字体验的平台。 无论是在虚拟场所参加活动、接收实时财务信息，还是监控实时汽车性能数据——消费者只是希望将实时数字体验作为标准。 Ably 提供一套 API，每月为 80 个国家/地区的 2.5 亿多台设备实时构建、扩展和交付强大的数字体验。 Bloomberg、HubSpot、Verizon 和 Hopin 等组织依靠 Ably 的平台在全球范围内卸载日益复杂的关键业务实时数据同步。 有关详细信息，请参阅 Ably 文档。

---

Quick Start

请参阅example/users .ts 是在 TypeScript 中定义 Locust 用户的示例，example/index.ts 是连接到 Locust master 和在负载测试期间运行定义的用户。

可以通过将 example/.env.sample 复制到 example/.env，将 ABLY_API_KEY 设置为您的 Ably API 密钥，然后运行Docker Compose：

cd example

cp .env.sample .env

# ... edit ABLY_API_KEY in .env ...

docker compose up --build

访问位于 http://localhost:8089 的 Locust web UI，开始负载测试，您应该看到 < JavaScript 用户报告的 code>subscribe 和 publish 事件。

Locust

Locust 是一款开源负载测试工具，支持两种运行模式。 第一种是独立模式，其中有一个 Locust 进程生成负载、收集统计信息并为 Web UI 提供服务，第二种是分布式模式，其中有一个 Locust 主进程为 Web UI 提供服务，但也将 ZeroMQ 套接字暴露给与 Locust worker 进程通信，后者生成负载并将统计信息报告回 Locust master。 ably-locust 希望 Locust 以分布式模式运行。

Locust 有一个用户的概念，它在负载测试期间运行一组请求。 用户定期报告有关出现在 Web UI 中的那些任务的统计信息（例如，如果他们成功或失败，遇到什么延迟，内容大小等）。 Locust 用户通常在名为 locustfile.py 的文件中用 Python 代码定义，并作为命令行标志传递给 Locust，而使用 ably-locust 时，用户在 JavaScript 代码中定义>。

Usage

ably-locust 是 Locust 工作进程在 JavaScript 中的实现。 它可以通过运行来安装：

npm install @ably-labs/locust

ably-locust 不是像 Locust Python worker 那样通过命令行标志接受用户定义的程序，而是一个在包含程序中使用的库，该程序还包括用户定义。

Worker 类使用 Locust master ZeroMQ 套接字的 URI 实例化，并向 worker 注册一个函数以实例化 Locust master 配置的每个用户类（即 < code>locustfile.py 传递给继承自 Locust User 类的 Locust master，参见 此处）。 worker 然后通过 ZeroMQ 套接字发送和接收 msgpack 编码的消息与 Locust master 交互。

worker 收到的消息之一是 spawn 消息，它声明在任何给定时间每个类应该运行多少用户，并且 worker 通过适当地启动和/或停止用户来响应。

例如，假设有一个 Locust master 在 locust.example.com:5557 运行，它使用以下 locustfile.py：

from locust import User

class ExampleUser(User):
    pass

那么这里是一个示例程序，其中每个用户报告每秒一个成功的请求：

const { Worker } = require('@ably-labs/locust');

const worker = new Worker({
  locustUri: 'tcp://locust.example.com:5557',
  workerID:  'my-worker-123',
});

class User {
  start() {
    this.interval = setInterval(() => {
      const latency = 100;
      const contentLength = 1024;
      worker.stats.logRequest('my-request-type', latency, contentLength);
    }, 1000);
  }

  stop() {
    clearInterval(this.interval);
  }
}

worker.register('ExampleUser', () => new User());

worker.run();

Testing

启动一个 Locust 实例并运行测试：

cd tests

docker compose up --build

npm test