| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[docs] 添加文档托管网站基础设施 Co-authored-by: Jechin<yuzechen1@huawei.com> # message auto-generated for no-merge-commit merge: !114 merge docs/readthedocs into master [docs] 添加文档托管网站基础设施 Created-by: Jechin Commit-by: Jechin Merged-by: towncharlie Description: ## **1. 合入背景** > 请描述为什么要做这个PR内的改动。\ > 如涉及，请关联前序PR或同特性/需求下的其他PR。\ > 如果是修复之前PR引入的问题，请关联引入问题的PR。\ > 请通过#ISSUE ID关联issue。\ > 注意： Fixes #ISSUE ID会自动关闭issue，如问题部分解决请不要使用Fixes，可以用Fix part of #ISSUE ID替代. Fixes [#80](https://gitcode.com/Ascend/MindIE-PyMotor/issues/80) ## **2. 修改内容** > 请<ins>**描述修改内容的具体实现**</ins>，涉及哪些组件之间进行交互，可以用1、2、3、...进行罗列。 > 如果是需求或者重构类的PR，需要<ins>**补充详细设计文档**</ins>（说明上下游组件关系、时序图、类图、DFX能力等内容）。 ## **3. 资料变更** > 请确认<ins>**是否涉及资料变更**</ins>。\ > 如涉及，需要在PR中体现，并简要说明修改内容。\ > 如不涉及，需填写“不涉及”。 ## **4. 接口变更** > 请确认<ins>**是否涉及跨代码仓或者客户面可见的接口变更**</ins>。\ > 如涉及，需详细说明接口以及对应的变更内容，同时需要在资料中体现。\ > 如不涉及，需填写“不涉及”。 不涉及 ## **5. 测试结果** > 需体现<ins>**测试场景，测试方法以及测试结果**</ins>。\ > 测试用例设计时需考虑硬件、部署方式、功能、性能、精度、显存等维度。 不涉及 ## **6. CheckList** > PR提交人对以下CheckList自检项进行全量自检，自检通过或不涉及，均修改 [ ] 为 [x] [x] 代码注释完备 [x] 正确记录维测日志 [x] 是否有UT用例 [x] 若涉及多线程场景，考虑了并发场景，不存在死锁问题 See merge request: Ascend/MindIE-PyMotor!114 | 3 个月前 | |
【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 | 20 天前 |