使用XHProf查找PHP性能瓶颈

XHProf是facebook 开发的一个测试php性能的扩展，本文记录了在PHP应用中使用XHProf对PHP进行性能优化，查找性能瓶颈的方法。

安装Xhprof扩展

$ wget http://pecl.php.net/get/xhprof-0.9.4.tgz
$ tar -zxvf xhprof-0.9.4.tgz 
$ cd xhprof-0.9.4$ cd extension/
$ phpize
$ ./configure
$ make
$ sudo make install

修改php.ini

[xhprof]
extension=xhprof.so
xhprof.output_dir=/tmp

配置中xhprof.output_dir指定了生成的profile文件存储的位置，我们将其指定为/tmp。

对PHP进行性能分析

在XHProf扩展中，一共提供了四个函数用于对PHP进行性能分析。

xhprof_enable/xhprof_sample_enable函数用于开始XHProf性能分析，区别在于前者功能更加强大，而后者则是是以简单模式启动性能分析（简单记录了函数的调用栈信息），开销比较小。

xhprof_disable/xhprof_sample_disable函数用于停止性能分析，并返回分析的数据。

需要特别说明的函数是xhprof_enable，其他函数都是不需要提供参数的，而该函数则可以接受两个可选的参数，用于改变该工具的行为。

void xhprof_enable ([ int $flags = 0 [, array $options ]] )

• flags 该参数用于为剖析结果添加额外的信息，该参数的值使用以下宏，如果需要提供多个值，使用|进行分隔。

  • XHPROFFLAGSNO_BUILTINS 跳过所有的内置函数

  • XHPROFFLAGSCPU 添加对CPU使用的分析

  • XHPROFFLAGSMEMORY 添加对内存使用的分析

• options 数组形式提供可选参数，在此处提供ignored_functions选项需要忽略的函数

比如下面的例子，同时对内存和CPU进行分析，并且忽略对call_user_func和call_user_func_array函数的分析。

xhprof_enable(
    XHPROF_FLAGS_MEMORY|XHPROF_FLAGS_CPU,
    [        'ignored_functions'    => [            'call_user_func',            'call_user_func_array'
        ]
    ]
);// 这里是PHP代码，比如业务逻辑实现等要被分析的代码部分....$xhprofData = xhprof_disable();// $xhprofData是数组形式的分析结果print_r($xhprofData);

注意，如果使用XHPROF_FLAGS_CPU选项对CPU占用也进行分析，在Linux环境下，会造成比较高的系统负载，因此不建议使用，而推荐只使用XHPROF_FLAGS_MEMORY，对内存的分析不会对系统造成太多负载。

形象化的查看分析结果

使用xhprof_disable完成性能分析并且获取到分析结果之后，我们通常不会直接输出结果，因为这样的结果是以数组形式组织的，看起来并不直观，幸运的是，xhprof提供了基于web的图形界面对分析结果进行查看。

数组输出的结果：

array (size=5)
  'LiuqhController::foreachAction==>var_dump' => 
    array (size=2)
      'ct' => int 7
      'wt' => int 647
  'main()==>LiuqhController::foreachAction' => 
    array (size=2)
      'ct' => int 7
      'wt' => int 1400101
  'main()==>time' => 
    array (size=2)
      'ct' => int 1
      'wt' => int 3
  'main()==>xhprof_disable' => 
    array (size=2)
      'ct' => int 1
      'wt' => int 1
  'main()' => 
    array (size=2)
      'ct' => int 1
      'wt' => int 1400233

输出结果中的含义：

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

在使用之前，请先确保服务器安装了graphviz工具，否则在生成监控图表的时候回出现以下错误:

