首页 > 代码库 > 使用 XHProf 分析你的 PHP 程序

使用 XHProf 分析你的 PHP 程序

引自原文 http://blog.aboutc.net/php/17/php-profiler-xhprof

简介

XHProf是一个轻量级PHP性能分析工具,类似 xdebug,但比 xdebug 分析的信息更加详细, 包括函数的调用次数,花费的时间(自身花费时间和包含内部函数花费的时间),所占内存/CPU,所占内存的峰值及所占百分比, 为什么用的是呢,因为源码包中 xhprof_lib/display/xhprof.php文件里还有一个 Incl. User (microsecs) 和 Incl. Sys (microsec) 没有在结果中显示,有兴趣的同学可以研究研究。

安装

$ wget https://github.com/facebook/xhprof/tarball/master -O xhprof.tar.gz$ tar zxf xhprof.tar.gz$ cd facebook-xhprof-b8c76ac/extension/# phpize# ./configure --with-php-config=`/path/to/php-config`# make && make install# make test# vi /etc/php.d/xhprof.ini; 内容为:extension = xhprof.so; 注意:output_dir 必须存在且可写xhprof.output_dir = /tmp/xhprof# service php-fpm restart 或 service httpd restart

当然也可以使用 yum install php-pecl-xhprof 安装, 但是源码包中 xhprof_html 和xhprof_lib 这两个文件夹是需要的,见 使用 web 界面。

简单使用

现在运行下例子看下效果:

$ php -f facebook-xhprof-b8c76ac/examples/sample.php

输出结果略。

输出结果中的含义:

ct 函数调用次数,wt 花费的时间,cpu 花费的 CPU 时间(微秒即百万分之一秒),mu 使用的内存(bytes),pmu 使用的内存峰值(bytes)。
xhprof_enable 参数

还可以给 xhprof_enable() 传入:

XHPROF_FLAGS_CPU 分析结果中添加 CPU 数据XHPROF_FLAGS_MEMORY 分析结果中添加内存数据XHPROF_FLAGS_NO_BUILTINS 跳过 PHP 内置函数

三个参数中的一个或多个,类似这样:

xhprof_enable(XHPROF_FLAGS_NO_BUILTINS);xhprof_enable(XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY);xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

使用 web 界面

但这样的输出结果在程序较大时对于我们没有实际意义, 在 xhprof 源码包中提供了xhprof_html 和 xhprof_lib两个文件夹是使用 PHP 开发,用于显示 xhprof 分析结果的 web 界面, 比上例输出结果更加详细易读。

$ mkdir /var/www/html/xhprof$ mv xhprof_html/ xhprof_lib/ examples/ /var/www/html/xhprof/$ cd /var/www/html/$ vi xhprof/examples/sample.php `<xhprof-ui-address>` 替换为 `localhost/xhprof/xhprof_html`

/var/www/html 为 DOCUMENT_ROOT 目录。

测试一下,浏览器运行:

http://localhost/xhprof/examples/sample.php

而浏览器输出的内容最后有一个类似这样的链接地址:

http://localhost/xhprof/xhprof_html/index.php?run=50ec187a72aa9&source=xhprof_foo

/tmp/xhprof 目录下会多出一个类似于 50ec187a72aa9.xhprof_foo.xhprof 的文件, 此文件用于存储 xhprof 分析结果的数据信息,作为上述 url 地址的数据来源。

打开这个链接即是 xhprof 的 web 分析结果页面。 这个页面提供了:

Calls:函数的调用次数Incl. Wall Time (microsec) :包含内部函数花费的时间,单位微秒Excl. Wall Time (microsec):不包含内部函数花费的时间,单位微秒及所占百分比(%)注:Incl.:为 Including 包含的简写Excl.:为 Excluding 不包含的简写Wall Time:意为挂钟时间即任务花费的时间

根据此结果页简单解释下 Function Name 列:

main():一个虚构的函数,程序根节点bar@2:递归调用 2 

另外 load::filename 和 run_init::filename 是跟踪 PHP 的 include/require 操作。

在此结果中 strlen 和 xhprof_disable 为 PHP 内置函数,如果我们想跳过内置函数不作分析, 并且统计 CPU 和内存使用信息怎么办呢,上面提到过 xhprof_enable 参数, 修改xhprof/examples/sample.php 文件看一下:

 xhprof_enable(); 行,替换为xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

刷新下页面,再次打开页面最后的 url,这次提供的信息就十分详细了。

Incl. CPU (microsecs):包含内部函数 CPU 花费的时间,单位微秒Excl. CPU (microsec):不包含内部函数 CPU 花费的时间,单位微秒Incl. MemUse (bytes):包含内部函数所占内存,单位字节Excl. MemUse (bytes):不包含内部函数所占内存,单位字节Incl. PeakMemUse (bytes):包含内部函数所占内存峰值,单位字节Excl. PeakMemUse (bytes):不包含内部函数所占内存峰值,单位字节及所占百分比(%)可以认为共三种情况:1. 包括内部函数2. 不包括内部函数或者说函数本身3. 所占总数(时间或内存使用)的百分比

peak 意为峰值,这里的 CPU 花费时间为什么是 0 呢, 再修改下xhprof/examples/sample.php 文件看一下:

 foo() 函数中的 for 循环条件 $idx < 5 改为 50

再看一下 web 分析页面结果,CPU 时间出来了。

安装 graphviz

分析结果页中有一个挺明显的 View Full Callgraph 链接, 这个链接是查看整个程序的函数调用流程。使用 graphviz 生成。

# yum install graphviz

编译安装请注意先安装 libpng 依赖。

参考

net tuts+:http://net.tutsplus.com/tutorials/php/advanced-codeigniter-profiling-with-xhprof/源码包中的:xhprof_html/docs/index.htmlhttp://www.162cm.com/p/xhprofdoc.html
转载请注明出处。
本文地址:http://blog.aboutc.net/php/17/php-profiler-xhprof

 

使用 XHProf 分析你的 PHP 程序