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 摘要。