# smile/module-debug-toolbar

> Smile Debug Toolbar

`composer require smile/module-debug-toolbar`

Canonical URL: https://packagento.com/smile/module-debug-toolbar

## At a glance

- **Vendor**: smile (https://packagento.com/smile.md)
- **Latest version**: 7.0.3 — released 2026-03-23
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/smile/module-debug-toolbar and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require smile/module-debug-toolbar:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Smile Debug Toolbar

## README

### 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

![](doc/images/toolbar.png)

### Installation

To install the module:

1. Execute the following command at the root of the Magento installation:
    ```bash
    composer require --dev smile/module-debug-toolbar
    ```
2. Enable the module:
    ```bash
    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](doc/add-zone.md).

### Contributing

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

For more details, please take a look at the [contribution guidelines](CONTRIBUTING.md).

### License

This module is licensed under the [Eclipse Public License - v 2.0](LICENSE.md).

### Changelog

All notable changes are recorded in this [changelog](CHANGELOG.md).

### Contact

Smile Technical Office <dirtech@smile.fr>

## Changelog

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

### [7.0.3] - 2026-03-23
[7.0.3]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/7.0.2...7.0.3

- Fixed deprecation notice when using php 8.5

### [7.0.2] - 2024-12-02
[7.0.2]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/7.0.1...7.0.2

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

### [7.0.1] - 2023-11-08
[7.0.1]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/7.0.0...7.0.1

- 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
[7.0.0]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/6.1.3...7.0.0

- 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
[6.1.3]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/6.1.2...6.1.3

- Better third party theme support ([#27](https://github.com/Smile-SA/magento2-module-debug-toolbar/pull/27))

### [6.1.2] - 2023-05-04
[6.1.2]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/6.1.1...6.1.2

- Fix width of the mysql query list

### [6.1.1] - 2023-02-06
[6.1.1]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/6.1.0...6.1.1

- 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
[6.1.0]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/6.0.0...6.1.0

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

### [6.0.0] - 2022-10-13
[6.0.0]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.2.4...6.0.0

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

### [5.2.4] - 2022-10-11
[5.2.4]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.2.3...5.2.4

- Cast response content to string

### [5.2.3] - 2022-08-08
[5.2.3]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.2.2...5.2.3

- Fix fatal error due to invalid type in layout helper

### [5.2.2] - 2022-07-26
[5.2.2]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.2.1...5.2.2

- Update php constraint in composer.json

### [5.2.1] - 2022-07-06
[5.2.1]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.2.0...5.2.1

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

### [5.2.0] - 2022-04-15
[5.2.0]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.1.2...5.2.0

- Compatibility with Magento 2.4.4

### [5.1.2] - 2021-10-12
[5.1.2]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.1.1...5.1.2

- 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
[5.1.1]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.1.0...5.1.1

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

### [5.1.0] - 2021-08-02
[5.1.0]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.0.2...5.1.0

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

### [5.0.2] - 2021-01-04
[5.0.2]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.0.1...5.0.2

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

### [5.0.1] - 2020-08-18
[5.0.1]: https://github.com/Smile-SA/magento2-module-debug-toolbar/compare/5.0.0...5.0.1

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

_(Changelog truncated for .md surface. Full history on https://packagento.com/smile/module-debug-toolbar.)_

## Recent Versions

| Version | Released |
|---|---|
| 7.0.3 | 2026-03-23 |
| 7.0.2 | 2024-12-02 |
| 7.0.1 | 2023-11-08 |
| 7.0.0 | 2023-09-05 |
| 6.1.3 | 2023-09-04 |
| 6.1.2 | 2023-05-04 |
| 6.1.1 | 2023-02-06 |
| 6.1.0 | 2023-02-02 |
| 6.0.0 | 2022-10-13 |
| 5.2.4 | 2022-10-11 |

Showing 10 of 33 versions. Full release history on https://packagento.com/smile/module-debug-toolbar.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=103.0.4 |
| magento/module-config | >=101.2.4 |
| php | ^8.1 |

### Require (dev)

| Package | Constraint |
|---|---|
| smile/magento2-smilelab-quality-suite | ^3.0 |

## Quality

Latest release (7.0.3) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 31 | 31 warnings (ruleset: Magento2) — 2 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 7 | 7 | – | – |
| 2.4.8 | – | 7 | 7 | – |
| 2.4.9 | – | – | 7 | 7 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["smile/module-debug-toolbar"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

smile is a Magento 2 vendor on Packagento. See https://packagento.com/smile.md for their full catalogue.