Prhub

#22982 [Docs] fix profiling endpoint

原始 PR 作者 Zaire404 合并时间 2026-04-17 00:51 文件变更 1 提交数 1 评论 1 代码增减 +12 / -9

执行摘要

修正性能剖析文档中停止剖析的 HTTP 端点名称。

根据 PR body 中的描述,原文档指导用户使用 /end_profile 来停止剖析,但实际运行的服务器暴露的是 /start_profile/stop_profile 端点。这导致了文档与实际 API 行为不一致,可能误导用户。

该 PR 变更简单直接,无需深入技术分析。对于需要了解性能剖析端点的开发者,可快速浏览以确认正确的 API 使用方式。

讨论亮点

该 PR 仅有一次由 b8zhong 的批准,没有实质性的 review 评论或讨论。这表明变更直接且无争议,属于简单的文档同步修复。

实现拆解

  1. 修正端点名称:将文档中所有提及 /end_profile 的地方统一替换为 /stop_profile,包括端点描述、参数说明和示例命令。
  2. 澄清输出目录行为:在“剖析服务器”章节开头,新增一段说明,解释 output_dir 参数在 bench_serving --profile 客户端调用和直接调用 /start_profile 时的不同行为,并建议同时设置 SGLANG_TORCH_PROFILER_DIR 环境变量以避免混淆。
  3. 同步参数说明:在 /start_profile 的参数列表中,将 num_steps 参数的描述从“手动停止使用 /end_profile”更新为“手动停止使用 /stop_profile”。
  4. 更新示例命令:将所有示例中的 curl -X POST http://127.0.0.1:30000/end_profile 命令更新为使用 /stop_profile 端点。
文件 模块 状态 重要度
docs/developer_guide/benchmark_and_profiling.md 开发者指南 modified 2.41

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

技术风险极低

  • 此 PR 仅修改文档,不涉及任何源代码、配置或测试,因此不存在回归、性能、安全或兼容性风险。
  • 唯一潜在风险是文档更新可能仍存在其他未同步的端点引用,但基于当前变更范围,风险可控。

影响范围有限

  • 用户影响:正面影响。修复了文档错误,使用户能正确使用 /stop_profile 端点停止剖析,避免操作失败或困惑。
  • 系统影响:无。文档变更不影响系统运行。
  • 团队影响:维护了文档的准确性,减少了用户支持成本。
文档不一致

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论