PHPackages toastnz/silverstripe-debugbar - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. toastnz/silverstripe-debugbar ActiveSilverstripe-vendormodule toastnz/silverstripe-debugbar ============================= DebugBar for SilverStripe CMS 2.0.3(7y ago)31MITPHPPHP >=5.6 Since Oct 20Pushed 5y agoCompare [ Source](https://github.com/toastnz/silverstripe-debugbar)[ Packagist](https://packagist.org/packages/toastnz/silverstripe-debugbar)[ RSS](/packages/toastnz-silverstripe-debugbar/feed)WikiDiscussions master Synced 2d ago READMEChangelogDependencies (8)Versions (17)Used By (0) SilverStripe DebugBar module ============================ [](#silverstripe-debugbar-module) [![Build Status](https://camo.githubusercontent.com/e10e9f4225100fb1700ed57a32ddae65af649b8c2f4405cc818a574fcf74fc68/68747470733a2f2f7472617669732d63692e6f72672f6c656b6f616c612f73696c7665727374726970652d64656275676261722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/lekoala/silverstripe-debugbar/)[![scrutinizer](https://camo.githubusercontent.com/de9208f632daf78a51ae26b2384d6892fc8b16515bb57da5268b9d6be2b58f29/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6c656b6f616c612f73696c7665727374726970652d64656275676261722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/lekoala/silverstripe-debugbar/)[![Code coverage](https://camo.githubusercontent.com/d3286f591f0d17143d7a5df6755985f428800abb04f1b67da9b69873b863dab8/68747470733a2f2f636f6465636f762e696f2f67682f6c656b6f616c612f73696c7665727374726970652d64656275676261722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/lekoala/silverstripe-debugbar) Requirements ------------ [](#requirements) - SilverStripe ^4.0 - [maximebf/php-debugbar](http://phpdebugbar.com) - [jdorn/sql-formatter](https://github.com/jdorn/sql-formatter) Installation ------------ [](#installation) You can install the debug bar with Composer: ``` composer require --dev lekoala/silverstripe-debugbar ``` --- Documentation ------------- [](#documentation) - [Introduction](#introduction) - [Execution timeline](#execution-timeline) - [Database profiling](#database-profiling) - [System logs and messages](#system-logs-and-messages) - [Template use](#template-use) - [Partial caching hits and misses](#partial-caching-hits-and-misses) - [Environment and other information](#environment-and-other-information) - [Helper methods](#helper-methods) - [Configuration options](#configuration-options) - [Troubleshooting](#troubleshooting) ### Introduction [](#introduction) SilverStripe Debug Bar is a wrapper for [PHP DebugBar](http://phpdebugbar.com) which integrates with SilverStripe to provide more useful information about your projects. The Debug Bar can help you to easily identify performance issues, analyse environment settings and discover which parts of your code are being used. For example, if your application is running the same database query multiple times in a loop, or a certain controller action is taking a long time to run, Debug Bar will highlight these bottlenecks so you can take steps to improve your overall site performance. This module will: - Log framework execution based on available hooks - Log and profile database calls - Show all SilverStripe log entries - Show all session, cookie, requirements, SiteConfig and request data - Show current locale, framework/CMS version, current member - Show request timing/profiling and memory consumption The DebugBar is automatically injected into any HTML response through the `DebugBarMiddleware`, and will only run in "dev" mode. [![Screenshot](docs/_images/screenshot.png)](docs/_images/screenshot.png) ### Execution timeline [](#execution-timeline) The execution timeline ("Timeline" tab) provides you with a graphical overview of each controller and action, listing how long it takes for each to complete. [![Execution timeline](docs/_images/timeline.png)](docs/_images/timeline.png) The example above is from loading a page in the CMS. ### Database profiling [](#database-profiling) The "Database" tab allows you to view a list of all the database operations that a page request has made, and will group duplicated queries together. This can be useful to identify areas where performance can be improved, such as using `DataObject::get_by_id()` (which caches the result) instead of `DataObject::get()->byID()`. [![Database profiling](docs/_images/database.png)](docs/_images/database.png) By clicking on one of the duplicate group badges in the bottom right corner, you can see groups of duplicated queries: [![Duplicate grouping](docs/_images/database-duplicates.png)](docs/_images/database-duplicates.png) To help you in debugging and optimising your application, it is recommended to leave the `find_source` option on. This will help you to identify what triggers the query and where to implement caching appropriately. If you are using `?showqueries=1`, you will also see that the usage has been optimised to display all queries nicely and their result on the page. Also remember that if you use [the `d()` helper](helpers.md), any string variable with "sql" in the name will be formatted as a SQL string. #### Long running queries [](#long-running-queries) When some queries take a long time to run they will be highlighted in red, with the request time (right hand side per item) highlighted in bold red text. The threshold for this time can be adjusted by modifying the `DebugBar.warn_dbqueries_threshold_seconds` [configuration](configuration.md) setting. [![Long running queries](docs/_images/database-long-running.png)](docs/_images/database-long-running.png) **Note:** The above example has been adjusted to be deliberately short. The default threshold value is one second for a long running query. #### Large numbers of queries [](#large-numbers-of-queries) If a page request performance is more than a certain number of queries, a warning message will be sent to the "Messages" tab. You can adjust the threshold for this with the `DebugBar.warn_query_limit` configuration setting. [![Query threshold warning](docs/_images/database-query-threshold.png)](docs/_images/database-query-threshold.png) ### System logs and messages [](#system-logs-and-messages) The "Messages" tab will show you a list of anything that has been processed by [a SilverStripe logger](https://docs.silverstripe.org/en/4/developer_guides/debugging/error_handling/) during a page execution: [![System logs and messages](docs/_images/messages.png)](docs/_images/messages.png) You can filter the list by type by clicking on one of the log level buttons in the bottom right corner. **Note:** At times, other DebugBar components may also send messages to this tab. ### Template use [](#template-use) The "Templates" tab will show you how many template calls were made, and the file path relative to the project root directory for each. This will only be populated when you are flushing your cache (`?flush=1`). When templates are cached, a notice will be displayed letting you know to flush to see the full list. [![Templates](docs/_images/templates.png)](docs/_images/templates.png) ### Partial caching hits and misses [](#partial-caching-hits-and-misses) The "TemplateCache" tab shows how effective your chosen partial cache key is (e.g. `...`). It does this by indicating whether a key has hit a cache or not. [![Partial caching](docs/_images/templateCache.png)](docs/_images/templateCache.png) ### Environment and other information [](#environment-and-other-information) There is a variety of other useful information available via various tabs and indicators on the debug bar. See the screenshot below, and the arrows explained in order from left to right: [![Other indicators](docs/_images/other.png)](docs/_images/other.png) #### Tabs [](#tabs) - **Session:** Displays a list of everything in your current SilverStripe session - **Cookies:** Displays a list of all cookies available in a request - **Parameters:** Displays all GET, POST and REQUEST parameters from the current request - **Config:** Displays a list of the current [SiteConfig](https://github.com/silverstripe/silverstripe-siteconfig) settings from the CMS - **Requirements:** Shows a list of all [`Requirements`](https://docs.silverstripe.org/en/developer_guides/templates/requirements/) calls made during a page's execution #### Indicators [](#indicators) Hover over indicators to see: - **Locale:** The locale currently being used in the site - **Version:** The current SilverStripe software version being used - **User:** The name of the user currently logged in - **Memory usage:** The amount of memory used to generate a page - **Request time:** The total time to generate a page (see below) ##### Request time [](#request-time) The request time indicator shows you how long it took for the server to render a page, it doesn't include the time your browser takes to render it. You can use browser consoles to profile this aspect. - For a regular page load, the request time will have a green underline to indicate a healthy speed - For a slower page load, the request time will have an orange underline to indicate that it took longer than it perhaps should have, but is still OK - For a long page load, the request time will have a red underline to indicate that it is potentially dangerously slow The threshold for a dangerously slow page load can be configured with the `DebugBar.warn_request_time_seconds` [configuration](configuration.md) setting. The threshold for a slower/warning level indicator is defined as a percentage of the dangerous threshold (by default, 50%). This can be adjusted by modifying the `DebugBar.warn_warning_ratio` configuration setting. ### Helper methods [](#helper-methods) #### Quick debugging [](#quick-debugging) The `d()` function helps you to quickly debug code. It will use the [Symfony VarDumper](https://github.com/symfony/var-dumper) to display the data in a "pretty" way. In an XHR/AJAX context, it will simply display the data in a more simple fashion. When `d()` is called without arguments, it will display all objects in [the debug backtrace](http://php.net/manual/en/function.debug-backtrace.php). It will display the variable name before its content to make it easy to identify data amongst multiple values. ``` d($myvar, $myothervar); ``` Any call to `d()` with "sql" in the name of the variable will output a properly formatted SQL query, for instance: ``` d($myDataList->sql()); ``` #### Quick logging [](#quick-logging) The `l()` function helps you to log messages, and since they will appear in the "Messages" tab, it is very useful. ``` l('My message'); ``` ### Configuration options [](#configuration-options) Wherever possible, features and settings have been made configurable. You can see a list of the default configuration settings by looking at `_config/debugbar.yml`. To modify any of these settings you can define a YAML configuration block in your `mysite/_config` folder, for example: **mysite/\_config/debugbar.yml:** ``` --- Name: mysitedebugbar --- LeKoala\DebugBar\DebugBar: enabled_in_admin: false query_limit: 500 ``` #### Settings [](#settings) SettingTypeDescription`enable_storage`boolStore all previous request in the temp folder (enabled by default)`auto_debug`boolAutomatically collect debug and debug\_request data (disabled by default)`ajax`boolAutomatically inject data in XHR requests (disabled by default, since this makes the Chrome request inspector very slow due to the large amount of header data)`force_proxy`boolAlways use the database proxy instead of built in PDO collector (enabled by default)`check_local_ip`boolDo not display the DebugBar if not using a local ip (enabled by default)`find_source`boolTrace which file generates a database query (enabled by default)`enabled_in_admin`boolenable DebugBar in the CMS (enabled by default)`include_jquery`boolLet DebugBar include jQuery. Set this to false to include your own jQuery version`query_limit`intMaximum number of database queries to display (200 by default for performance reasons)`warn_query_limit`intNumber of database queries before a warning will be displayed`performance_guide_link`stringWhen a warning is shown for a high number of DB queries, the following link will be used for a performance guide`warn_dbqueries_threshold_seconds`intThreshold (seconds) for how long a database query can run for before it will be shown as a warning`warn_request_time_seconds`intThreshold (seconds) for what constitutes a *dangerously* long page request (upper limit)`warn_warning_ratio`floatRatio to divide the warning request time by to get the *warning* level (default 0.5)`show_namespace`boolShow the fully qualified namespace in the Database tab when set to true. Defaults to false`config_collector`boolShow the config tab. Defaults to true`partial_cache_collector`boolShow the partial cache tab. Defaults to true`email_collector`boolShow the email tab. Defaults to true#### Disabling the debug bar [](#disabling-the-debug-bar) You can disable the debug bar with PHP or configuration: ``` putenv('DEBUGBAR_DISABLE=true'); ``` ``` LeKoala\DebugBar\DebugBar: disabled: true ``` ### Troubleshooting [](#troubleshooting) #### Using Vagrant [](#using-vagrant) If you are using Vagrant (or presumably Docker or other virtualisation) and the DebugBar isn't showing up, make sure you have the `check_local_ip` config option set to `false`. This is due to the way Vagrant and Virtualbox configure networking by default. #### Managing jQuery [](#managing-jquery) The DebugBar will include its own version of jQuery by default. It will only be disabled in the admin (which already use jQuery). If you have added jQuery in your requirements (filename must be jquery.js or jquery.min.js), the DebugBar will not load its own jQuery version. You can also set the following configuration flag to false to prevent the DebugBar from including its own jQuery. ``` LeKoala\DebugBar\DebugBar: include_jquery: false ``` If you are including jQuery yourself, it is expected you include it in `Page::init()`. Below is an example of how to the jQuery which ships with the framework: ``` protected function init() { parent::init(); Requirements::javascript('framework/thirdparty/jquery/jquery.min.js'); } ``` #### A quick note about the Security Page [](#a-quick-note-about-the-security-page) `LeKoala\DebugBar\Extension\ControllerExtension` will include for you all the required assets for DebugBar. This is done using the `onAfterInit` extension hook, however on the `Security` controller the `onAfterInit` is called before your `init()`method in the `PageController`. Since you need to add jQuery before DebugBar this may be a problem, and therefore requirements will NOT be included on the `Security` controller. If you want DebugBar to work on the `Security` controller, make sure to include all relevant requirements by calling `DebugBar::includeRequirements();` after you include jQuery. When DebugBar is disabled this call will be ignored. Also note that any subsequent call to this method will be ignored as well. --- Maintainer ---------- [](#maintainer) LeKoala - License ------- [](#license) This module is licensed under the [MIT license](LICENSE). ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community14 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 57% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~95 days Recently: every ~136 days Total 16 Last Release 2065d ago Major Versions 0.1.1 → 1.0.02017-07-11 1.1.0 → 2.0.0-beta12017-12-05 1.x-dev → 2.0.32019-04-05 PHP version history (4 changes)0.1.0PHP >=5.4.8 1.0.0PHP >=5.3.3 2.0.0-beta1PHP >=5.6 1.2.x-devPHP >=5.5 ### Community Maintainers ![](https://www.gravatar.com/avatar/df607b08f1e079b3bda7faf13d886ddbdb2b9f1e2e84fb646f953acbf787b152?d=identicon)[intotheweb101](/maintainers/intotheweb101) --- Top Contributors [![lekoala](https://avatars.githubusercontent.com/u/250762?v=4)](https://github.com/lekoala "lekoala (166 commits)")[![robbieaverill](https://avatars.githubusercontent.com/u/5170590?v=4)](https://github.com/robbieaverill "robbieaverill (106 commits)")[![sachajudd](https://avatars.githubusercontent.com/u/24258161?v=4)](https://github.com/sachajudd "sachajudd (6 commits)")[![Firesphere](https://avatars.githubusercontent.com/u/680570?v=4)](https://github.com/Firesphere "Firesphere (3 commits)")[![wernerkrauss](https://avatars.githubusercontent.com/u/1043925?v=4)](https://github.com/wernerkrauss "wernerkrauss (2 commits)")[![pine3ree](https://avatars.githubusercontent.com/u/3229979?v=4)](https://github.com/pine3ree "pine3ree (2 commits)")[![andrewandante](https://avatars.githubusercontent.com/u/9702648?v=4)](https://github.com/andrewandante "andrewandante (2 commits)")[![raissanorth](https://avatars.githubusercontent.com/u/14869519?v=4)](https://github.com/raissanorth "raissanorth (1 commits)")[![intotheweb101](https://avatars.githubusercontent.com/u/6877909?v=4)](https://github.com/intotheweb101 "intotheweb101 (1 commits)")[![JakubDolba](https://avatars.githubusercontent.com/u/45079648?v=4)](https://github.com/JakubDolba "JakubDolba (1 commits)")[![fspringveldt](https://avatars.githubusercontent.com/u/10938392?v=4)](https://github.com/fspringveldt "fspringveldt (1 commits)") --- Tags debugbarsilverstripecmsmodule ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/toastnz-silverstripe-debugbar/health.svg) ``` [![Health](https://phpackages.com/badges/toastnz-silverstripe-debugbar/health.svg)](https://phpackages.com/packages/toastnz-silverstripe-debugbar) ``` ### Alternatives [silverstripe/cms The SilverStripe Content Management System 5163.4M1.3k](/packages/silverstripe-cms)[lekoala/silverstripe-debugbar DebugBar for SilverStripe CMS 55243.0k1](/packages/lekoala-silverstripe-debugbar)[silverstripe/mfa Enable multi-factor authentication with fallback codes 10346.1k8](/packages/silverstripe-mfa)[axyr/silverstripe-adminlogin Use a custom login screen to log in to the admin section 165.8k](/packages/axyr-silverstripe-adminlogin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)