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_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);
但这样的输出结果在程序较大时对于我们没有实际意义, 在 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 时间出来了。
分析结果页中有一个挺明显的 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.html http://www.162cm.com/p/xhprofdoc.html
转载请注明出处。
本文地址:http://blog.aboutc.net/php/17/php-profiler-xhprof
目录
导言
XHProf概况
术语表
特殊函数的命名约定
限制
安装XHProf扩展
使用XHProf来做性能分析
设置XHProf用户界面
在生产环境中使用XHProf的注意 事 项
轻量级采样模式
附加功能
依赖性
鸣谢
作者这样介绍自己:
翻译:徐仁禄 <xurenlu [at] gmail.com > 原文地址: 初次翻译,大部分是google translate tookit工具给翻的,稍微修改了下。如遇错误,还请来信指出。谢谢! 内容如下:
导言
XHProf 概况
安装XHProf扩展
使用XHProf进行性 能分析
设 置XHProf用户界面
在生产环境中使用 XHProf注意事项
轻量级采样模式
附加功 能
信赖
鸣 谢
XHProf是一个分层PHP性能分析工具。它报告函数级别的请求次数和各种指标,包括阻塞时间,CPU时间和内存使用情 况。一个函数的开销,可细分成调用者和被调用者的开销。原始数据收集部分是用纯C实现的,是一个名叫xhprof的 Zend扩展 。XHProf有一个简单的HTML的用户界面( PHP写成的)。基于浏览器的性能分析用户界面能更容易查看,或是与同行们分享成果。也能绘制调用关系图。
XHProf报告往往可以有助于理解被执行的代码的结构。的等级性质的报告可用来确定,例如,什么链要求导致了所谓的特殊 功能得到。
XHProf可以比较两次运行的结果(又名“差异报告”)或是从多次运行得到的汇总数据。差异和汇总报告,就像单一运行报 告一样,也提供“平板”以及“分层”的性能分析视图。
XHProf是一种轻量级的性能分析工具。在数据收集阶段,它记录调用次数的追踪和包容性的指标弧在动态 callgraph的一个程序。它独有的数据计算的报告/后处理阶段。在数据收集时,XHProfd通过检测循环来处理递归的函数调用,并通过给递归调用 中每个深度的调用一个有用的命名来避开死循环。
XHProf的轻量级性质和汇聚功能,使得它非常适合用于收集“生产环境”的性能统计数据的统计。[见用于生产环境的补充 说明。 ]
例如,XHProfLive (不属于开源的工具包),是Facebook使用的一个全系统的性能监测系统,建立在XHProf的基础之上 。 XHProfLive不断收集函数级别的Profiler资料,这些资料来自生产环境中运行中的示例页面[用xhprof来收集] 。然后XHProfLive汇总指定的时候,页面类型,来取得各个页面的性能数据,可以帮助解决各种问题,如:特定的某个网页的函数级的性能情况怎样?在 所有网页中,或者对某一具体的网页,foo 函数的开销如何?在过去的一小时/天/周中,哪些函数返回的次数最多?某个页面/函数的执行时间的变化趋势如何?等等。
由Facebook最初开发的XHProf在2009年3月开放源代码。
XHProf提供的功能:
load::lib/common.php - 内核加载和编译文件的工作。[注:如果您使用的了PHP的opcode 缓存比如APC之类的,只有当缓存失效时才会去编译。
run_init::lib/common.php -由于包含操作引起的初始化操作等。
哪些函数调用了指定的函数,各自调了多少次?
一个特定的函数调用了哪些函数?
在被一个特定的函数调用时,某个函数一共耗去了多少时间 。
扁平的性能概要(截 图 )
提供函数级别的性能信息,例如调用次数,其中包括/独家壁时间,内存使用情况,和CPU时间。
分层剖析(父/子{0视图){/0} ( 截 图 )
对每一个函数,它提供了一个断点,个崩溃的要求和时间每母公司(来电)和儿童(被调用) ,如:
差异报告
出于各种原因,您可能需要比较从两个XHProf运行中得到的数据-找出是什么造成了从一个版本到另一个版本的退 步,或是评估您将要做的优化的性能提升。
阿差异报告考虑两分,作为输入,并提供两个平面功能级别差异的信息,和层次信息(细目差异的父母/儿童职能)的每 个功能。
差异报告里的“平板”视图指出了最主要的退步或改进。
点击差异报告平板视图中的函数,进入“层次”(或父/子)视图。我们可以得到的具体的父子函数的差异。
Callgraph视图
性能数据也可以通过callgraph视图来查看 。callgraph 会高亮显示程序的关键路径。
内存剖析
XHProf的内存剖析模式能有助于跟踪那些申请大量内存的函数。
值得澄清的是,XHProfu并不严格跟踪所有分配/释放内存的操作。相反,它使用了一种简化思路。他记录了每个 函数进入和结束后的内存的增减。它还记录每个函数分配内存的峰值的变化。
XHProf记录include, include_once, require and require_once require_once操作,就像他们是函数一样。那些被包含文件的名字被用来产生假的函数的名字。
真正的层次剖析器会在每一个数据采集点记录完全的调用堆栈。接下来,能够回答这些问题,如:第三次foo()调用 的开销是多少?或是当调用栈是a()->b()->bar()时bar()函数的开销是多少?
XHProf只记录一级的调用上下文,因此只能回答关于一级一级函数调用的问题。事实证明,在实践中这是最主要的 利用情况。
为了使这个更具体,看看下面的例子。
假设你有: 1 call from a() --> c() 1 call from b() --> c() 50 calls from c() --> d()
虽然XHProf可以告诉你, d()被c()调用了50次,却不能告诉你,有多少次分别是由a()和b()引起的。[我们可以推测,也许有25次是因为a(),有25次是由于b(), 但未必如此。 ]
然而在实践中,这没什么大不了。
main():一个虚构的函数,这是所有调用的根节点。
load::<filename> 和 run_init::<filename>:
XHProf 跟踪PHP的include/require操作,和跟踪函数调用一样。
例如, include “lib/common.php"; 操作看起来像调了两个XHProf函数:
foo@<n> :意味着这是一个foo()函数的递归调用。<n>代表递归深度。递归可能是直接的,(比如由于foo() --> foo() ) ,也可能是间接的(如由于foo()-> goo() ->foo()。
Inclusive Time (或子树执行时间) :[包括子树执行时间的所有执行时间。]
Exclusive Time/Self Time :[函数执行本身的时间花费。]不包括子树执行时间。
Wall时间 :又名经过的时间或挂钟时间。
CPU时间 : CPU时间在用户空间+ CPU时间在内核空间
index.php :查看一个单一运行或差异报告。
callgraph.php :以图片的形式查看一次XHProf运行的调用关系图。
typeahead.php :在XHProf的报告中被后台调用来进行函数的自动补全。
PHP源码目录结构
XHProf的用户界面的由PHP实现。代码存放在两个子目录中: xhprof_html/和xhprof_lib/ 。
xhprof_html目录包含了3个顶级PHP页面。
该xhprof_lib目录包含进行分析和显示的支持代码 (计算 扁平的性能信息,计算diffs,从多次运行中汇总数据等等) 。
Web服务器配置:您需要确保您的Web服务器有权限读取xhprof_html/目 录可,并且能运行PHP脚本。
管理XHProf运行
客户端能很灵活地保存他们从XHProf运行中得到的XHProf原始数据。用户界面层 的XHProf提供了一个 iXHProfRuns接口(见xhprof_lib / utils / xhprof_runs.php ),客户端可以利用。这使得客户端能够告诉用户界面层,如何获取XHProf运行后产生的对应数据。
XHProf的UI 库自带的有一个基于文件的iXHProfRUns接口实现,即“ XHProfRuns_Default”(见xhprof_lib/utils/xhprof_runs.php)。这个自带的实现将XHProf运行结 果存在ini配置的xhprof.output_dir参 数指定的某个目录下。
一次XHProf运行,必须用一个命名空间和运行编号来唯一确定。
一)XHProf数据的永久保存 :
假设您使用的iXHProfRuns接口的XHProfRuns_Default这 个默认实现方式,一个典型的XHProf运行并保存结果的操作可能就是这样子的:
// start profiling xhprof_enable(); // run program .... // stop profiler $xhprof_data = xhprof_disable(); // // Saving the XHProf run // using the default implementation of iXHProfRuns. // include_once $XHPROF_ROOT . "/xhprof_lib/utils/xhprof_lib.php"; include_once $XHPROF_ROOT . "/xhprof_lib/utils/xhprof_runs.php"; $xhprof_runs = new XHProfRuns_Default(); // Save the run under a namespace "xhprof_foo". // // **NOTE**: // By default save_run() will automatically generate a unique // run id for you. [You can override that behavior by passing // a run id (optional arg) to the save_run() method instead.] // $run_id = $xhprof_runs->save_run($xhprof_data, "xhprof_foo"); echo "---------------\n". "Assuming you have set up the http based UI for \n". "XHProf at some address, you can view run at \n". "http://<xhprof-ui-address >/index.php?run=$run_id&source=xhprof_foo\n". "---------------\n";
上述代码就会将运行结果保存在xhprof.output_dir ini参数指定的特定目录下。文件的名称可能会是49bafaa3a3f66.xhprof_foo类似的东 东 ;两部分分别是运行编号( “ 49bafaa3a3f66 ” )和命名空间( “ xhprof_foo ” )。[如果您想创建/指定自己的run ID (如数据库中的序列号,或时间戳) ,您可以通过明确的给save_run方法 指定一个run id。
b )使用自己实现的iXHProfRuns
如果您希望您的XHProf运行存储在不同的数据库(例如用一个压缩格式,或者其他什么地方比如数据库等),您需实现一个类,这个实必须实现 iXHProfRuns ( )接口。
您还需要修改“xhprof_html/"目录中3个主要的PHP入口文件 (index.php , callgraph.php , typeahead.php ),使用新的类而不是默认的类XHProfRuns_Default 。改变3个文件的这一行:
$xhprof_runs_impl = new XHProfRuns_Default();
您还需要“include”声明了上述class的文件。
从用户界面中访问各次运行
一)看单一运行报告
要查看run id是<run_id>和命名空间是<namespace>的报告,访问URL:
http://<xhprof-ui-address>/index.php?run=<run_id>&source=<namespace>
例如,
http://<xhprof-ui-address>/index.php?run=49bafaa3a3f66&source=xhprof_foo
二)查看diff报告
要查看命名空间<namespace>下runid分别是< run_id1>和<run_id2>的两个报告,访问URL:
http://<xhprof-ui-address>/index.php?run1=<run_id1>&run2=<run_id2>&source=<namespace>
三)汇总报告
您也可以指定一组run id来汇总得到您想要的报告视图。
如果你有三个XHProf运行,都在"benchmark‘命名空间下,run id分别是1,2,3。要查看这些运行的汇总报告:
http://<xhprof-ui-address>/index.php?run=1,2,3&source=benchmark
加权汇总 :进一步假设,上述3个运特分别对应三种程序,p1.php,p2.php和p3.php ,通常以20%,30%,50%概率混合:要查看汇总报告所对应的加权平均数这些运行使用:
http://<xhprof-ui-address>/index.php?run=1,2,3&wts=20,30,50&source=benchmark
CPU的计时器( getrusage )在Linux上开销很大。为了在函数级别更有用,这个是粗粒度的(毫秒精确度,而不是微秒水平)。因此,使用XHPROF_FLAGS_CPU模式时, 在报告里,数字上的误差往往会更高。
我们建议在生产环境中使用 "占用时间+内存" 来做性能分析。[注:内存性能分析模式的额外开销很低。 ]
// elapsed time profiling (default) + memory profiling
xhprof_enable(XHPROF_FLAGS_MEMORY);
对随机抽样的部分page/request来做性能分析,对于获取您的生产环境的负载 情况特征数据,其实足够好了了。
分析万分之一的请求,可以用下面的代码:
if (mt_rand(1, 10000) == 1) { xhprof_enable(XHPROF_FLAGS_MEMORY); $xhprof_on = true; }
request结束时(或是在退出函数中) ,您可以这么做:
if ($xhprof_on) { // stop profiler $xhprof_data = xhprof_disable(); // save $xhprof_data somewhere (say a central DB) ... }
然后,您就可以用xhprof_aggregate_runs()来按时间(比如,每5 分钟/每小时/每天),或是按页面类型/request类型来汇总。
xhprof_aggregate_runs() :可用于多次XHProf运行结果汇总到一个单一的运行。这可以帮助您使用XHProf来建立一个全系统“的函数级别”的性能监测工具 。 [例如,您可以在生产环境中定期抽样XHProf的数据,产生小时/日级别的报告。 ]
xhprof_prune_run() :汇总大量XHProf运行结果(特别是如果它们对应不同类型的程序)将可能导致callgraph规模变得太大。您可以使用xhprof_prune_run功 能来修剪的callgraph数据中只占总运行时间中很小比例的子树。
JQuery的Javascript :在提示和函数名称补齐上 ,我们利用了JQuery这个JavaScript库。JQuery是基于MIT和GPL licencse ( http://docs.jquery.com/Licensing ) 的。XHProf用到的JQuery相关代码,在xhprof_html/jquery子 目录。
dot(图像生成工具) :调用关系视图工具( [查看Callgraph ] )这个功能依靠dot工具实现。 “点”是一种绘制/生成有向图的工具。
查询分析结果的HTML用户界面受到了Oracle 的存储过程语言PL/SQL里的一个相似的小工具的启发。但是仅仅如此,他们的内部性能分析过程是完全不同的。
--EOF-- 额,样式我不管了。觉得不好的还是查看原文吧。