oha (早上好)

oha 是一个小巧的程序，可以向 Web 应用程序施加一些负载并显示实时 TUI，灵感来自 rakyll/hey。

该程序由 Rust 编写，由 tokio 提供支持，并使用 ratatui 创建美观的 TUI。

安装

该程序基于稳定版 Rust 构建，通过 cargo 安装时需要同时安装 make 和 cmake 作为先决条件。

cargo install oha

你可以选择使用 native-tls 而不是 rustls 来构建 oha。

cargo install --no-default-features --features rustls oha

你可以通过启用 vsock 功能来支持 VSOCK。

cargo install --features vsock oha

在 Arch Linux 上

pacman -S oha

在 macOS 上（Homebrew）

brew install oha

在 Windows 上（winget）

winget install hatoo.oha

在 Debian 上（Azlux 的仓库）

echo "deb [signed-by=/usr/share/keyrings/azlux-archive-keyring.gpg] http://packages.azlux.fr/debian/ stable main" | sudo tee /etc/apt/sources.list.d/azlux.list
sudo wget -O /usr/share/keyrings/azlux-archive-keyring.gpg https://azlux.fr/repo.gpg
apt update
apt install oha

容器化

你也可以构建并创建一个包含 oha 的容器镜像

docker build . -t example.com/hatoo/oha:latest

然后你可以直接通过容器使用 oha

docker run -it example.com/hatoo/oha:latest https://example.com:3000

配置文件引导优化（PGO）

你可以使用以下命令通过 PGO 构建 oha：

bun run pgo.js

构建好的二进制文件将位于 target/[target-triple]/pgo/oha。

平台

Linux - 在 Ubuntu 18.04 gnome-terminal 上测试通过
Windows 10 - 在 Windows Powershell 上测试通过
MacOS - 在 iTerm2 上测试通过

使用方法

-q 选项的工作方式与 rakyll/hey 不同。它设置的是总体每秒查询次数，而不是每个工作线程的查询次数。

Ohayou(早上好)，HTTP 负载生成器，灵感来自 rakyll/hey，带有 TUI 动画。

用法：oha [标志] [选项] <url>

参数：
  <URL>  目标 URL。
选项：
  -n <N_REQUESTS>
          要运行的请求数量。[默认值：200]
  -c <N_CONNECTIONS>
          要同时运行的连接数。对于较大的 `-c` 值，您可能需要增加打开文件的限制。[默认值：50]
  -p <N_HTTP2_PARALLEL>
          在 HTTP/2 上发送的并行请求数。`oha` 将总共运行 c * p 个并发工作进程。[默认值：1]
  -z <DURATION>
          发送请求的应用程序持续时间。如果指定了持续时间，则忽略 n。
          在 HTTP/1 中，当达到持续时间时，正在进行的请求将被中止并计为"因截止时间而中止"。
          您可以使用 `-w` 选项更改此行为。
          目前，在 HTTP/2 中，当达到持续时间时，正在进行的请求将被等待。`-w` 选项被忽略。
          示例：-z 10s -z 3m。
  -w, --wait-ongoing-requests-after-deadline
          当达到持续时间时，等待正在进行的请求
  -q <QUERY_PER_SECOND>
          所有请求的速率限制，以每秒查询数（QPS）为单位
      --burst-delay <BURST_DURATION>
          在预定义数量的请求之间引入延迟。
          注意：如果指定了 qps，则忽略突发选项
      --burst-rate <BURST_REQUESTS>
          突发请求的速率。默认为 1
          注意：如果指定了 qps，则忽略突发选项
      --rand-regex-url
          使用 rand_regex crate 生成 URL，但每个查询的点被禁用，例如 http://127.0.0.1/[a-z][a-z][0-9]。目前动态方案、主机和端口与保持连接不能很好地工作。有关语法详细信息，请参阅 https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html。
      --max-repeat <MAX_REPEAT>
          '--rand-regex-url' 的参数。max_repeat 参数给出了 x*、x+ 和 x{n,} 运算符将变成的最大额外重复次数。[默认值：4]
      --dump-urls <DUMP_URLS>
          转储目标 URL <DUMP_URLS> 次以调试 --rand-regex-url
      --latency-correction
          纠正延迟以避免协调遗漏问题。如果未设置 -q，则忽略此选项。
      --no-tui
          无实时文本用户界面
  -j, --json
          以 JSON 格式打印结果
      --fps <FPS>
          文本用户界面的帧率。[默认值：16]
  -m, --method <METHOD>
          HTTP 方法 [默认值：GET]
  -H <HEADERS>
          自定义 HTTP 头。示例：-H "foo: bar"
  -t <TIMEOUT>
          每个请求的超时时间。默认为无限。
  -A <ACCEPT_HEADER>
          HTTP Accept 头。
  -d <BODY_STRING>
          HTTP 请求体。
  -D <BODY_PATH>
          从文件读取 HTTP 请求体。
  -T <CONTENT_TYPE>
          Content-Type。
  -a <BASIC_AUTH>
          基本认证，格式为 username:password
      --http-version <HTTP_VERSION>
          HTTP 版本。可用值：0.9、1.0、1.1。
      --http2
          使用 HTTP/2。--http-version=2 的简写
      --host <HOST>
          HTTP Host 头
      --disable-compression
          禁用压缩。
  -r, --redirect <REDIRECT>
          重定向次数限制。设置为 0 表示不重定向。HTTP/2 不支持重定向。[默认值：10]
      --disable-keepalive
          禁用保持连接，防止在不同的 HTTP 请求之间重用 TCP 连接。HTTP/2 不支持此选项。
      --no-pre-lookup
          在开始时*不*执行 DNS 查找以缓存它
      --ipv6
          仅查找 IPv6。
      --ipv4
          仅查找 IPv4。
      --insecure
          接受无效证书。
      --connect-to <CONNECT_TO>
          使用类似 'example.org:443:localhost:8443' 的字符串覆盖 DNS 解析和默认端口号
      --disable-color
          禁用配色方案。
      --unix-socket <UNIX_SOCKET>
          连接到 Unix 套接字而不是 URL 中的域名。仅适用于非 HTTPS URL。
      --stats-success-breakdown
          在时间直方图和分布统计中包含响应状态码成功或不成功的细分
      --db-url <DB_URL>
          将成功的请求写入 SQLite 数据库 URL，例如 test.db
  -h, --help
          打印帮助信息
  -V, --version
          打印版本信息

