| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
【docs】新增指标接口文档 metrics_interfaces.md,梳理监控/观测接口与弃用关系 Co-authored-by: 吕有辉<lvyouhui@huawei.com> # message auto-generated for no-merge-commit merge: !741 merge docs/metrics_interfaces into master 【docs】新增指标接口文档 metrics_interfaces.md,梳理监控/观测接口与弃用关系 Created-by: codeDogPro Commit-by: 吕有辉 Merged-by: tobking Description: ## **1. 合入背景** 指标接口（Coordinator Observability 端口 GET /metrics）是 Motor 监控指标的唯一推荐获取途径，但文档将说明分散在 monitoring_interfaces.md、observability_interface.md、api/README.md 多处：/observability/metrics 在代码中已标记弃用而文档未标注、/metrics 的聚合视图/返回格式/指标清单缺失、监控与观测接口默认端口同为 1027 易混淆。本 PR 重构指标相关文档，使其与代码现状一致。 关联 ISSUE：#482 ## **2. 修改内容** 1. 新增 docs/zh/user_guide/api/metrics_interfaces.md：完整说明 /metrics 接口的请求参数（type/role/format）、5 种聚合视图（full/instance/role/dp/node）、Prometheus / OpenTelemetry 两种返回格式及示例、返回指标清单（SLA/时延直方图、状态 Gauge、Counter、派生指标、进程指标、KV Store 指标）、数据加工说明（采集周期、聚合语义、Counter 累计语义、engine= 标签剥离、inactive 实例归零等）、Prometheus 对接配置与错误处理；并承接已弃用的 /instance/metrics 说明。 2. observability_interface.md：/observability/metrics 标注 [!WARNING] 已弃用 并指向新文档；CCAE Reporter 交互表格指标行更新为 Coordinator /metrics（与 ccae_reporter 代码实际行为一致）。 3. monitoring_interfaces.md 删除（内容并入以下文档）：/health 并入 management_interfaces.md 探针接口组（注明其挂在 Coordinator Observability 端口而非管理端口）。 4. api/README.md：管理接口加入 /health；「监控接口」章节更名为「指标接口」并主推 /metrics；观测接口移除已弃用的 /observability/metrics；提示两个 1027 端口（Coordinator 指标端口 vs Controller 观测端口）的区别。 5. 同步更新 .nav.yaml、menu_user_manual.md、design/scaling.md 的文档入口与链接。 ## **3. 资料变更** 涉及。本次改动全部为 docs/zh/ 下文档（新增 1 个文件，修改 5 个，删除 1 个）。 ## **4. 接口变更** 不涉及代码接口变更。文档层面将 /observability/metrics、/instance/metrics 标注为已弃用并指引到 /metrics（接口行为与代码现状一致，代码已提前完成弃用标记）。 ## **5. 测试结果** - 纯文档改动，无代码/单测影响。 - 已校验：全部相对链接与标题锚点（脚本校验 0 问题）；monitoring_interfaces 引用清零；pre-commit 钩子通过（gitleaks 因仓库缺少 ./gitleaks 二进制跳过，其余全过）。 - 内容与代码核对：motor/coordinator/api_server/observability_server.py（路由/参数/端口）、motor/coordinator/metrics/（聚合视图、指标注册表、加工逻辑）、motor/controller/api_server/controller_api.py（弃用标注）、examples/features/observability/ccae_reporter/backends/motor_backend.py（CCAE 指标采集入口）。 ## **6. CheckList** [x] 代码注释完备（不涉及，纯文档） [x] 正确记录维测日志（不涉及，纯文档） [x] 是否有UT用例（不涉及，纯文档；链接/锚点已脚本校验） [x] 若涉及多线程场景，考虑了并发场景，不存在死锁问题（不涉及，纯文档） See merge request: Ascend/MindIE-Motor!741 | 1 个月前 | |
【docs】修改pymotor名称&新增目录结构&新增通信矩阵 Co-authored-by: xiao-qing123<xiaoqing14@h-partners.com> # message auto-generated for no-merge-commit merge: !504 merge master into master 【docs】修改pymotor名称&新增目录结构&新增通信矩阵 Created-by: xiao-qing123 Commit-by: xiao-qing123 Merged-by: towncharlie Description: Fixes [#301](https://gitcode.com/Ascend/MindIE-PyMotor/issues/301) 1、修改MindIE Pymotor名称为：MindIE Motor 2、新增menu文件 3、新增MindIE Motor通信矩阵 See merge request: Ascend/MindIE-PyMotor!504 | 2 个月前 | |
【docs】版本说明说内容及文件名修改 Co-authored-by: xiao-qing123<xiaoqing14@h-partners.com> # message auto-generated for no-merge-commit merge: !637 merge master into master 【docs】版本说明说内容及文件名修改 Created-by: xiao-qing123 Commit-by: xiao-qing123 Merged-by: towncharlie Description: Fixes [#375](https://gitcode.com/Ascend/MindIE-Motor/issues/375) 1、修改更新说明为：原 MindIE PyMotor 代码仓自 3.1.0 版本起更名为 MindIE Motor，后续版本将沿用该命名。其软件定位与基本功能保持不变，但仅兼容 vLLM-Ascend 推理引擎（3.1.0及以上版本）。 2、为适配社区发布页面，各仓的版本说明书文件名不能一样，修改版本说明书文件名为：release_note_motor.md See merge request: Ascend/MindIE-Motor!637 | 1 个月前 | |
[docs] 对齐 MindIE-Motor 文档站品牌、锚点与仓链 Co-authored-by: Jechin<yuzechen1@huawei.com> # message auto-generated for no-merge-commit merge: !621 merge fix/docs-mkdocs-site-motor into master [docs] 对齐 MindIE-Motor 文档站品牌、锚点与仓链 Created-by: Jechin Commit-by: Jechin Merged-by: towncharlie Description: ## **1. 合入背景** > Read the Docs 页眉仍显示旧品牌 MindIE-PyMotor；中文标题锚点失效；文档内存在旧仓名断链；README 缺少在线文档入口且 Ask AI 仍指向旧仓。 Fixes [#366](https://gitcode.com/Ascend/MindIE-Motor/issues/366) 双合：本 PR 合入 master；同改动另提至 v3.1.0：!622。 ## **2. 修改内容** 1. 更新 mkdocs.yml：站点元数据改为 MindIE-Motor，site_url 对齐 https://mindie-motor.readthedocs.io/；toc 启用 Unicode 友好 slugify（不使用标题显式 {#id}）。 2. 修正文档内旧仓名 MindIE-PyMotor 链接与 docs 外断链（改为指向 Ascend/MindIE-Motor 的可点击绝对链接；仓内路径纠错）。 3. 更新 README.md：补充 Read the Docs 入口；Zread / DeepWiki 改为 Ascend/MindIE-Motor。 ## **3. 资料变更** 涉及：mkdocs.yml、README.md，以及相关 docs/zh 中文文档链接与品牌文案。 ## **4. 接口变更** 不涉及 ## **5. 测试结果** > 本地：conda activate motor 后 mkdocs build 可验证。\ > 已 rebase 至最新 master。 ## **6. CheckList** > PR提交人对以下CheckList自检项进行全量自检，自检通过或不涉及，均修改 [ ] 为 [x] [x] 代码注释完备 [x] 正确记录维测日志 [x] 是否有UT用例 [x] 若涉及多线程场景，考虑了并发场景，不存在死锁问题 See merge request: Ascend/MindIE-Motor!621 | 1 个月前 |
开发者指南
面向 MindIE Motor 代码贡献者，涵盖软件实现细节、类图、数据流与开发工具。
内容侧重
- 组件内部实现（Controller、Coordinator、Engine Server、Node Manager）
- 类图、数据流、模块交互
- 构建工具（文档构建、镜像制作）
与设计文档的区别
| 开发者指南 | 设计文档 |
|---|---|
| 软件实现细节 | 特性原理与设计说明 |
| 面向代码贡献者 | 面向深度用户、架构师 |
| 侧重 "代码怎么写出来的" | 侧重 "为什么这么设计" |
如果你需要理解特性的设计原理与架构决策，请查看 设计文档。