使用PHP扩展Xhprof分析项目性能实践

最新推荐文章于 2021-04-02 10:54:33 发布

曲奇不可以吃

最新推荐文章于 2021-04-02 10:54:33 发布

阅读量703

点赞数

一、背景

项目即将上线，想通过一些工具来分析代码的稳定性和效率，想起在上个团队时使用过的xhprof扩展；因为换了新电脑，所以需要重新编译此扩展，现将安装与实际排查过程完整记录下来，方便自己回顾和帮助更多的读者。

二、操作步骤

安装扩展
配置扩展
测试分析

三、安装

xhprof扩展PHP并不自带，需要笔者去单独安装它，安装之后才能使用，笔者这里采用源码安装方式，安装过程如下

3.1 下载源码

xhprof在PHP的PECL官方上面已经比较老了，笔者的PHP版本为PHP7.1因此，需要在GitHub上下载xhprof上比较新的源码，参考命令如下

git clone https://github.com/longxinH/xhprof

3.2 检测环境

进入编译的文件夹，参考命令

cd xhprof/extension/

现在笔者需要编译一下源码，在编译之前可以使用phpze来探测PHP的环境，参考命令如下：

phpize

返回结果如下

Configuring for:
PHP Api Version:         20160303
Zend Module Api No:      20160303
Zend Extension Api No:   320160303

3.3 编译安装

生成 Makefile，为下一步的编译做准备

./configure

返回结果如下

creating libtool
appending configuration tag "CXX" to libtool
configure: creating ./config.status
config.status: creating config.h
config.status: config.h is unchanged

开始编译，并进行安装

make && make install

返回结果如下

Build complete.
Don't forget to run 'make test'.

Installing shared extensions:     /usr/local/Cellar/php@7.1/7.1.19/pecl/20160303/

从返回信息中可以看到已经安装完成，并显示了扩展文件存放的位置

四、配置

在编译安装源码之后，笔者还需要对PHP的配置文件夹以及xhprof的进行一些简单的配置，操作过程如下所示

4.1 找出配置文件位置

要修改PHP的配置首先需要知道配置文件在什么位置，这里可以通过PHP的命令来查看配置文件存放位置，参考命令如下：

php --ini

执行命令后，返回结果如下

Configuration File (php.ini) Path: /usr/local/etc/php/7.1
Loaded Configuration File:         /usr/local/etc/php/7.1/php.ini
Scan for additional .ini files in: /usr/local/etc/php/7.1/conf.d
Additional .ini files parsed:      /usr/local/etc/php/7.1/conf.d/ext-opcache.ini

在返回结果当中，可以看到多个配置文件的路径，笔者所需要的是第二个文件php.ini

查看扩展目录存放位置，参考命令如下

cat /usr/local/etc/php/7.1/php.ini | grep extension_dir

返回结果如下

extension_dir = "/usr/local/lib/php/pecl/20160303"
; extension_dir = "ext"
; Be sure to appropriately set the extension_dir directive.
;sqlite3.extension_dir =

4.2 修改配置

从返回的结果当中，可以看到扩展的存放目录位置如下

/usr/local/lib/php/pecl/20160303

现在需要将刚才编译好的xhprof扩展复制到该目录当中,参考命令如下

cp /usr/local/Cellar/php@7.1/7.1.19/pecl/20160303/xhprof.so/usr/local/Cellar/php@7.1/7.1.19/pecl/20160303/

通过vim编辑器编辑配置文件，参考命令如下

vim /usr/local/etc/php/7.1/php.ini

在配置文件尾部增加xhprof的配置，以及自定义一个用来保存xhprof生成的源文件参考配置如下

[xhprof]
extension=xhprof.so
xhprof.output_dir=/data/www/xhprof/save_output_dir

4.3 重启生效

保存好之后，笔者重启php-fpm让其配置生效，重启命令可以通过brew命令来查看，参考命令如下：

brew info php@7.1

在命令执行后，返回的信息中可以看到如下信息

To have launchd start php@7.1 now and restart at login:
  brew services start php@7.1
Or, if you don't want/need a background service you can just run:
  php-fpm

因此笔者构造的重启PHP-FPM命令如下：

brew services restart php@7.1

重启完成后，返回结果如下

Stopping `php@7.1`... (might take a while)
==> Successfully stopped `php@7.1` (label: homebrew.mxcl.php@7.1)
==> Successfully started `php@7.1` (label: homebrew.mxcl.php@7.1)

4.4 验证安装

现在验证xhprof扩展是否已经安装完成，参考命令如下

php -m | grep xhprof

命令执行后，安装扩展成功的返回结果将会显示xhprof，如下图所示

五、测试

经过上面的操作笔者已经成功的安装与配置，现在需要用PHP代码来进行验证xhprof的分析效果

5.1 创建虚拟主机

首先创建一个虚拟主机，让用户可以通过浏览器访问所访问，创建虚拟主机需要有一个根目录，并编辑nginx配置文件，具体操作如下：

5.1.1 创建项目目录

创建项目根目录，参考命令如下

mkdir -p /Users/song/mycode/work/test

