How to debug Magento 2

- Magento 2

Magento 2 debugging

This blog posts contains vital information on Magento 2 debugging. Below, you will find Magento 2 tutorials related to Xdebug Magento 2 configuration, Magento 2 logging, enabling template path hints as well as a short list of free Magento 2 debugging tools.

Let’s start with Xdebug, since it is one of the most reliable and robust tools for Magento 2 debugging. On Mageclass, there is a good explanation of Xdebug configuration for Magento 2 with the help of Sublime Text and PhpStorm. Unfortunately, it is impossible to debug Magento 2 with Xdebug only, therefore additional tools are required. Both variants are described here: How to configure XDebug for Magento 2 development. Check the article for further information.

While talking about Magento 2 debugging, we should also mention such important process as Magento 2 logging. Logging variables or custom messages is inevitable during debugging, that’s why you should know how to create a custom log in Magento 2. The system utilizes a Monolog library to provide built-in log facilities; as for the configuration procedure, it won’t take too much time. Magento 2 logging is fully described on Inchoo here: Magento 2 logging.

Enabling template path hints is another procedure required for the debugging of Magento 2. Although it is described in our Magento 2 Developer’s Cookbook (you can also find tons of other useful tips related to Magento 2 there), we will described it below again.

In addition to enabling template path hints in Magento 2 you can also display block names. Go to your Admin -> Stores -> Configuration -> Developer; then, select a specific store scope; and finally set “Template page hints” and “Add block names to hints” to Yes. You will immediately notice changes in both frontend and backend: check some images in the Cookbook.

Magento 2 debugging tools

Below, there is a short list of free debugging tools compatible with Magento 2.

Z-Ray by Zend Server

Magento 2 debugging with Z-Ray

With the Z-Ray tool you will enhance your Magento 2 admin with powerful features for PHP files profiling. Having installed the Magento 2 Z-Ray plugin you get the ability to track heavy constructors, blocks rendering calls, behavior extension by plugins, number of observers listening to specific event and time on their execution. For further information, check Zend’s website, for the installation procedure follow this link.

Z-Ray on the official website

Z-Ray plugin on GitHub

Source: Magento Stackexchange; KAndy

Magento 2 Developer Debug Tool by CedCommerce

Magento 2 debugging with CedCommerce Developer Debug Tool

Magento 2 Developer-Debug Tool is an extension for fetching crucial information related to a page load. It provides a complete set of data about every current page request:

  • collections and models;
  • observer and events;
  • extended and parent classes;
  • blocks.

You can get Magento 2 Developer-Debug Tool on the official website or download it for free from GitHub

Magento 2 Developer-Debug Tool on the official website

Magento 2 Developer-Debug Tool on GitHub

Source: Magento Stackexchange; CedCommerce

Useful Commands

To enable developer mode, use the following command:

For the Magento 2 Profiler, run the command below:

You can find more Magento 2 commands here: Magento 2 Command Line Tool.