外观
参考总览
查表页集合:错误码、环境变量、指标、端口、事件主题、迁移、平台 crate。数据以代码为源,逐条与代码核对后落表。
三条查表口径:代码为源
这些页面做同一件事:把散在代码里的契约常量收拢成可查的快照。查表 之前记住三条口径:表是快照、代码是权威,发现不一致以事实源列指向 的文件为准,并顺手修表;每个条目都可回溯到具体文件(config.rs、 error.rs、metrics.rs 或 proto),有歧义直接读源文件裁决;改了端口、 错误码、指标、主题的人同步更新对应参考页,这是编码规约 checklist 的项。
七个查表页的事实源索引
查什么进哪页、争议以哪个文件裁决,两个问题这张表一起回答:
| 参考页 | 内容 | 事实源 | 适用场景 |
|---|---|---|---|
| 错误码总表 | 1xxx 到 7xxx 分段与逐码明细 | platform-core error.rs 加各服务 error.rs | 按 problem 的 code 定位归属与处置 |
| 环境变量总表 | 装载规则、开关与测试门控 | platform-config 与各服务 main.rs | 改运行配置、找开关、跑 live 测试 |
| 指标总表 | 指标名、类型、标签 | platform-obs metrics.rs 与各服务埋点 | 写告警规则、配面板 |
| 端口总表 | 监听端口与形态差异 | 各服务 config.rs | 配代理与网格、查冲突 |
| 事件主题总表 | 主题、生产者消费者、载荷要点 | 各服务常量定义处 | 订阅事件、排消费滞后 |
| 迁移清单 | 五库逐文件用途与纪律 | migrations/ 目录 | 排查 schema、写新迁移 |
| 平台 crate 参考 | 11 个 crate 职责、关键 API 与 25 成员 workspace 构成 | 平台层源码与根 Cargo.toml | 选型与二次开发 |