python / python/cpython

Improve the documentation of profiling with "perf maps"

未关闭
#137,019 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs OS-linux OS-mac performance topic-profiling
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

The documentation lives here: https://github.com/python/cpython/blob/d6cf05b5d00abbfdf9008d646c14c6ef7c83b61a/Doc/howto/perf_profiling.rst

Before #136461, cpython only had support for Linux perf profiling. But with this PR it now supports both Linux and macOS through samply. I updated the documentation to include this, but it's not super great currently because previously it was written with the assumption that it was only supported by Linux perf. So it would be good to restructure this doc in a better way, and add more information related to macOS profiling using samply.

Also samply supports both perf modes so it would be good to clarify when to use them.

cc @pablogsal @hugovk

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Doc/howto/perf_profiling.rst 开始,并查看 PR #136461 中的更改,以了解当前 Linux perf 和 macOS samply 的支持范围。比较 samply 支持的 perf 模式,并重新组织指南,使平台支持、设置和模式选择清晰明了。完成标准是文档准确说明如何在 Linux 和 macOS 上进行 profiling,以及何时使用每种模式。

由索引模型根据 Issue 内容生成。

评估

技术栈
linux, macos, python
领域
documentation, performance
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
52/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。