Weave Code
Debugbar Plugin Laravel Package
rainlab/debugbar-plugin
Integrates PHP Debug Bar into October CMS, giving developers an in-page toolbar with query logs, timings, memory usage, request data, and rendered partials to speed up debugging and performance tuning.
Integrates PHP Debugbar with October CMS
Frequently asked questions about Debugbar Plugin
- How do I install rainlab/debugbar-plugin in October CMS?
- Install it through the October CMS Marketplace or run composer require rainlab/debugbar-plugin, then enable the plugin in the backend. Once enabled, the PHP Debugbar toolbar appears on October CMS requests when debugging is active. Confirm the installed version matches your October CMS branch, since v3.2.0 is the first line claiming October v2.0 support.
- Does rainlab/debugbar-plugin work with plain Laravel without October CMS?
- No. This is an October CMS plugin, not a general-purpose Laravel package, and it is coupled to October's plugin lifecycle such as Plugin.php registration and the CMS theme and Twig layer. If you are on plain Laravel, use barryvdh/laravel-debugbar or Laravel Telescope instead. Evaluate this package only when your host application is an October CMS site.
- Which October CMS, Laravel, and PHP versions does v3.2.0 support?
- The v3.2.0 release note claims support for October CMS v1.0 (Laravel 5.5-era, PHP 7.x) and October CMS v2.0 (Laravel 9-era, PHP 8.0.2+). The note hedges with language like should remain compatible, so treat that as a claim rather than a guarantee. Check the repository's CI matrix and composer.json constraints to confirm the actual tested version floors before adopting.
- What debugging information does the toolbar show for October CMS requests?
- It renders an in-page toolbar with query logs, request timings, memory usage, request data, and the list of rendered partials. That combination is useful for spotting N+1 queries, slow partials, and memory spikes during performance tuning. It is the PHP Debugbar collectors applied to the October CMS request flow.
- Is it safe to leave PHP Debugbar enabled in production?
- No. Debugbar exposes request data, queries, and environment details in the response and adds measurable overhead, so it should be enabled only in local and staging environments. Drive it off app.debug or an explicit environment check instead of leaving it on unconditionally. Confirm the plugin's config or settings honor that switch before deploying.
- How do I conditionally enable or disable the Debugbar toolbar?
- Enable it only when debugging is warranted, typically tied to APP_DEBUG=true or a non-production environment. Check the plugin settings and any published config file for the exact toggle, and verify that disabling it removes the toolbar and collectors entirely. If no clean switch exists, guard the enablement with an environment check in your bootstrap.
- How is the dual October v1.0 and v2.0 support implemented and tested?
- The release note does not say whether the plugin uses a thin compatibility adapter or scattered runtime version branches, and that difference matters for long-term maintainability. Look for an adapter layer, a CI workflow that actually runs the suite against both October v1.0 and v2.0, and dependency constraints in composer.json. Run smoke tests on both branches yourself before committing to the upgrade.
- What is the upgrade path to v4.0, and will v3.x still receive security fixes?
- The maintainer has pre-announced that the next release becomes v4.0, which makes v3.x a bridge line with a finite lifespan. Ask for the deprecation list in writing, along with the v4 scope, target date, and whether v3.x gets security fixes after v4 ships. Budget a v4 migration in your adoption plan rather than treating v3.2.0 as a long-term pin.
- Does rainlab/debugbar-plugin ship database migrations or change my application data?
- Debug toolbars typically do not need migrations, and nothing in the v3.2.0 support-matrix note mentions schema changes. Still, verify by inspecting the plugin's updates directory and running the plugin update command on a staging copy before production. If any migration exists, confirm it is reversible on both October v1.0 and v2.0.
- What are the alternatives to rainlab/debugbar-plugin for October CMS and Laravel debugging?
- On plain Laravel, barryvdh/laravel-debugbar and Laravel Telescope are the standard choices, with Clockwork as a profiling alternative. On October CMS v2.0 (Laravel 9), Telescope can be wired in manually, and October's own event log and backend error reporting cover some of the same ground. This plugin remains the lowest-friction option if you want a drop-in toolbar across October v1.0 and v2.0.
Weaver
How can I help you explore Laravel packages today?