This repository represents an extension for Magento 1.x that offers a developer debug toolbar. The idea came from robhudson's django-debug-toolbar.

 Latest version is based on Symfony's WebProfilerBundle.

Features


• Request and Controller information: lists request attributes and controller that handled the request, including Ajax and POST requests
• Execution Timeline: shows execution timeline based on Varien Profiler timers
• Logs: shows log lines added to system and exception 'during' the request
• Events: shows all raised events and called observers
• Database: lists all models and collections loaded during the request; all executed SQL queries are listed when SQL Profiler is enabled
• E-mails: lists sent e-mails with preview
• Layout: outputs rendering tree, lists layout handlers loaded during current request and adds ability to see layout files updates to a specific handle; offers information about instantiated and rendered block
• Configuration: lists available Magento modules with their status and their version; also offers the ability to enable/disable them
• Toolbar Tools: contains quick links to flush cache, enable template hints, enable SQL profiler, enable Varien Profiler

Don't forget to check out screenshots gallery

Installation

Using Modman

• Make sure you have Modman installed

• Allow symlinks for the templates directory (required for installations via Modman)

  • Use n98-magerun like pro: n98-magerun.phar dev:symlinks
  • Or just set 'Allow Symlinks' to 'Yes' from System - Configuration / Advanced / Developer / Template Settings

• Install Debug Toolbar module:

cd [magento root folder]
modman init
modman clone https://github.com/madalinoprea/magneto-debug.git

• Flush Magento's cache

How to update

I'm pretty lazy and I don't like to create Magento Connect packages. With modman you can effortlessly grab latest changes from github.

cd [magento root folder]
modman update magneto-debug

• Flush Magento's cache

Compatibility

Extension is (hopefully) successfully unit tested against PHP 5.4, PHP 5.5 and Magento CE 1.9 and Magento CE 1.8.

If you would like to support it on another version let us know.

Issues, Ideas or Feedback

Use issue tracker on GitHub to report issues, ideas or any feedback.

Common Issues

• 'Mage Registry key already exists' exception is raised after installation

  • Mage registry key "_singleton/debug/observer" already exists is reported when cache regeneration was corrupted. Please try to flush Magento cache.

• I can't see toolbar.

  • Toolbar is displayed in these conditions:
    • module is installed and enabled
    • toolbar is enabled from Admin / System / Configuration / Advanced - Developer Debug Toolbar (by default it's enabled)
    • Magento is running in developer mode (MAGE_IS_DEVELOPER_MODE) Or your ip is listed under under 'Developer Client Restrictions'
  • Check that module name Sheep_Debug is installed and enabled
  • Check that 'Allow Symlinks' configuration is enabled for Modman installation

• I can't see toolbar on specific page

  • Toolbar is added to all pages that have a structural block named before_body_end. By default this block is available on all Magento pages. Eliminate a possible cache problem by disabling all caches. Try to determine if there are any customizations that have removed before_body_end.

Change Log

• 1.5.0

  • Adds nicer way to present rendering tree
  • Adds support to capture e-mails even when Aschroder_SMTPPro or Ebizmarts_Mandrill are installed
  • Minor UI tweaks for layout panel
  • Fixes listing of database layout updates

• 1.4.1

  • Minor fixes for Magento Enterprise (website restrictions, Full Page Cache debug menu item)

• 1.4.0:

  • Added unit tests and continuous integration via Travis CI
  • Fixes request headers collection for non Apache web servers (e.g Nginx)
  • Improves support to collect and render sent e-mails
  • Other minor UI tweaks

• 1.3.0:

  • UI reimplemented based on Symphony's web debug toolbar
  • Ability to view POST and Ajax requests
  • Ability to view sent e-mails
  • Ability to view raised events and called observers
  • Ability to see an execution timeline based on Varien Profiler timers

• 1.2.0:

  • Fixes SELECT and DESCRIBE operations for long queries
  • Better way to identify what logging lines were added during request
  • Various minor UI improvements (order of the panel, panel titles)
  • Structural changes to improve stability and prepare new features

Authors, contributors

• Mario O
• Other contributors

License

MIT License

Roadmap

• Re-add ability to search configuration
• UI tweaks and improvements
• Add more detailed documentation