创建成功之后，笔者需要将之前git拉下来的部分代码复制到项目根目录当中，参考命令如下

cp -r xhprof/xhprof_html /Users/song/mycode/work/test/
cp -r xhprof/xhprof_lib /Users/song/mycode/work/test/

5.1.2 编辑配置文件

添加配置文件,参考命令

/usr/local/etc/nginx/nginx.conf

添加配置文件如下

    server {
        listen       80;
        server_name  test.localhost;

        root   /Users/song/mycode/work/test;
        index  index.html index.htm index.php;
        
        location / {
            try_files $uri $uri/ /index.php?$query_string;
        }


        location ~ \.php$ {
            fastcgi_pass   127.0.0.1:9000;
            fastcgi_index  index.php;
            fastcgi_param  SCRIPT_FILENAME $document_root$fastcgi_script_name;
            include        fastcgi_params;
        }

    }

在/etc/hosts文件中增加入一行解析记录，记录内容如下:

127.0.0.1 test.localhost

5.2 新建测试代码

在git仓库的examples文件夹下，已经有了一份demo代码，不过这份代码的注释都是英文，而且排版方式也不易笔者自己理解，因此笔者重新编辑了此文件,参考步骤如下命令

使用vim新建一个PHP文件

vim /Users/song/mycode/work/test/test.php

在文件中加入以下代码

<?php

//加载所需文件
include_once "./xhprof_lib/utils/xhprof_lib.php";
include_once "./xhprof_lib/utils/xhprof_runs.php";

//随意定义一个函数
function test($max)
{
    for ($idx = 0; $idx < $max; $idx++) {
        echo '';
    }
}

//定义测试方法
function a()
{
    test(rand(1000,5000));
}

//开始分析
xhprof_enable();

//需要分析的函数
a();

//结束分析
$xhprof_data = xhprof_disable();
//实例化xhprof类
$xhprof_runs = new XHProfRuns_Default();
//获取当前当前页面分析结果
$run_id = $xhprof_runs->save_run($xhprof_data, "xhprof_foo");

echo "\nhttp://test.localhost/xhprof/xhprof_html/index.php?run=$run_id&source=xhprof_foo\n";

保存代码之后，通过浏览器访问对应的URL地址，URL地址如下所示

http://test.localhost/xhprof/test.php

5.3 结果分析

运行后结果，如下图

在页面中可以看到一个URL地址，复制并打开此URL地址之后，便能看到此代码的分析结果，如下图所示

在页面中有一个列表，展示了每一个方法所消耗的时间，如果觉得列表的方式表示不够清晰，点击页面中的 View Full Callgraph 链接可以直接生成一个图片，如下图所示

在图中很清晰的可以看到执行时间都消耗在test方法上，因此笔者可以针对这个方法进行针对性的优化。

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

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

flags 该参数用于为剖析结果添加额外的信息，该参数的值使用以下宏，如果需要提供多个值，使用|进行分隔。
- XHPROFFLAGSNO_BUILTINS 跳过所有的内置函数
- XHPROFFLAGSCPU 添加对CPU使用的分析
- XHPROFFLAGSMEMORY 添加对内存使用的分析
options 数组形式提供可选参数，在此处提供ignored_functions选项需要忽略的函数

有时会导致502错误，需要跳过所有的内置函数

xhprof_enable( XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

比如下面的例子，同时对内存和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，对内存的分析不会对系统造成太多负载。

分析一下示例代码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";

关于php.ini中的xhprof_output_dir，指定/data下的保存目录时，文件夹权限为777，文件写入保存失败，原因不明

指定/tmp下的保存目录时，文件夹权限为777，文件写入保存成功

各项分析参数释义

Function Name：方法名称。

Calls：方法被调用的次数。

Calls%：方法调用次数在同级方法总数调用次数中所占的百分比。

Incl.Wall Time(microsec)：方法执行花费的时间，包括子方法的执行时间。（单位：微秒）

IWall%：方法执行花费的时间百分比。

Excl. Wall Time(microsec)：方法本身执行花费的时间，不包括子方法的执行时间。（单位：微秒）

EWall%：方法本身执行花费的时间百分比。

Incl. CPU(microsecs)：方法执行花费的CPU时间，包括子方法的执行时间。（单位：微秒）

ICpu%：方法执行花费的CPU时间百分比。

Excl. CPU(microsec)：方法本身执行花费的CPU时间，不包括子方法的执行时间。（单位：微秒）

ECPU%：方法本身执行花费的CPU时间百分比。

Incl.MemUse(bytes)：方法执行占用的内存，包括子方法执行占用的内存。（单位：字节）

IMemUse%：方法执行占用的内存百分比。

Excl.MemUse(bytes)：方法本身执行占用的内存，不包括子方法执行占用的内存。（单位：字节）

EMemUse%：方法本身执行占用的内存百分比。

Incl.PeakMemUse(bytes)：Incl.MemUse峰值。（单位：字节）

IPeakMemUse%：Incl.MemUse峰值百分比。

Excl.PeakMemUse(bytes)：Excl.MemUse峰值。单位：（字节）

EPeakMemUse%：Excl.MemUse峰值百分比。