参考手册
查阅型资料。本章不建议从头读到尾 —— 每一页都是表格、注册表或规范,查完就走。
如果你是在学习这套系统而不是查值,请改去 核心概念。
本章内容
| 页面 | 规定了什么 |
|---|---|
| 线协议 | v0 线协议的唯一事实来源:帧格式、15 op 表、字段语义、版本规则 |
| 错误码 | 50 个错误码、四个段落,每行带「客户端该做什么」列 |
| 配置 | JSON 白名单 —— 每个键的类型、默认值、理由与更新时机 |
| 命令行 | 7 个命令、TSV 列序、退出码与 --api-version |
| 指标 | /metrics、/healthz、/stats 上的 15 项指标白名单 |
| API | 生成的公共 API 参考(moon doc) |
错误码
错误码单独一页 —— 错误码注册表 —— 按四个已注册段落组织(0x0xxx 协议、0x2xxx 元数据、0x4xxx 背压、0x6xxx 复制),每行都带「客户端该做什么」列。它从线协议拆出来,是因为查错误码是查表行为(「我收到 0x0024 该干嘛」),不是顺序读规范。
让参考页可信的三条契约
- 白名单之外的配置键在启动时被拒绝 —— 表格无法与代码悄悄脱节。
- TSV 列序由 golden 测试锁死;改动必须 bump
--api-version。 - 15 项白名单之外的指标在评审阶段被拒绝。
破坏其中任何一条,就意味着对应参考页是错的,而那是一个失败的测试,不是文档 bug。