菜单开关

周梦康 发表于 2021-06-22 7394 次浏览 标签 : php原创Deliverer

前几日有位群友接手一段祖传代码,排查很久没有解决,准备提桶跑路,最终帮其解决,完整的过程见 https://mengkang.net/1470.html 但是最后代码的定位我有一些基于个人经验,实际调用的链路和我预计的不一样,都是靠猜。没有看到完整的调用链路,所以我想着需要一个工具来辅助明确查询到整个完整的调用链。

所以搞了这么个工具,主要是用于一些不熟悉的项目,而且日常环境不好复现的线上场景。

deliverer 祖传代码跑路拯救者 https://github.com/zhoumengkang/deliverer

如果你的项目不是那么糟糕,日常环境都 ok,那么熟悉一个项目最好的方式还是 xdebug,这个工具主要是排查线上问题。
类似的工具有 360 的 phptrace 实现原理上稍微有点不同

功能点

  • 可以根据函数名类名方法名路由来过滤输出
  • 可以在查询到指定过滤内容 n 次之后退出
  • 可以根据 request id 回放细看整个完整的调用链
  • 过滤的内容会高亮显示
  • 调用栈比较深的可以指定 -l 来隐藏深度调用的展示

原理

其实比较简单,分两步,第一步收集日志,第二步分析日志。

第一步

PHP_MINIT阶段,通过zend_set_user_opcode_handler 来设置对 ZEND_DO_UCALLZEND_DO_FCALL_BY_NAMEZEND_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


参数解释
-tAction::initUser过滤包含该调用的请求
-n3统计三次然后退出
-l5函数(方法)调用深度显示,最多显示 5 层,超出部分在末尾标出
$ ./bin/deliverer -v7979-1624369150991941

通过 -v requestId 来详细查看完整调用栈

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

当要查询方法,函数调用栈过深,不在层级查询范围之内,则其外层调用显示红色

PHP 祖传代码拯救者 Deliverer 他,来了!

todo

  1. 配置项优化
  2. 命令行和扩展联动配置
  3. 其他版本还未做兼容,本周跟上

原创博客,如需转载,请联系 i@mengkang.net
链接://mengkang.net/1473.html

评论列表