Weave Code
Profiler Dashboard Bundle Laravel Package
elao/profiler-dashboard-bundle
Symfony bundle that aggregates recent Symfony Profiler data (requests, timings, DB queries, etc.) into a single dashboard view, making it easier to compare and monitor performance across the last requests in dev/test environments.
This bundle compile metrics of last requests into one view.
Frequently asked questions about Profiler Dashboard Bundle
- Is this bundle compatible with Laravel 8/9/10, or only Symfony/Laravel 5.x?
- The bundle is officially designed for Symfony/Laravel 5.x and lacks native support for Laravel 8+. You’ll need to fork it, backport dependencies (like Symfony components), or use it as a reference for a custom solution. Test thoroughly, as core Laravel changes (e.g., service container) may break integration.
- How do I enable the profiler dashboard only in development, not production?
- The bundle follows Symfony’s pattern—register it conditionally in `config/app.php` under `APP_DEBUG` checks. For Laravel, wrap the bundle in a service provider’s `register()` method with `if (app()->environment('local'))` or use environment variables to toggle it. Avoid enabling it in production to prevent performance overhead.
- Can I store profiler metrics persistently (e.g., in a database) instead of session-only?
- By default, metrics are session-based and ephemeral. Extend the bundle by listening to its `ProfilerEvent` and saving data to a table (e.g., `profiler_metrics`). Example: Subscribe to the event in a service provider and use Eloquent or Query Builder to log metrics. Requires custom event handling code.
- Does this bundle conflict with Laravel Debugbar or Telescope?
- Yes, conflicts are likely if both tools profile DB queries (e.g., Debugbar’s `DB::enableQueryLog()` vs. this bundle’s Doctrine DBAL integration). Disable one or the other, or merge their data streams manually. Telescope offers broader features (e.g., job monitoring), so evaluate if this bundle’s aggregated view justifies the tradeoff.
- How do I customize the dashboard layout or add my own metrics?
- The dashboard uses Symfony’s Twig templates (located in the bundle’s `Resources/views/`). Override them by copying to `resources/views/bundles/elaoprofilerdashboard/` in your Laravel app. To add custom metrics, extend the bundle’s `ProfilerDataCollector` class and inject your logic via dependency injection or event listeners.
- What Laravel versions does this bundle *actually* work with, and what’s the risk?
- The bundle targets Laravel 5.x, but untested compatibility with Laravel 8+ exists due to Symfony component updates (e.g., HttpKernel changes). Risk: Breaking changes in Laravel’s service container or middleware pipeline. Test in a staging environment or use it as a reference for a custom profiler built with Laravel’s `Debugbar` or `Telescope`.
- Will this bundle slow down my production environment if accidentally enabled?
- The bundle is designed for dev/test environments and should have minimal overhead in production if disabled. However, even when inactive, it may register listeners or middleware. Always wrap its initialization in `APP_DEBUG` checks and monitor performance with tools like Blackfire to confirm negligible impact.
- Can I use this bundle in a Laravel microservice architecture?
- The bundle profiles individual requests but lacks distributed tracing or cross-service correlation. For microservices, pair it with tools like OpenTelemetry or Laravel’s `Horizon` for job monitoring. Use it per-service for local debugging, but avoid relying on it for end-to-end performance analysis.
- How do I set up alerts for slow requests (e.g., >500ms) in the dashboard?
- The bundle doesn’t natively support alerts, but you can extend it by adding a custom service that checks metrics during request completion. For example, create a middleware that logs slow requests to a table, then build a separate dashboard (e.g., with Laravel Nova) to visualize trends. Alternatively, integrate with Laravel’s `failed-job` monitoring for similar patterns.
- What’s the fallback if this bundle doesn’t work with my Laravel setup?
- Fallback options include: 1) Use Laravel Debugbar for lightweight profiling, 2) Implement a custom profiler with `Xdebug` + `KCacheGrind`, 3) Adopt Laravel Telescope for broader observability, or 4) Extract the bundle’s logic (e.g., metric aggregation) into a standalone package. Document your custom solution to avoid future dependency risks.
Weaver
How can I help you explore Laravel packages today?