Smile Debug Toolbar for Magento 2

Description

This module adds a Debug Toolbar in Magento 2.
The toolbar displays useful information about the last executions (including ajax requests, rest API and graphql):

• HTTP Request/response
• SQL queries (with the PHP trace for each query)
• Profiler information (with timers)
• Layout information
• Cached items
• Plugins/observers that were triggered

[image: image]

Installation

To install the module:

1. Execute the following command at the root of the Magento installation:

   composer require --dev smile/module-debug-toolbar
   

2. Enable the module:

   bin/magento module:enable Smile_DebugToolbar
   bin/magento setup:upgrade
   

3. Enable the toolbar:

   bin/magento config:set smile_debugtoolbar/configuration/enabled 1
   

Configuration

The configuration of the module is available in the section Smile > Smile DebugToolbar of the admin area:

You can:

• Enable / disable the debug toolbar (default: disabled)
• Show / hide the debug toolbar in the admin area (default: hidden)
• Choose the number of last executions to save and display in the toolbar (default: 5)

Uninstallation

Unfortunately, the module cannot be automatically uninstalled, because Magento doesn't support uninstallation of dev packages out of the box.

To uninstall the module, follow these steps:

1. In app/etc/env.php, remove the key db.connection.default.profiler from the array if it is defined.
2. Run the following commands:

   bin/magento module:disable Smile_DebugToolbar
   composer remove --dev smile/module-debug-toolbar
   bin/magento setup:upgrade
   

3. [Optional] Remove the directory "var/smile_toolbar".

Customizing the Toolbar

It is possible to add new zones to the toolbar (e.g. to display project-specific data).
This is documented here.

Contributing

You can contribute to this module by submitting issues or pull requests.

For more details, please take a look at the contribution guidelines.

License

This module is licensed under the Eclipse Public License - v 2.0.

Changelog

All notable changes are recorded in this changelog.

Contact

Smile Technical Office [email protected]

Changelog

All notable changes to this project will be documented in this file.

7.0.3 - 2026-03-23

• Fixed deprecation notice when using php 8.5

7.0.2 - 2024-12-02

• Added a notification message in admin area when Magento runs in production mode

7.0.1 - 2023-11-08

• Renamed the "Generic" zone to "Server"
• Renamed the "Mysql" zone to "Database"
• Fixed typos
• Fine-tuned warning threshold for various statistics
• Moved block factories initialization to di.xml file

7.0.0 - 2023-09-05

• Set minimum PHP version to 8.1.
  This module now uses some features that require PHP >= 8.1 (e.g. promoted constructors).

6.1.3 - 2023-09-04

• Better third party theme support (#27)

6.1.2 - 2023-05-04

• Fix width of the mysql query list

6.1.1 - 2023-02-06

• Disable the output of the toolbar ajax query when the toolbar is disabled
• Remove use of AbstractAction class (deprecated)

6.1.0 - 2023-02-02

• Use an ajax query to load the toolbar
• Reduce memory consumption

6.0.0 - 2022-10-13

• Set minimum PHP version to 7.4
• Add new code quality standard (SmileLab)

5.2.4 - 2022-10-11

• Cast response content to string

5.2.3 - 2022-08-08

• Fix fatal error due to invalid type in layout helper

5.2.2 - 2022-07-26

• Update php constraint in composer.json

5.2.1 - 2022-07-06

• Fix env.php sync issue when enabling/disabling the profiler

5.2.0 - 2022-04-15

• Compatibility with Magento 2.4.4

5.1.2 - 2021-10-12

• Enabling/disabling the module will now properly update the profiler config in app/etc/env.php
• Fix fatal error on URL path page_cache/block/render

5.1.1 - 2021-08-05

• Add Magento module dependencies in composer.json
• Code cleanup (CI pipelines integration)

5.1.0 - 2021-08-02

• Add setting to toggle toolbar on admin area
• Add uninstallation procedure in the documentation

5.0.2 - 2021-01-04

• Set minimum PHP version to 7.3
• Remove copyright/licence annotations from DocBlocks

5.0.1 - 2020-08-18

• Fix event list not displayed in toolbar
• Remove type hinting from core methods and plugins

5.0.0 - 2020-08-17

WARNING: Compatibility break with Magento 2.3

• Add type hinting and strict types
• Add escaping in templates
• Set minimum requirements to Magento 2.4

4.0.3 - 2019-11-26

• Fix PHP notice triggered when an observer is disabled

4.0.2 - 2019-02-06

• Fix composer dependencies

4.0.1 - 2019-01-16

• Use Magento coding standard ruleset
• Update copyright

4.0.0 - 2018-11-28

WARNING: Compatibility break with Magento 2.2

• The module is now compatible with Magento 2.3

3.2.0 - 2018-11-27

• Code refactoring

3.1.1 - 2018-08-01

• Fix issue #1 - remove highlighjs lib (for mysql queries) because of a requireJs incompatibility

3.1.0 - 2017-12-29

• Implement new design
• Lots of minor fixes
• Better PHPDoc
• Update the copyright date
• Add doc

3.0.1 - 2017-12-12

• Fix minor issue on preference table

3.0.0 - 2017-11-13

WARNING: Compatibility break with Magento 2.1

• The module is now compatible with Magento 2.2
• Fix issue on message display conflict with the layout debug zone

1.2.2 - 2017-10-10

• Fix issue on event name - must be in lower case

1.2.1 - 2017-10-09

• Fix issue on layout zone - crash on the top menu

1.2.0 - 2017-09-29

• Add the "observer" zone
• Add the "plugin" zone
• Add the "preference" zone
• Add the "layout" zone

1.1.1 - 2017-09-20

• Fix bug on profiler class detection
• Fix bug on old toolbar cleaning

1.1.0 - 2017-09-20

• Add the "profiler" zone
• Refactoring the templates

1.0.0 - 2017-08-23

• First version of the module
• Add the "Generic" zone
• Add the "Request" zone
• Add the "Response" zone
• Add the "Mysql" zone
• Add the "Cache" zone
• Add the "Summary" zone