failed to execute cmd: " dot -Tpng". stderr: `sh: dot: command not found '

这里提示找不到dot命令，所以需要先安装graphviz

$ sudo yum install graphviz

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

graphviz安�

Graphviz 支援 Windows、Mac OS X、FreeBSD、Solaris、Linux 等多�作�系�。

若您是 Linux 使用者，基於�款��的名�，您的套件管理器中�乎一定�有，�套件�中安�吧！倘若真找不到，�看官�下��面，��原始�。

若您是 Windows 用�，�前往��下�安��：http://www.graphviz.org/Download_windows.php

Mac OS X 的使用者�往��走：http://www.graphviz.org/Download_macos.php

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

由于分析结果的查看工具是基于web的，因此，我们需要将xhprof安装包中的xhprofhtml和xhproflib目录放到服务器的web目录下，让xhprof_html目录中的内容对外可以访问。

比如我的测试服务器环境是使用vagrant搭建的Cent OS，我见过这两个目录放到/vagrant/xhprof目录下：

[vagrant@localhost xhprof]$ pwd/vagrant/xhprof
[vagrant@localhost xhprof]$ ls
xhprof_html  xhprof_lib

web服务器使用的是Nginx，因此，在Nginx的配置文件nginx.conf中的配置如下：

server {
    listen       80;
    server_name  _;
    root /vagrant;
    ...

web服务器的根目录是/vagrant，因此访问地址为http://localhost/xhprof/xhprof_html/index.php.

当然，配置好环境之后，我们还是获取不到分析结果的，因为我们在代码中并没有将分析结果保存到xhprof.output_dir指定的目录中。

因此，我们需要修改我们的代码，是其能够将分析结果存放到xhprof.output_dir指定的目录中。

....$xhprofData = xhprof_disable();
require '/vagrant/xhprof/xhprof_lib/utils/xhprof_lib.php';
require '/vagrant/xhprof/xhprof_lib/utils/xhprof_runs.php';
$xhprofRuns = new XHProfRuns_Default();
$runId = $xhprofRuns->save_run($xhprofData, 'xhprof_test');


echo 'http://localhost/xhprof/xhprof_html/index.php?run=' . $runId . '&source=xhprof_test';

变量$runId是本次请求生成分析结果的id，最后我们输出了一个链接地址，使用改地址就可以看到本次请求的分析结果。

注意到中间的View Full Callgraph链接，通过该链接我们可以看到图形化的分析结果。

图中红色的部分为性能比较低，耗时比较长的部分，我们可以根据根据哪些函数被标记为红色对系统的代码进行优化

补充：

    进入刚才解压的安装包文件夹中，将xhprof_lib和xhprof_html复制到项目目录下。
    接下来，建立一个头文件head.php，这是要打两个点中的开头的点：//head.php
<?php
if(extension_loaded('xhprof')){
    //载入下载的XHPROF包中的2个文件夹
    include_once 'xhprof_lib/utils/xhprof_lib.php';
    include_once 'xhprof_lib/utils/xhprof_runs.php';
    xhprof_enable(XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY);
}

    再建立一个底部文件foot.php，这是要打两个点中的结尾的点：//foot.php
<?php
if(extension_loaded('xhprof')){
    $ns = 'myXhprof';
    //关闭profiler
    $xhprofData = xhprof_disable();
    //实例化类
    $xhprofRuns = new XHProfRuns_Default();
    $runId = $xhprofRuns->save_run($xhprofData, $ns);
    //前端展示库的URL
    $url = 'http://localhost/xhprof_html/index.php';
    $url .= '?run=%s&source=%s';
    //变量替换
    $url = sprintf($url, $runId, $ns);
    //输入URL
    echo '<a href="'.$url.'" target="_blank">查看结果</a>';
}

    使用的最后一步：打点。现在我们建立一个测试文件index.php。测试我大Hello World。//index.php
<?php
include_once 'head.php';
echo 'Hello World';
include_once 'foot.php';
   
    可以看到，在http://localhost/index.php中，最下面是我们在foot.php中写的“查看结果”，点击进去，可以看到本次请求所使用到的所有函数的列表，每个函数所耗费的时间、CPU、Memory等信息，点击第一栏可以根据所选排序。点击[View Full Callgraph]可以看到由本列表所生成的流程图，从入口到哪个函数，又到哪个函数，这个函数调用了哪个函数，这个函数调用了多少次Memcache等，一幕了然。减少MC的调用，减少这个，减少那个，请求的响应速度能不快吗？


    我有1000个文件，现在我需要用XHProf检测一下我整个项目，难道要每个文件头部和尾部都要加上include吗？
    
    第一种：
    在php.ini中添加：
    
    auto_prepend_file = /var/www/head.php
    auto_append_file = /var/www/foot.php

    第二种：
    在.htaccess中添加
    
    php_value auto_prepend_file  "/var/www/head.php"
    php_value auto_append_file  "/var/www/foot.php"