PHP 效能追蹤及分析工具（XHPROF）

NickDreamer發表於2019-02-16
PHP

什麼是 XHPROF？

XHPROF：Facebook 開源的輕量級PHP效能分析工具。

它報告函式級別的請求次數和各種指標，包括阻塞時間，CPU時間和記憶體使用情況。

XHProf分析報告有助於理解被執行的程式碼的結構，它有一個簡單的HTML的使用者介面（ PHP寫成的）。

基於瀏覽器的效能分析使用者介面能更容易檢視，或是與同行們分享成果。

也能繪製呼叫關係圖。

XHPROF 與 Xdebug 區別

Xdebug 是一個開放原始碼的PHP程式偵錯程式(即一個Debug工具)。

對於本地開發環境來說，進行效能分析 Xdebug 是夠用了。

但如果是線上環境的話，Xdebug 消耗較大，配置也不夠靈活。

如何安裝 XHPROF ？

//原始碼安裝
cd /usr/local/src
wget http://pecl.php.net/get/xhprof-0.9.4.tgz
tar zxvf xhprof-0.9.4.tgz
cd xhprof-0.9.4/extension/
/usr/local/php/bin/phpize
./configure --with-php-config=/usr/local/php/bin/php-config
make
make install

//在 php.ini 末尾新增
[xhprof]

extension = xhprof.so

xhprof.output_dir = 自定義資料夾(/tmp/xhprof_log)
// /tmp/xhprof_log 必須存在且有寫入許可權

//重啟環境

//程式碼中檢視 phpinfo 是否包含 xhprof。

//一切順利的話，那麼 xhprof 安裝成功。

如何配置 XHPROF？

//比如專案地址：local.test_xhprof.com
//在專案入口檔案中新增一下程式碼（CI框架為例）
xhprof_enable(XHPROF_FLAGS_NO_BUILTINS +
              XHPROF_FLAGS_CPU +
              XHPROF_FLAGS_MEMORY);

register_shutdown_function(function(){
    $data = xhprof_disable();   //返回執行資料
    //xhprof_lib 在下載的包裡存在這個目錄,記得將目錄包含到執行的php程式碼中
    include `/home/www/mi/xhprof/xhprof_lib/utils/xhprof_lib.php`;
    include `/home/www/mi/xhprof/xhprof_lib/utils/xhprof_runs.php`;
    $objXhprofRun = new XHProfRuns_Default();
    $objXhprofRun->save_run($data, "test"); //test 表示檔案字尾
});

//一切順利的話，那麼程式碼安裝成功。

//訪問：local.test_xhprof.com，應該在 /tmp/xhprof_log 存在日誌檔案。

如何 UI 展示？

//將 xhprof_html、xhprof_lib 拷貝到虛擬目錄中
cd /usr/local/src
cp xhprof-0.9.4/xhprof_html /home/www/mi/xhprof/xhprof_html
cp xhprof-0.9.4/xhprof_lib /home/www/mi/xhprof/xhprof_lib

配置虛擬主機(local.xhprof.com)

local.xhprof.com 指向 /home/www/mi/xhprof/ 即可。

訪問：local.xhprof.com/xhprof_html 會顯示日誌檔案。

如下圖：

PHP 效能追蹤及分析工具（XHPROF）

點選日誌檔案顯示下圖。

PHP 效能追蹤及分析工具（XHPROF）

點選 [View Full Callgraph] 會顯示呼叫關係圖。

在生成圖的時候需要伺服器裝一個外掛：graphviz。

cd /usr/local/src
wget http://www.graphviz.org/pub/graphviz/stable/SOURCES/graphviz-2.24.0.tar.gz
tar zxvf graphviz-2.24.0.tar.gz
cd graphviz-2.24.0
./configure
make
make install

//一切順利的話，那麼 graphviz 安裝成功。

如果點選 [View Full Callgraph] 依舊無法開啟。

報錯：failed to execute cmd ” dot -Tpng”

