Deliverer 是一個 PHP 項目調度追蹤工具，主要用于線上故障排查。

使用場景

1. 如果你有一些老的 PHP （PHP5 和 PHP7）項目，對線上一個項目運行邏輯不熟悉；
2. 或者你對某個方法的調用來源不清楚；
3. 又或者線上有一個接口不知道是哪里異常退出了；
4. 還有線上調用特別耗時，都比較適合使用 Deliverer 來解決，幫助你避免跑路。

使用方法

• 可以根據函數名、類名、方法名、路由來過濾輸出
• 可以在查詢到指定過濾內容 n 次之后退出
• 可以根據 request id 回放細看整個完整的調用鏈
• 過濾的內容會高亮顯示
• 調用棧比較深的可以指定 -l 來隱藏深度調用的展示

原理

其實比較簡單，分兩步，第一步收集日志，第二步分析日志。

第一步

在PHP_MINIT階段，通過zend_set_user_opcode_handler?來設置對?ZEND_DO_UCALL?、ZEND_DO_FCALL_BY_NAME、ZEND_DO_FCALL?三類?opcode?的處理分析。

注意其中會涵蓋一些內置函數和方法的調用，我們可以通過類型進行過濾。

然后在PHP_RINIT階段新建日志文件，寫入請求的信息

pid-ts sapi http_method http_url

請求過程中在自定義的 handler 里面打印調用棧信息

最后在PHP_RSHUTDOWN關閉日志文件的寫入

第二步

對收集好的日志，利用bin/deliverer進行分析和整理，這塊是 php 腳本，就不贅述了。

安裝使用

下載

$ sudo wget http://github.com/zhoumengkang/deliverer/archive/refs/tags/1.0.4.zip
$ unzip 1.0.4.zip
$ rm -f 1.0.4.zip
$ cd deliverer-1.0.4/extension

編譯

$ whereis phpize
phpize: /usr/bin/phpize /usr/share/man/man1/phpize.1.gz

# 如果前面的路徑（/usr/bin）在環境變量里，也可以簡寫為 phpize，如果不太懂，直接復制執行
$ /usr/bin/phpize

$ whereis php-config
php-config: /usr/bin/php-config /usr/share/man/man1/php-config.1.gz

$ ./configure --with-php-config=/usr/bin/php-config
$ make && sudo make install

配置 php.ini

$ php -i|grep php.ini
Configuration File (php.ini) Path => /etc
Loaded Configuration File => /etc/php.ini

# 編輯 /etc/php.ini 文件
$ sudo vim /etc/php.ini
# 文件末尾增加以下兩行
[deliverer]
extension=deliverer.so

重啟 php-fpm

sudo service php-fpm restart

使用分析工具

可以移動./bin/deliverer到你覺得合適的目錄，假如在當前目錄

# 回到文件的解壓目錄，開啟監聽
$ cd ..
$ ./bin/deliverer -t

用一段我自己很久之前的祖傳代碼（我的博客）來跑下

$ ./bin/deliverer -t

這樣會一直監控所有的 php 進程的執行

$ ./bin/deliverer -tAction::initUser -n3 -l5

參數	值	解釋
-t	Action::initUser	過濾包含該調用的請求
-n	3	統計三次然后退出
-l	5	函數（方法）調用深度顯示，最多顯示 5 層，超出部分在末尾標出

$ ./bin/deliverer -v7979-1624369150991941

通過?-v?requestId?來詳細查看完整調用棧

$ ./bin/deliverer -tSqlExecute::getAll -n1 -l3

當要查詢方法，函數調用棧過深，不在層級查詢范圍之內，則其外層調用顯示紅色