php轻量级的性能分析工具xhprof的安装使用

一、前言

　　有用的东西还是记录下来吧，也方便以后的查询；这次记录一下xhprof的安装使用；

　　xhprof是facebook开源出来的一个php轻量级的性能分析工具，跟xdebug类似，但性能开销更低，

　　还可以用在生产环境中，也可以由程序开 关来控制是否进行profile。

二、安装

  wget http://pecl.php.net/get/xhprof-0.9.3.tgz 
  tar zxf xhprof-0.9.3.tgz 
  cd xhprof-0.9.3/extension
  /usr/bin/phpize 
 (php版本安装后生成的phpize文件，可根据phpinfo查看，所以php版本不同，生成的phpize也不同，此步骤主要生成configure文件)
  ./configure –with-php-config=/usr/bin/php-config 
 (php-config的路径，也是php安装后生成的文件) 
  make 
  sudo make install 

 (会自动将生成的扩展文件拷贝到扩展目录中/usr/lib64/php/modules)

    当然具体的php文件的目录，每个人不尽相同，可根据phpinfo查询

三、php.ini配置

根据phpinfo找到 extension_dir的目录
（/etc/php.d/xhprof.ini）

添加一下内容：

extension=xhprof.so
xhprof.output_dir=/tmp/xhprof //xhprof的分析日志

四、重启服务

 sudo /etc/init.d/http restart

 查看phpinfo是否安装成功

五、使用方法

开头：
xhprof_enable(); //开启监测 
//xhprof_enable(xhprof_flags_no_builtins); 不记录内置的函数 
//xhprof_enable(xhprof_flags_cpu + xhprof_flags_memory); 同时分析cpu和mem的开销 

//要测试的代码
...
...
...

结尾：
$xhprof_data = xhprof_disable(); //停止监测，返回运行数据
$xhprof_root = '/（xhprof的虚拟主机目录）/'; 
 //引入当初安装到xhprof虚拟主机目录中的文件
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();  
$run_id = $xhprof_runs->save_run($xhprof_data, "xhprof");
echo '<a href="http://（xhprof的虚拟主机域名）/xhprof_html/index.php?run='.$run_id.'&source=xhprof" target="_blank">xhprof统计</a>'; 

　　上边的代码使用了，给xhprof设置虚拟主机的方法。

　　把源码包中的 xhprof_html 和 xhprof_lib 文件夹拷贝到自己建立的虚拟目录中

　　cp -r xhprof_html xhprof_lib /xxx/xhprof/  （此处目的是建立数据分析目录，可将此目录配置成虚拟主机访问）

　　运行后，统计点击返回的 xhprof统计 链接，即可。

六、注意问题以及名词解释

　　在显示的统计页面中，点[view full callgraph]图形化显示（最大的性能问题会用红色标出，其次是黄色）；

　　点击后，可能提示错误消息，执行以下命令即可

 yum install -y graphviz
 yum install graphviz-gd

　　名词解释

 

function name 函数名
 calls 调用次数
 calls% 调用百分比
 incl. wall time (microsec) 调用的包括子函数所有花费时间 以微秒算(一百万分之一秒)
 iwall% 调用的包括子函数所有花费时间的百分比
 excl. wall time (microsec) 函数执行本身花费的时间，不包括子树执行时间,以微秒算(一百万分之一秒)
 ewall% 函数执行本身花费的时间的百分比，不包括子树执行时间
 incl. cpu(microsecs) 调用的包括子函数所有花费的cpu时间。减incl. wall time即为等待cpu的时间
 减excl. wall time即为等待cpu的时间
 icpu% incl. cpu(microsecs)的百分比
 excl. cpu(microsec) 函数执行本身花费的cpu时间，不包括子树执行时间,以微秒算(一百万分之一秒)。
 ecpu% excl. cpu(microsec)的百分比
 incl.memuse(bytes) 包括子函数执行使用的内存。
 imemuse% incl.memuse(bytes)的百分比
 excl.memuse(bytes) 函数执行本身内存,以字节算
 ememuse% excl.memuse(bytes)的百分比
 incl.peakmemuse(bytes) incl.memuse的峰值
 ipeakmemuse% incl.peakmemuse(bytes) 的峰值百分比
 excl.peakmemuse(bytes) excl.memuse的峰值
 epeakmemuse% ememuse% 峰值百分比