表示：php.ini 中一些執行函式禁用了。

在 php.ini 中 去掉 disable_functions 中的如下函式
system
shell_exec
proc_open
proc_get_status

PHP 重啟一下。

一切順利的話，應該不會報錯了，就可以看到高大上的效果圖啦。

PHP 效能追蹤及分析工具（XHPROF）

點選區域性，可以看到大圖。

以上，大家可以看到 函式級別的請求次數和各種指標，包括阻塞時間，CPU時間和記憶體使用情況。

如何更好的UI展示？

可能大家有一些疑問：

  1. 是否能有更好的UI展示？

  2. 當伺服器上有多個站點的時候，是否配置一次即可？

接下來給大家介紹：xhprof gui

xhprof gui : 一個xhprof的一個ui展現。

使 xhprof 介面更漂亮，功能更強大。

  • 友好的介面

  • 資料庫儲存（mysql）

  • 支援按請求百分比執行 xhprof 優化。

  • 降低伺服器負載。

如何配置 xhprof gui

原始碼地址：https://github.com/preinheime…

下載後存放到：xhprof_gui 檔案中。

配置虛擬主機(local.xhprofgui.com)

local.xhprofgui.com 指向 /home/www/mi/xhprof_gui/ 即可。

第一步，需要將 xhprof_gui/xhprof_lib/config.sample.php 重新命名 為 config.php。

第二步，根據 config.php 中資料庫變數(dbuser、dbpass、dbname)，配置一個資料庫。

第三步，將 config.php 中 doprofile 設定為 true。

第三步，建立一張表。

//原始碼：xhprof_lib/utils/xhprof_runs.php
CREATE TABLE `details` (
  `id` char(17) NOT NULL,
  `url` varchar(255) default NULL,
  `c_url` varchar(255) default NULL,
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
  `server name` varchar(64) default NULL,
  `perfdata` MEDIUMBLOB,
  `type` tinyint(4) default NULL,
  `cookie` BLOB,
  `post` BLOB,
  `get` BLOB,
  `pmu` int(11) unsigned default NULL,
  `wt` int(11) unsigned default NULL,
  `cpu` int(11) unsigned default NULL,
  `server_id` char(3) NOT NULL default `t11`,
  `aggregateCalls_include` varchar(255) DEFAULT NULL,
  PRIMARY KEY  (`id`),
  KEY `url` (`url`),
  KEY `c_url` (`c_url`),
  KEY `cpu` (`cpu`),
  KEY `wt` (`wt`),
  KEY `pmu` (`pmu`),
  KEY `timestamp` (`timestamp`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

如果是 Nginx 伺服器 新增配置：

fastcgi_param PHP_VALUE "auto_prepend_file=/home/www/mi/xhprof_gui/external/header.php";

如果是 Apache 伺服器：

php_admin_value auto_prepend_file "/home/www/mi/xhprof_gui/external/header.php"

配置到這裡，可以執行下。

簡單說明下：

如果你配置在公共的配置檔案中，那麼表示站點上所有的域名訪問都會進行日誌記錄。

如果你配置在單個域名的配置檔案中，表示只有訪問當前域名的時候回進入日誌記錄。

例如單個域名為：local.xh.test.com

如果報錯，可以除錯下 header.php。

以上配置，儲存使用的是Mysql。

儲存也可以使用MongoDB，大家可以研究下 ~

如果看到效果？

訪問 local.xh.test.com，記錄日誌。

訪問 local.xhprofgui.com，檢視效果。

效果圖，如下：

效果圖上傳失敗。

效果圖地址：https://ntaste.github.io/imag…

我本地為 nginx 環境，已經配置成功。

如果大家需要下載我配置的好的 xhprof_gui 類庫。

可以關注微信公眾號，回覆 “xhprof” 即可。

那麼問題來了，分析出效率低的地方如何進行調整？

有經驗的同學，可以留言哈 ~

Thanks ~

IT小圈兒

相關文章