跳到主要内容
跳到主要内容

clickhouse-benchmark

连接到一个 ClickHouse 服务器并重复发送指定的查询。

语法

$ clickhouse-benchmark --query ["single query"] [keys]

或

$ echo "single query" | clickhouse-benchmark [keys]

或

$ clickhouse-benchmark [keys] <<< "single query"

如果您想发送一组查询，请创建一个文本文件，并将每个查询放在此文件的单独字符串中。例如：

SELECT * FROM system.numbers LIMIT 10000000;
SELECT 1;

然后将此文件传递给 clickhouse-benchmark 的标准输入：

clickhouse-benchmark [keys] < queries_file;

命令行选项​

  • --query=QUERY — 要执行的查询。如果未传递此参数，clickhouse-benchmark 将从标准输入读取查询。
  • --query_id=ID — 查询 ID。
  • --query_id_prefix=ID_PREFIX — 查询 ID 前缀。
  • -c N, --concurrency=N — clickhouse-benchmark 同时发送的查询数量。默认值：1。
  • -C N, --max_concurrency=N — 逐渐增加并发查询的数量直到指定值，为每个并发级别生成一个报告。
  • --precise — 启用具有加权指标的精确每隔报告。
  • -d N, --delay=N — 中间报告之间的间隔（以秒为单位）（要禁用报告请设置为 0）。默认值：1。
  • -h HOST, --host=HOST — 服务器主机。默认值：localhost。对于 比较模式，您可以使用多个 -h 键。
  • -i N, --iterations=N — 查询的总数。默认值：0（无限重复）。
  • -r, --randomize — 如果有多个输入查询，则随机顺序执行查询。
  • -s, --secure — 使用 TLS 连接。
  • -t N, --timelimit=N — 时间限制（以秒为单位）。当达到指定的时间限制时，clickhouse-benchmark 停止发送查询。默认值：0（禁用时间限制）。
  • --port=N — 服务器端口。默认值：9000。对于 比较模式，您可以使用多个 --port 键。
  • --confidence=N — T 检验的置信水平。可能的值：0（80%），1（90%），2（95%），3（98%），4（99%），5（99.5%）。默认值：5。在 比较模式 中，clickhouse-benchmark 执行 独立双样本 Student t 检验 以确定在所选置信水平下两个分布是否不同。
  • --cumulative — 打印累计数据而不是每个间隔的数据。
  • --database=DATABASE_NAME — ClickHouse 数据库名称。默认值：default。
  • --user=USERNAME — ClickHouse 用户名。默认值：default。
  • --password=PSWD — ClickHouse 用户密码。默认值：空字符串。
  • --stacktrace — 堆栈跟踪输出。当设置此键时，clickhouse-benchamrk 输出异常的堆栈跟踪。
  • --stage=WORD — 服务器上的查询处理阶段。ClickHouse 停止查询处理并在指定阶段返回答案给 clickhouse-benchmark。可能的值：complete，fetch_columns，with_mergeable_state。默认值：complete。
  • --roundrobin — 而不是比较不同的 --host/--port 的查询，只为每个查询随机选择一个 --host/--port 并将查询发送到它。
  • --reconnect=N - 控制重连行为。可能的值 0（从不重连），1（每个查询重连），或 N（每 N 次查询后重连）。默认值：0。
  • --max-consecutive-errors=N — 允许的连续错误数量。默认值：0。
  • --ignore-error,--continue_on_errors — 即使查询失败也继续测试。
  • --client-side-time — 显示包括网络通信的时间，而不是服务器端时间；请注意，对于 22.8 之前的服务器版本，我们始终显示客户端时间。
  • --help — 显示帮助消息。
  • --verbose — 增加帮助消息的详细程度。

如果您想要为查询应用一些 设置，请将其作为键 --<session setting name>= SETTING_VALUE 传递。例如，--max_memory_usage=1048576。

环境变量选项​

用户名、密码和主机可以通过环境变量 CLICKHOUSE_USER、CLICKHOUSE_PASSWORD 和 CLICKHOUSE_HOST 设置。
命令行参数 --user、--password 或 --host 优先于环境变量。

输出​

默认情况下，clickhouse-benchmark 会在每个 --delay 间隔报告。

报告示例：

Queries executed: 10.

localhost:9000, queries 10, QPS: 6.772, RPS: 67904487.440, MiB/s: 518.070, result RPS: 67721584.984, result MiB/s: 516.675.

0.000%      0.145 sec.
10.000%     0.146 sec.
20.000%     0.146 sec.
30.000%     0.146 sec.
40.000%     0.147 sec.
50.000%     0.148 sec.
60.000%     0.148 sec.
70.000%     0.148 sec.
80.000%     0.149 sec.
90.000%     0.150 sec.
95.000%     0.150 sec.
99.000%     0.150 sec.
99.900%     0.150 sec.
99.990%     0.150 sec.

在报告中，您可以找到：

  • 查询执行数量: 字段中的查询数量。

  • 状态字符串包含（按顺序）：

    • ClickHouse 服务器的端点。
    • 处理的查询数量。
    • QPS: 在 --delay 参数指定的期间内，服务器每秒执行多少查询。
    • RPS: 在 --delay 参数指定的期间内，服务器每秒读取多少行。
    • MiB/s: 在 --delay 参数指定的期间内，服务器每秒读取多少 MiB。
    • 结果 RPS: 在 --delay 参数指定的期间内，服务器每秒放置到查询结果中的行数。
    • 结果 MiB/s. 在 --delay 参数指定的期间内，服务器每秒放置到查询结果中的 MiB 数量。

  • 查询执行时间的百分位数。

比较模式​

clickhouse-benchmark 可以比较两个运行中的 ClickHouse 服务器的性能。

要使用比较模式，通过两个 --host、--port 键指定两个服务器的端点。键在参数列表中的位置对应，第一个 --host 与第一个 --port 匹配，依此类推。 clickhouse-benchmark 建立到两个服务器的连接，然后发送查询。每个查询均指向一个随机选择的服务器。结果以表格形式显示。

示例​

$ echo "SELECT * FROM system.numbers LIMIT 10000000 OFFSET 10000000" | clickhouse-benchmark --host=localhost --port=9001 --host=localhost --port=9000 -i 10

Loaded 1 queries.

Queries executed: 5.

localhost:9001, queries 2, QPS: 3.764, RPS: 75446929.370, MiB/s: 575.614, result RPS: 37639659.982, result MiB/s: 287.168.
localhost:9000, queries 3, QPS: 3.815, RPS: 76466659.385, MiB/s: 583.394, result RPS: 38148392.297, result MiB/s: 291.049.

0.000%          0.258 sec.      0.250 sec.
10.000%         0.258 sec.      0.250 sec.
20.000%         0.258 sec.      0.250 sec.
30.000%         0.258 sec.      0.267 sec.
40.000%         0.258 sec.      0.267 sec.
50.000%         0.273 sec.      0.267 sec.
60.000%         0.273 sec.      0.267 sec.
70.000%         0.273 sec.      0.267 sec.
80.000%         0.273 sec.      0.269 sec.
90.000%         0.273 sec.      0.269 sec.
95.000%         0.273 sec.      0.269 sec.
99.000%         0.273 sec.      0.269 sec.
99.900%         0.273 sec.      0.269 sec.
99.990%         0.273 sec.      0.269 sec.

No difference proven at 99.5% confidence