Pyflame 生成火焰图分析 Python 程序

本文首发于公众号编程派（微信号：codingpy），

Pyflame 是 Uber 官方开源的 Python 性能分析工具，可以用来生成火焰图。相较于内置的 profile 或 cProfile 模块，Pyflame 的开销更小，性能表现更好，而且可展示更多的性能数据。还有一个优点，就是不用修改你的Python代码，直接用命令行对当前的 Python 进程进行 profile。

火焰图是一款性能调优工具，可以清晰的看出程序运行瓶颈在哪里。

安装 Pyflame

以 Ubuntu 系统为例，参照如下命令即可安装 Pyflame：

第一步：安装系统依赖

# Install build dependencies on Debian or Ubuntu.
sudo apt-get install autoconf automake autotools-dev g++ pkg-config python-dev python3-dev libtool make

第二步：编译

git clone https://github.com/uber/pyflame.git
cd pyflame

./autogen.sh
./configure
make

安装好后可执行文件在 ./src/pyflame 中。

如果不想手动编译安装，可以选择网友预先构建的安装包：

sudo apt-add-repository ppa:trevorjay/pyflame
sudo apt-get update
sudo apt-get install pyflame

如果你使用的是 conda ，那么可以直接通过如下命令安装：

conda install -c eklitzke pyflame

使用 Pyflame

Pyflame 提供了两种使用方式，一种是直接依附到（attach to）正在执行的进程，另一种则是追踪某个命令从头到尾的执行情况。

需要注意的是，Pyflame 无法直接生成火焰图，而是输出符合另一个专门工具 flamegraph 要求的数据。因此我们还要补充一个步骤：

git clone https://github.com/brendangregg/FlameGraph.git
cd FlameGraph

依附到正在执行的进程

假设我们要分析 uwsgi 进程，首先确认进程的 pid：

查看要调试的进行ID：

ps aux|grep uwsgi

root      3013  0.0  0.7 258924 26556 ?        S    7月20   0:26 uwsgi /var/www/v7/uwsgi.ini
root      3018  2.2  2.3 7886732 86448 ?       Sl   7月20 194:37 uwsgi /var/www/v7/uwsgi.ini
root      3019  2.9  2.3 7027772 85000 ?       Sl   7月20 258:56 uwsgi

然后执行命令：

# 生成进程 3013  的火焰图；默认 $PATH 路径中包含有 flamegraph.pl
pyflame -p 3013 | flamegraph.pl > myprofile.svg

追踪命令的执行情况

我们也可以用 Pyflame 追踪某个命令从开始到结束的完整执行情况。例如追踪某个测试或者批量任务的运行情况。只需要在 pyflame 命令的最后，添加 -t 旗标即可实现，-t 后面的均被视为要运行的命令：

pyflame -t py.test tests/

结语

Pyflame 生成的火焰图可以用 Chrome打开，能进行缩放和选择操作。综合上面的介绍，可以看出 Pyflame 的优势还是尤其明显的，性能更强，不用修改 Python 代码即可使用。

目前，Pyflame 在 Github 上有 2.6k 的标星。