# JSON 输出

当设置 `-j` 选项时，`oha` 打印 JSON 输出。
JSON 输出的架构在 [schema.json](./schema.json) 中定义。

# 基准测试

## 性能比较

我们使用 `hyperfine` 在本地服务器上对 `oha` 和 `rakyll/hey` 进行基准测试。服务器使用 node 编码。您可以通过复制粘贴此文件并通过 node 运行它来启动服务器。复制粘贴文件后，您可以通过 `hyperfine` 运行基准测试。

1. 将内容复制粘贴到一个名为 app.js 的新 JavaScript 文件中

```js
const http = require("http");

const server = http.createServer((req, res) => {
  res.writeHead(200, { "Content-Type": "text/plain" });

  res.end("Hello World\n");
});

server.listen(3000, () => {
  console.log("Server running at http://localhost:3000/");
});

运行 node app.js
在不同的终端标签中运行 hyperfine 'oha --no-tui http://localhost:3000' 'hey http://localhost:3000'

基准测试结果

基准测试 1：oha --no-tui http://localhost:3000

时间（平均值 ± σ）：10.8 ms ± 1.8 ms [用户：5.7 ms，系统：11.7 ms]
范围（最小值 … 最大值）：8.7 ms … 24.8 ms（107 次运行）

基准测试 2：hey http://localhost:3000

时间（平均值 ± σ）：14.3 ms ± 4.6 ms [用户：12.2 ms，系统：19.4 ms]
范围（最小值 … 最大值）：11.1 ms … 48.3 ms（88 次运行）

总结

在此基准测试中，oha --no-tui http://localhost:3000 被发现更快，运行速度约为 hey http://localhost:3000 的 1.32 ± 0.48 倍。

技巧

在更真实的条件下进行压力测试

oha 使用从 rakyll/hey 继承的默认选项，但您可能需要更改选项以在更真实的条件下进行压力测试。

我建议使用以下选项运行 oha。

oha <-z 或 -n> -c <并发连接数> -q <每秒查询数> --latency-correction --disable-keepalive <目标地址>

--disable-keepalive

在现实中，用户不会使用 Keep-Alive 查询相同的 URL。您可能希望在不使用 Keep-Alive 的情况下运行。
--latency-correction

通过使用 --latency-correction，您可以避免 协调遗漏问题。

突发功能

您可以使用 --burst-delay 和 --burst-rate 选项在定义数量的请求之间引入延迟。

oha -n 10 --burst-delay 2s --burst-rate 4

在这种特定情况下，每 2 秒将处理 4 个请求，6 秒后将处理总共 10 个请求。 注意：如果不设置 --burst-rate 选项，数量默认为 1

动态 URL 功能

您可以使用 --rand-regex-url 选项为每个连接生成随机 URL。

oha --rand-regex-url http://127.0.0.1/[a-z][a-z][0-9]

每个URL都是由rand_regex包生成的，但正则表达式中的点号被禁用了，因为它对这个目的来说不太有用，而且如果URL中的点被解释为正则表达式的点，会非常不方便。

你可以选择设置--max-repeat选项来限制每个正则表达式的最大重复次数。例如，http://127.0.0.1/[a-z]*与`--max-repeat 4`一起使用会生成类似http://127.0.0.1/[a-z]{0,4}的URL。

目前，动态的协议、主机和端口与保持连接的功能还不能很好地工作。

贡献

欢迎您帮助我们！

这里有一些需要改进的问题。

编写测试
改进TUI设计
- 显示更多信息？
- 目前实时TUI中没有颜色。我希望有一些有色彩感的人能给予帮助。
提高速度
- 我是tokio的新手。我认为在查询调度方面还有一些优化空间。