php质量深入分析工具XHProf安装配备利用教程,xhprof扩展安装与使用

在XHProf扩展中,对PHP进行性能分析,xhprof,extension = xhprof.so

图片 10

XHProf是facebook 开发的一个测试php性能的扩展。

一、xhprof扩展安装步骤

xhprof是PHP的一个扩展,最好也直接安装上graphviz图形绘制工具(用于xhprof分析结果以直观的图形方式显示),废话不多说,直奔正题。

安装Xhprof扩展

1、安装

  • PHP5版本的安装

wget
tar -zxvf xhprof-0.9.4.tgz
cd xhprof-0.9.4
cd extension/
phpize
./configure
make
make install

  • PHP7版本的安装

unzip xhprof-php7.zip
cd xhprof-php7/extension/
phpize
./configure –with-php-config=/usr/local/php/bin/php-config
make
make install

$ wget
$ tar -zxvf xhprof-0.9.4.tgz
$ cd xhprof-0.9.4
$ cd extension/
$ phpize
$ ./configure
$ make
$ sudo make install

2、修改php.ini配置文件

在php.ini配置文件中追加下面配置,并创建目录/home/wwwroot/default/xhprof_data

[xhprof]
extension = xhprof.so
// xhprof分析结果文件存放根目录
xhprof.output_dir = /home/wwwroot/default/xhprof_data

修改php.ini

3、添加一个环境变量XHPROF_ROOT_PATH

为了后期每个项目都能使用xhprof来进行性能分析,建议给PHP加一个环境变量,这样之后,在任何项目代码里都可以很方便的调用xhprof来分析性能瓶颈,请执行如下操作:

vim /usr/local/php/etc/php-fpm.conf
env[XHPROF_ROOT_PATH]=/usr/local/php/include/xhprof/

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

4、将xhprof核心源代码复制到上述XHPROF_ROOT_PATH环境变量所指定的目录下

cp -r xhprof_lib /usr/local/php/include/xhprof/xhprof_lib

配置中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 ]] )

5、将下面两个目录复制到xhprof_data的同级目录下(最好都放到web根目录下)

查看分析结果文件有用,如下图所示:

图片 1

//执行
cp -r xhprof_html /home/wwwroot/default/xhprof_html
cp -r xhprof_lib /home/wwwroot/default/xhprof_lib

//改变xhprof_data目录拥有者,为了浏览器访问时能在xhprof_data目录下写入文件
chown -R www:www xhprof_data

flags
该参数用于为剖析结果添加额外的信息,该参数的值使用以下宏,如果需要提供多个值,使用|进行分隔。
XHPROF_FLAGS_NO_BUILTINS 跳过所有的内置函数
XHPROF_FLAGS_CPU 添加对CPU使用的分析
XHPROF_FLAGS_MEMORY 添加对内存使用的分析
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’
        ]
    ]
);

6、访问xhprof根目录

配置demo.com域名根目录为/home/wwwroot/default/,则可访问如下链接查看xhprof结果分析根目录,如下图所示:

图片 2

// 这里是PHP代码,比如业务逻辑实现等要被分析的代码部分
….

7、形象化的查看分析结果

安装图形绘制工具,后面的分析结果可以通过该工具以图形显示,更直观
执行安装命令:yum install graphviz

$xhprofData = xhprof_disable();// $xhprofData是数组形式的分析结果
print_r($xhprofData);

二、xhprof的使用

