README

inspector package for thinkphp.

Installing

$ composer require yangweijie/think-inspector -vvv

Usage

配置

key

在 https://docs.inspector.dev/ 注册后创建应用的 key 用于区分不同应用前后端应该也是独立应用

enable

是否启用监听

max_items

每个监听会话里允许添加的最大片段数。超过添加不进去

env

目前没用到计划用于区分不同环境的

single

是否区分不同url 命令

true 意味着启动监听时的path 是动态独立，然后 monitor 面版会通过这些path 去区分不同的监听分组

false web 请求 path 为 WEB 命令行为命令行这样方便查找监听记录只用在 WEB 或命令行里再按时间进行查看

注入

在本服务中向 app 注入了 inspector 对象 (自定义类) inspector 对象的 ins 属性是原始 inspector-apm 的对象

inspector 可以调用 inspector-apm 里 inspector 类的方法。

为了方便设置框架层的片段覆写了 startSegment 和 end 方法。

只需要 $this->app->inspector->startSegment('type', 'label'); 到需要结束时 $this->app->inspector->end('type'); 即可

当然如果你业务中手动添加监听的片段

也可以类似于库里 console 覆写 doRun 方法

$ret   = null;
$label = sprintf("运行【%s】命令", $input->getFirstArgument());
$this->inspector->addSegment(function () use ($input, $output, &$ret){
    // trace($input);
    $ret = parent::doRun($input, $output);  // 包裹自己的代码
}, 'runCmd', $label);

context

参考本库实现的

if($inspector->currentTransaction() && $inspector->currentTransaction() != null){
    $inspector->currentTransaction()->addContext('请求信息', $data);
}

同样上下文加入时会产生多个tab 最好不用 timeline 、url 、request 系统内置的。

命令行监听

目前命令行监听需要开启应用全局 Provid.php 里配置映射的类


<?php
use app\ExceptionHandle;
use app\Request;
use think\Inspector\Console;

// 容器Provider定义文件
return [
    'think\Console'          => Console::class,
    'think\exception\Handle' => ExceptionHandle::class,
    'think\Request'          => Request::class,
];

否则不生效，尝试服务 register 方法里 bind 无效。

事件

本库自定义了一个 AppInit 类动态绑定了框架的 AppInit

对于 web 应用会经过 AppInit、HttpRun、HttpEnd 等事件

请求信息在服务 boot 阶段就可以拿到就不需要在 HttpRun 里开启了。

web 中会多一个summary 信息显示请求耗时内存加载文件数量以前在trace 为 console 里看到的信息

并且 Db 事件记录了每条sql 的时间和原始执行语句方便后面根据 timeline 里长短来进行性能优化

而命令行不经过应用的事件只记录了加载全部命令和执行当前命令的时间

异常

开启后会上报不影响原有异常展示。并且可以切换当时的会话信息方便调试看请求参数

TODO

[x]测试tp5

Contributing

You can contribute in one of three ways:

File bug reports using the issue tracker.
Answer questions or fix bugs on the issue tracker.
Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT

yangweijie / think-inspector

Maintainers

Details