README

Tracy Debugger integration and profiler for Mezzio applications.

Traccio wires Tracy into a Mezzio middleware pipeline and provides purpose-built debug bar panels for configuration, routes, HTTP requests, and SQL query profiling.

Requirements

Database profiling additionally requires a PhpDb adapter and the php-db/phpdb package.

Installation

composer require webware/traccio

If you are using the laminas-component-installer plugin it will prompt you to inject the ConfigProvider automatically. Otherwise add it manually (see Configuration).

Configuration

1. Register the ConfigProvider

Add Webware\Traccio\ConfigProvider to your application's config aggregator:

// config/config.php
use Laminas\ConfigAggregator\ConfigAggregator;
use Webware\Traccio\ConfigProvider;

$aggregator = new ConfigAggregator([
    ConfigProvider::class,
    // ... other providers
]);

2. Tracy settings

Create config/autoload/tracy.global.php (or add to an existing autoload file):

use Tracy\Debugger;

return [
    'debug' => true,

    Debugger::class => [
        'dumpTheme'  => 'dark',   // 'light' or 'dark'
        'keysToHide' => [
            'password',
            'pass',
            'secret',
        ],
        // Any public static property of Tracy\Debugger can be set here.
        // 'maxDepth'     => 10,
        // 'maxLength'    => 250,
        // 'showLocation' => true,
    ],
];

Set 'debug' => true or enable Mezzio development mode in config.

Middleware pipeline

Add the two middleware classes to your pipeline. TracyDebuggerMiddleware should come early so it initialises Tracy before your application logic runs. RequestPanelMiddleware should be placed very late in the pipeline so the final state of the Request is reflected in the panel (this is not required for Traccio to work).

// config/pipeline.php
use Webware\Traccio\Middleware\RequestPanelMiddleware;
use Webware\Traccio\Middleware\TracyDebuggerMiddleware;

$app->pipe(TracyDebuggerMiddleware::class);

// ... error handler, routing, ...

$app->pipe(RequestPanelMiddleware::class);

Debug panels

All panels are registered automatically when their dependencies are available in the container. No extra wiring is needed beyond the steps above.

SQL Profiler panel

The database panel groups identical queries together and displays:

• Summary bar — total queries, unique statements, total elapsed, slowest single query (all in ms)
• Per-group cards — execution count badge, SQL text, total / average timing
• Per-execution rows — wall-clock start time (H:i:s.mmm), elapsed ms, bound parameters

Parameter tokens reflect the style used in the original query:

Enabling database profiling

Database profiling requires:

1. A PhpDb adapter registered in the container as PhpDb\Adapter\AdapterInterface.
2. The ProfilingDelegator wrapping that adapter to attach a Profiler instance.

Enable the delegator in your application's config (it is commented out in ConfigProvider by default):

// config/autoload/development.local.php
use PhpDb\Adapter\AdapterInterface;
use Webware\Traccio\PhpDb\ProfilingDelegator;

return [
    'dependencies' => [
        'delegators' => [
            AdapterInterface::class => [
                ProfilingDelegator::class,
            ],
        ],
    ],
];

Once the delegator is active, the SQL panel will appear in the Tracy bar automatically whenever debug is true.

License

BSD-3-Clause — see LICENSE for details.