注意,如果使用XHPROF_FLAGS_CPU选项对CPU占用也进行分析,在Linux环境下,会造成比较高的系统负载,因此不建议使用,而推荐只使用XHPROF_FLAGS_MEMORY,对内存的分析不会对系统造成太多负载。
形象化的查看分析结果
使用xhprof_disable完成性能分析并且获取到分析结果之后,我们通常不会直接输出结果,因为这样的结果是以数组形式组织的,看起来并不直观,幸运的是,xhprof提供了基于web的图形界面对分析结果进行查看。
在使用之前,请先确保服务器安装了graphviz工具,否则在生成监控图表的时候回出现以下错误:
failed to execute cmd: ” dot -Tpng”. stderr: `sh: dot: command not
found ‘

1、xhprof性能分析小demo

下面写的三种方式实现阶乘的代码

<?php

xhprof_enable(XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

$n = 5;

echo jc($n);
echo ‘<br>’;

echo jc($n);
echo ‘<br>’;

echo jc($n);
echo ‘<br>’;

function jc($n){
    if($n == 1){
        return 1;
    }
   
    return $n * jc($n-1);
}

function jc2($n){
    $m = 1;
    for($i=1; $i<=$n; $i++){
        $m = $m * $i;
    }
   
    return $m;
}

function jc3($n){
    $arr = [];
    $arr[1] = 1;
   
    for($i = 2; $i<=$n; $i++){
        $arr[$i] = $i * $arr[$i-1];
    }
   
    return $arr[$n];
}

$data = xhprof_disable();
//$_SERVER[‘XHPROF_ROOT_PATH’] 这就是第三步添加的那个环境变量
include_once $_SERVER[‘XHPROF_ROOT_PATH’] .
“xhprof_lib/utils/xhprof_lib.php”;
include_once $_SERVER[‘XHPROF_ROOT_PATH’] .
“xhprof_lib/utils/xhprof_runs.php”;
$x = new XHProfRuns_Default();

//拼接文件名
$xhprofFilename = date(‘Ymd_His’);

//print_r($data);die;//此处的打印数据看起来非常不直观,所以需要安装yum
install graphviz 图形化界面显示,更直观
$x->save_run($data, $xhprofFilename);

上述小demo执行后,会在xhprof_data目录下生成一个分析结果保存文件,网页端访问结果文件,如下图:
图片 3

图片 4

当我在点[View Full Callgraph]查看图形分析界面时,问题出现了,如下图:
图片 5
好在网上查到原因是,php配置文件中有个disable_functions禁用函数列表,把里面的proc_open去掉即可。

图形分析结果显示如下
图片 6

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

2、实际项目中该如何引入xhprof

请参考如下截图所示引入思路(在项目控制器基类构造方法和析构方法里做手脚),思路技巧仅供学习参考,如下图:

图片 7
下面是我在项目(以Yii2为框架)下引入xhprof代码一览

<?php
namespace backend\component;

use Yii;
use common\component\baseController;

class backendBaseController extends baseController
{
    public $layout = “/content”;
    public $enableCsrfValidation = false;

    public static $profiling = 0;

    public function init(){
        parent::init();
       
        self::$profiling = 1;// !(mt_rand() % 9);
        if  (self::$profiling) {
            xhprof_enable(XHPROF_FLAGS_CPU |
XHPROF_FLAGS_MEMORY);
        }
    }

    public function __destruct()
    {
        if(self::$profiling){
            $data = xhprof_disable();
            //$_SERVER[‘XHPROF_ROOT_PATH’] 该环境变量由第3步得来
            include_once $_SERVER[‘XHPROF_ROOT_PATH’] .
“/xhprof_lib/utils/xhprof_lib.php”;
            include_once $_SERVER[‘XHPROF_ROOT_PATH’] .
“/xhprof_lib/utils/xhprof_runs.php”;
            $x = new XHProfRuns_Default();

            //当前路由
            $routeName = Yii::$app->requestedRoute;
            //路由为空,则说明是首页
            if (empty($routeName)){
                $routeName = Yii::$app->defaultRoute;
            }

            //拼接xhprof分析结果保存文件名
            $xhprofFilename = str_replace(‘/’, ‘_’,
$routeName).’_’.date(‘Ymd_His’);
            $x->save_run($data, $xhprofFilename);
        }
    }
}

$ sudo yum install graphviz

总结

xhprof是一个分析PHP代码性能瓶颈,提高PHP代码效率的有利工具,通过xhprof,可以看到代码慢在哪里,哪里还有优化的空间等等。

最后分享一个关于xhprof不错的资料,可以到Linux公社资源站下载:

——————————————分割线——————————————

免费下载地址在

用户名与密码都是www.linuxidc.com

具体下载目录在 /2018年资料/8月/28日/xhprof扩展安装与使用/

下载方法见
http://www.linuxidc.com/Linux/2013-07/87684.htm

——————————————分割线——————————————

Linux公社的RSS地址:

本文永久更新链接地址

图片 8

由于分析结果的查看工具是基于web的,因此,我们需要将xhprof安装包中的xhprof_html和xhprof_lib目录放到服务器的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,因此访问地址为.
当然,配置好环境之后,我们还是获取不到分析结果的,因为我们在代码中并没有将分析结果保存到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 ” . $runId .
‘&source=xhprof_test’;

 

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

图片 9

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

图片 10

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