tobento / app-profiler

App profiler.

Maintainers

Details

github.com/tobento-ch/app-profiler

1.0.2 2024-12-07 16:06 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT b7b1d8342d825e8d27246a2201d562fcf8bf52fc

Tobias Strub <info.woop@tobento.ch>

package profiler app tests tobento

1.x-dev
1.0.2
1.0.1
1.0.0

This package is auto-updated.

Last update: 2024-12-07 16:07:44 UTC

README

The profiler is a development tool that gives detailed information about the execution of a HTTP request or console commands if enabled in the config file.

Table of Contents

Getting Started
- Requirements
Documentation
Credits

Getting Started

Add the latest version of the app profiler project running this command.

composer require tobento/app-profiler

Requirements

PHP 8.0 or greater

Documentation

App

Check out the App Skeleton if you are using the skeleton.

You may also check out the App to learn more about the app in general.

Profiler Boot

The profiler boot does the following:

installs and loads profiler config file
implements interfaces based on config
adds collectors based on config
boots late profiler boot
on response emit collects data from collectors and may inject the profiler toolbar

use Tobento\App\AppFactory;

// Create the app
$app = (new AppFactory())->createApp();

// Add directories:
$app->dirs()
    ->dir(realpath(__DIR__.'/../'), 'root')
    ->dir(realpath(__DIR__.'/../app/'), 'app')
    ->dir($app->dir('app').'config', 'config', group: 'config')
    ->dir($app->dir('root').'public', 'public')
    ->dir($app->dir('root').'vendor', 'vendor');

// Adding boots:
$app->boot(\Tobento\App\Profiler\Boot\Profiler::class);
// ...

// Run the app:
$app->run();

Profiler Config

The configuration for the profiler is located in the app/config/profiler.php file at the default App Skeleton config location where you can configure your profiler for your application.

Profiles

The profiler will inject a toolbar from the current profile into HTML responses only. Any AJAX requests will update the profiles selection in the toolbar where you can switch between them.

For other kinds of contents such as JSON responses, use the profiles page. Just browse the the /profiler/profiles URL to see all profiles.

Available Collectors

By default, all collectors are defined in the Profiler Config. Even if they are set, they will only collect data if the service they collect data from are installed. But you may uncomment the collector if not needed at all.

Boots Collector

This collector will show the currently booted boots in the order they were called as well as all registered boots.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Boots::class,
],

Events Collector

If you have booted the App Event - Event Boot, this collector will show the currently dispatched events and listeners.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Events::class,
],

Jobs Collector

If you have booted the App Queue - Queue Boot, this collector will show the currently pushed jobs.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Jobs::class,
],

Logs Collector

If you have booted the App Logging - Logging Boot, this collector will show the currently logged messages from each logger specified.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Logs::class,
    
    // or
    \Tobento\App\Profiler\Collector\Logs::class => [
        // specify the logger names not to collect messages from:
        'exceptLoggers' => ['null'],
    ],
],

Middleware Collector

If you have booted the App Http - Middleware Boot, this collector will show the currently dispatched middlewares as well as the available aliases.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Middleware::class,
],

Request And Response Collector

If you have booted the App Http - Http Boot, this collector will show the current request and response data.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\RequestResponse::class,
],

Routes Collector

If you have booted the App Http - Routing Boot, this collector will show all registered routes.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Routes::class,
],

Session Collector

If you have booted the App Http - Session Boot, this collector will show all session data.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Session::class,
    
    // or:
    \Tobento\App\Profiler\Collector\Session::class => [
        // specify the data you wont't to hide:
        'hiddens' => [
            '_session_flash_once',
            '_session_flash.old',
        ],
    ],
],

Storage Queries Collector

If you have booted the App Database - Database Boot, this collector will show all queries executed from any Storage Databases configured.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\StorageQueries::class,
],

Translation Collector

If you have booted the App Translation - Translation Boot, this collector will show all missed translations.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\Translation::class,
],

View Collector

If you have booted the App View - View Boot, this collector will show the currently rendered views and assets.

In the app/config/profiler.php file:

'collectors' => [
    \Tobento\App\Profiler\Collector\View::class,
    
    // or you may configure only the data to collect:
    \Tobento\App\Profiler\Collector\View::class => [
        'collectViews' => true,
        'collectAssets' => false,
    ],
],

Creating A Collector

You may create your own data collector by implementing the Tobento\App\Profiler\Collector\CollectorInterface or the Tobento\App\Profiler\Collector\LateCollectorInterface.

By implementing the CollectorInterface, the collector class will be created after the profiler gets booted, whereas the class implementing the LateCollectorInterface will be created after the late profiler boot gets booted.

I recommend investing the available collectors for its implementation.

Credits