rust-bench 文档

English version: README.md

rust-bench 文档集的统一索引，覆盖参考文档（事实/结构——是什么）与指南（流程——怎么做）。两层互相链接：指南链接到参考文档了解背景，参考文档链接到指南获取操作手册。

项目概述与快速上手见根 README.md。

参考文档

系统的事实/结构描述。

• 术语表——领域术语（运行时、测试、分析、任务队列、平台/仓库）。
• 架构——组件（Site/Collector/Database/benchlib）、多平台/多仓库模型、请求生命周期、数据模型。
• 配置——site-config.toml 字段参考（keys、repos、collectors、按 collector 的基准测试覆盖、环境变量回退）。
• 任务队列——分布式队列机制：请求状态、队列排序、任务入队、回填、重试。
• 部署——部署模型（Docker 镜像、Postgres、collect-job-queue.sh、环境变量、机器准备）。
• 比较分析——显著性（IQR 围栏）、量级分桶、相关性；仅按测试结果。
• 数据库 schema——运行时 + 任务队列 + 制品 + 错误表（编译时表不在范围）。
• 手动修改——例外 DB 操作（purge_artifact、重排队、停用 collector）。

指南

按步骤操作手册。每篇含前置条件 → 步骤 → 验证 → 故障排除。

• 本地运行基准测试——bench_runtime_local、过滤、输出、bench_cmp TUI。
• 编写运行时基准测试——#[bench] 宏与自定义基准测试框架。
• 剖析运行时基准测试——Cachegrind 与 perf-record；比较两个 rustc 构建。
• 部署 Site——Docker/Postgres、site-config.toml、环境变量、webhook 端点。
• 部署 Collector——注册、collect-job-queue.sh、机器准备、多架构。
• 接入 GitCode 与 GitHub——webhook 配置、/rust-bench 命令、fork PR、完成评论。

范围说明

本文档集覆盖运行时基准测试与分布式基准测试系统。继承自上游 rustc-perf 的编译时基准测试机制虽存在于代码库，但此处刻意不在范围。