README

phpsoftbox/profiler — легкое ядро профилирования lifecycle приложения.

Компонент не знает внутренности Database, ORM, Router, Container и других пакетов. Он предоставляет общий runtime API, registry collectors и хранилища trace. Каждый компонент реализует свою интеграцию самостоятельно.

Базовое использование

use PhpSoftBox\Profiler\Profiler;
use PhpSoftBox\Profiler\ProfilerRegistry;
use PhpSoftBox\Profiler\Store\FileProfilerStore;

$registry = new ProfilerRegistry();
$profiler = new Profiler(
    enabled: true,
    store: new FileProfilerStore(__DIR__ . '/local/profiler'),
    registry: $registry,
);

$profiler->startTrace('http.request', 'http');

$profiler->span('shipment.sort', function () {
    // измеряемый участок
}, tags: ['shipment_id' => 123]);

$trace = $profiler->finishTrace();

Component extensions

Компоненты регистрируют collectors через ProfilerExtensionInterface.

$registry = new ProfilerRegistry();

foreach ($extensions as $extension) {
    $extension->register($registry);
}

Пример ожидаемых extensions:

• PhpSoftBox\Database\Profiler\DatabaseProfilerExtension;
• PhpSoftBox\Orm\Profiler\OrmProfilerExtension;
• PhpSoftBox\Container\Profiler\ContainerProfilerExtension;
• PhpSoftBox\Router\Profiler\RouterProfilerExtension;
• PhpSoftBox\Inertia\Profiler\InertiaProfilerExtension;
• PhpSoftBox\Cache\Profiler\CacheProfilerExtension;
• PhpSoftBox\Resource\Profiler\ResourceProfilerExtension.

HTTP middleware

use PhpSoftBox\Profiler\Middleware\ProfilerMiddleware;

$app->add(ProfilerMiddleware::class);

Middleware создает root trace http.request, добавляет X-Profile-Id и Server-Timing.

JSON API

Для dev-панели можно подключить ProfilerReportHandler:

use PhpSoftBox\Profiler\Http\ProfilerReportHandler;

$routes->get('/__profiler/api/traces', ProfilerReportHandler::class);
$routes->get('/__profiler/api/traces/{trace}', ProfilerReportHandler::class);

Handler возвращает 404, если профайлер выключен.

React debug panel

Backend должен отдать в Inertia shared props:

'profiler' => [
    'enabled'  => $profiler->enabled(),
    'trace_id' => $profiler->traceId(),
    'endpoint' => '/__profiler',
],

На frontend:

import { DebugProvider, ProfilerDebugPanel } from '@phpsoftbox/debug';

<DebugProvider profiler={page.props.profiler}>
    <App />
    <ProfilerDebugPanel />
</DebugProvider>

@phpsoftbox/debug читает report по trace_id, показывает timeline и компонентные sections: database, orm, container, router, inertia.