使用 DEFLATE_QPL 构建 Clickhouse
使用 DEFLATE_QPL 运行基准测试
文件列表
文件夹 benchmark_sample 在 qpl-cmake 下提供了使用 python 脚本运行基准测试的示例：
client_scripts 包含用于运行典型基准测试的 python 脚本，例如：
client_stressing_test.py：用于 [1~4] 个服务器实例的查询压力测试的 python 脚本。queries_ssb.sql：文件列出了与 星型模式基准测试 相关的所有查询。allin1_ssb.sh：此 shell 脚本自动执行所有基准测试工作流程。
database_files 表示它将根据 lz4/deflate/zstd 编解码器存储数据库文件。
自动运行星型模式基准测试：
$ cd ./benchmark_sample/client_scripts
$ sh run_ssb.sh
完成后，请检查此文件夹中的所有结果：./output/
如果遇到故障，请手动运行基准测试，如下所述。
[CLICKHOUSE_EXE] 表示 ClickHouse 可执行程序的路径。
- CPU：Sapphire Rapid
- 操作系统要求参见 QPL 系统要求
- IAA 设置参见 加速器配置
- 安装 python 模块：
pip3 install clickhouse_driver numpy
[IAA 的自检]
$ accel-config list | grep -P 'iax|state'
预期输出如下：
"dev":"iax1",
"state":"enabled",
"state":"enabled",
如果未看到任何输出，则表示 IAA 尚未准备好工作。请再次检查 IAA 设置。
生成原始数据
$ cd ./benchmark_sample
$ mkdir rawdata_dir && cd rawdata_dir
使用 dbgen 生成 1 亿行数据，参数为：
-s 20
预期输出的文件为位于 ./benchmark_sample/rawdata_dir/ssb-dbgen 下的 *.tbl 文件：
数据库设置
使用 LZ4 编解码器设置数据库
$ cd ./database_dir/lz4
$ [CLICKHOUSE_EXE] server -C config_lz4.xml >&/dev/null&
$ [CLICKHOUSE_EXE] client
在控制台中你应该看到消息 Connected to ClickHouse server，这表示客户端与服务器成功建立了连接。
完成 星型模式基准测试 中提到的以下三个步骤：
- 在 ClickHouse 中创建表
- 插入数据。此处应使用
./benchmark_sample/rawdata_dir/ssb-dbgen/*.tbl 作为输入数据。
- 将“星型模式”转换为去规范化的“扁平模式”
使用 IAA Deflate 编解码器设置数据库
$ cd ./database_dir/deflate
$ [CLICKHOUSE_EXE] server -C config_deflate.xml >&/dev/null&
$ [CLICKHOUSE_EXE] client
完成与上述 lz4 相同的三步
使用 ZSTD 编解码器设置数据库
$ cd ./database_dir/zstd
$ [CLICKHOUSE_EXE] server -C config_zstd.xml >&/dev/null&
$ [CLICKHOUSE_EXE] client
完成与上述 lz4 相同的三步
[self-check]
对于每个编解码器 (lz4/zstd/deflate)，请执行以下查询以确保数据库已成功创建：
SELECT count() FROM lineorder_flat
你应该看到以下输出：
┌───count()─┐
│ 119994608 │
└───────────┘
[IAA Deflate 编解码器的自检]
第一次执行客户端的插入或查询时，预计 ClickHouse 服务器控制台将打印此日志：
Hardware-assisted DeflateQpl codec is ready!
如果你未发现此日志，而是看到如下日志：
Initialization of hardware-assisted DeflateQpl codec failed
这意味着 IAA 设备未准备好，需要再次检查 IAA 设置。
使用单实例进行基准测试
- 在开始基准测试之前，请禁用 C6 并将 CPU 频率调节器设置为
performance
$ cpupower idle-set -d 3
$ cpupower frequency-set -g performance
- 为了消除在跨插槽时内存绑定的影响，我们使用
numactl 将服务器绑定到一个插槽，将客户端绑定到另一个插槽。
- 单实例意味着单个服务器与单个客户端连接
现在分别为 LZ4/Deflate/ZSTD 运行基准测试：
LZ4:
$ cd ./database_dir/lz4
$ numactl -m 0 -N 0 [CLICKHOUSE_EXE] server -C config_lz4.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 1 > lz4.log
IAA deflate:
$ cd ./database_dir/deflate
$ numactl -m 0 -N 0 [CLICKHOUSE_EXE] server -C config_deflate.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 1 > deflate.log
ZSTD:
$ cd ./database_dir/zstd
$ numactl -m 0 -N 0 [CLICKHOUSE_EXE] server -C config_zstd.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 1 > zstd.log
现在应输出三条预期的日志：
lz4.log
deflate.log
zstd.log
如何检查性能指标：
我们关注 QPS，请搜索关键字： QPS_Final 并收集统计数据
使用多实例进行基准测试
- 为了减少过多线程对内存绑定的影响，建议使用多实例运行基准测试。
- 多实例意味着多个（2 或 4）服务器与相应客户端连接。
- 一个插槽的核心需要均匀分配并分别分配给服务器。
- 对于多实例，必须为每个编解码器创建新文件夹，并按照与单实例类似的步骤插入数据集。
有两个不同之处：
- 对于客户端，需要在创建表和插入数据时使用分配的端口启动 ClickHouse。
- 对于服务器，需要使用特定的 xml 配置文件启动 ClickHouse，端口已分配。所有用于多实例的自定义 xml 配置文件均已提供在 ./server_config 下。
在此假设每个插槽有 60 个核心，以 2 个实例为例。
启动第一个实例的服务器
LZ4：
$ cd ./database_dir/lz4
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_lz4.xml >&/dev/null&
ZSTD：
$ cd ./database_dir/zstd
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_zstd.xml >&/dev/null&
IAA Deflate：
$ cd ./database_dir/deflate
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_deflate.xml >&/dev/null&
[启动第二个实例的服务器]
LZ4：
$ cd ./database_dir && mkdir lz4_s2 && cd lz4_s2
$ cp ../../server_config/config_lz4_s2.xml ./
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_lz4_s2.xml >&/dev/null&
ZSTD：
$ cd ./database_dir && mkdir zstd_s2 && cd zstd_s2
$ cp ../../server_config/config_zstd_s2.xml ./
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_zstd_s2.xml >&/dev/null&
IAA Deflate：
$ cd ./database_dir && mkdir deflate_s2 && cd deflate_s2
$ cp ../../server_config/config_deflate_s2.xml ./
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_deflate_s2.xml >&/dev/null&
为第二个实例创建表并插入数据
创建表：
$ [CLICKHOUSE_EXE] client -m --port=9001
插入数据：
$ [CLICKHOUSE_EXE] client --query "INSERT INTO [TBL_FILE_NAME] FORMAT CSV" < [TBL_FILE_NAME].tbl --port=9001
- [TBL_FILE_NAME] 表示在
./benchmark_sample/rawdata_dir/ssb-dbgen 下以正则表达式命名的文件：*. tbl。
--port=9001 代表为服务器实例分配的端口，该端口在 config_lz4_s2.xml/config_zstd_s2.xml/config_deflate_s2.xml 中定义。对于更多实例，需要将其替换为值：9002/9003，分别代表 s3/s4 实例。如果未分配，默认端口为 9000，已由第一个实例使用。
使用 2 个实例进行基准测试
LZ4：
$ cd ./database_dir/lz4
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_lz4.xml >&/dev/null&
$ cd ./database_dir/lz4_s2
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_lz4_s2.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 2 > lz4_2insts.log
ZSTD：
$ cd ./database_dir/zstd
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_zstd.xml >&/dev/null&
$ cd ./database_dir/zstd_s2
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_zstd_s2.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 2 > zstd_2insts.log
IAA deflate
$ cd ./database_dir/deflate
$ numactl -C 0-29,120-149 [CLICKHOUSE_EXE] server -C config_deflate.xml >&/dev/null&
$ cd ./database_dir/deflate_s2
$ numactl -C 30-59,150-179 [CLICKHOUSE_EXE] server -C config_deflate_s2.xml >&/dev/null&
$ cd ./client_scripts
$ numactl -m 1 -N 1 python3 client_stressing_test.py queries_ssb.sql 2 > deflate_2insts.log
这里最后一个参数： 2 表示 client_stressing_test.py 的实例数量。对于更多实例，你需要将其替换为值：3 或 4。此脚本支持最多 4 个实例。
现在应输出三条预期日志：
lz4_2insts.log
deflate_2insts.log
zstd_2insts.log
如何检查性能指标：
我们关注 QPS，请搜索关键字： QPS_Final 并收集统计数据
4 个实例的基准测试设置与上述 2 个实例的设置类似。
我们建议使用 2 个实例的基准测试数据作为最终报告以供审核。
每次启动新的 ClickHouse 服务器之前，请确保没有后台 ClickHouse 进程在运行，请检查并终止旧进程：
$ ps -aux| grep clickhouse
$ kill -9 [PID]
通过比较 ./client_scripts/queries_ssb.sql 中的查询列表与官方 星型模式基准测试，你会发现 3 个查询未包含： Q1.2/Q1.3/Q3.4 。这是因为这些查询的 CPU 利用率百分比非常低 < 10%，这意味着无法展示性能差异。