xhprof的安装与简易用法

xhprof是facebook开源的轻量级php性能分析工具，linux环境下可以通过pecl直接安装，比如在ubuntu下仅需3行指令

pecl install xhprof-beta
echo "extension=xhprof.so" > /etc/php5/fpm/conf.d/xhprof.ini
service php5-fpm restart

之后可以通过phpinfo()检查扩展是否已经加载。

具体如何使用呢，xhprof项目中已经提供了示例以及简易的ui，下载xhprof项目到web服务器，假设可以通过访问，那么访问可以看到一些输出，并且提示通过访问http://<xhprof-ui-address>/index.php?run=xxx&source=xhprof_foo查看结果。接下来访问就可以看到已经保存的结果，列出了所有函数的调用以及所消耗的时间。

分析一下示例代码sample.php，关键部分只有2行：

//开启xhprof并开始记录
xhprof_enable();
//运行一些函数
foo();
//停止记录并取到结果
$xhprof_data = xhprof_disable();

$xhprof_data中记录了程序单步运行过程中所有的函数调用时间及cpu内存消耗等，具体记录哪些指标可以通过xhprof_enable的入口参数控制，之后的处理已经与xhprof扩展无关，大致是编写了一个存储类xhprofruns_default，将$xhprof_data序列化并保存到某个目录，可以通过xhprofruns_default(__dir__)将结果输出到当前目录，如果不指定则会读取php.ini配置文件中的xhprof.output_dir，仍然没有指定则会输出到/tmp。

xhprof_html/index.php将记录的结果整理并可视化，默认的ui里列出了：
•funciton name ： 函数名
•calls: 调用次数
•incl. wall time (microsec)： 函数运行时间（包括子函数）
•iwall%：函数运行时间（包括子函数）占比
•excl. wall time(microsec)：函数运行时间（不包括子函数）
•ewall%：函数运行时间（不包括子函数）

每一项应该不难理解，以项目自带的sample.php为例，示例中编写了一个main()函数，main()函数中调用foo()、bar()等一些子函数进行了一点字符处理。整个程序运行过程中，main()函数只运行了一次，并且由于main()函数中包括了所有的逻辑，所以main()函数的iwall%占比为100%，但是由于main()函数的功能都是由子函数实现的，因此main()函数的ewall%只有0.3%，而foo()函数完成了主要的工作，ewall%有98.1%。因此在分析更大型的程序时，往往需要根据这几项指标分别排序，从不同的角度审视性能消耗。

在xhprof_html/index.php中还可以看到[view full callgraph]链接，点击后可以绘制出一张可视化的性能分析图，如果点击后报错的话，可能是缺少依赖graphviz，ubuntu可以通过apt安装
apt-get install graphviz

更好的注入方式

了解了上面这些，其实就已经可以将xhprof整合到任何我们已有的项目中去了。目前大部分mvc框架都有唯一的入口文件，只需要在入口文件的开始处注入xhprof的逻辑

//开启xhprof
xhprof_enable(xhprof_flags_memory | xhprof_flags_cpu);
//在程序结束后收集数据
register_shutdown_function(function() {
  $xhprof_data    = xhprof_disable();

  //让数据收集程序在后台运行
  if (function_exists('fastcgi_finish_request')) {
    fastcgi_finish_request();
  }

  //保存xhprof数据
  ...
});

但是这样免不了要修改项目的源代码，其实php本身就提供了更好的注入方式，比如将上述逻辑保存为/opt/inject.php，然后修改php fpm配置文件

vi /etc/php5/fpm/php.ini

修改auto_prepend_file配置

auto_prepend_file = /opt/inject.php

这样所有的php-fpm请求的php文件前都会自动注入/opt/inject.php文件

如果使用nginx的话，还可以通过nginx的配置文件设置，这样侵入性更小，并且可以实现基于站点的注入。

fastcgi_param php_value "auto_prepend_file=/opt/inject.php";