Magento 2 Z-Ray plugin
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc/screenshots
route
zray
.gitignore
README.md

README.md

Z-Ray-Magento

The Z-Ray tool from Zend Server adds to your Magento instance a toolbar with powerful features for profiling your PHP files.

Using the Z-Ray, you can inspect, debug, and optimize your pages, and easily add additional functionality. Using the built-in hooks, you can tap into Z-Ray's tracking mechanism, add new Z-Ray panels, and extend the information displayed in existing Z-Ray panels.

Magento2 Z-Ray plugin represented in this repository extends profiling data available in the tool by adding information about Magento specific instances: modules, blocks, plugins, events and observers.

Using the Magento2 Z-Ray plugin you can track heavy constructors, blocks rendering calls, behavior extension by plugins, number of observers listening to specific event and time on their execution.

ScreenShot

Installation

Step 1: Install the latest version of Zend Server.

Getting Started Guide with Zend Server

  • Zend Server with PHP 5.6 version is recommended as has been tests for compatibility with Magento.
  • Pay attention that Zend Server requires license data, though 30 days trial is available.

Step 2: In the Zend Server plugins directory create a magento2 directory and add the contents of this repo.

Example: (assuming default install directory for Zend Server is /usr/local/zend/)

    /usr/local/zend/var/plugins/magento2

NOTE: The directory and file names of zray/zray.php must not be changed. The name for logo.png is arbitary. It is specified in zray.php as follows:

    $zrayMagento->getZRay()->setMetadata(array(
        'logo' => __DIR__ . DIRECTORY_SEPARATOR . 'logo.png',
    ));

Step 3: Edit zray/zray.php to set the absolute path of your Magento installation directory to the MAGENTO_PATH constant.

    define('MAGENTO_PATH', '/var/www/html/magento2');

Step 4: Open Magento in a browser and the Z-Ray toolbar appears at the bottom of the page.

Data available in the Magento 2 Z-Ray plugin

  • Events: lists all the Magento events triggered by the request. For each event next information is available: event's name, class, method and target, as well as how long the event lasted.

ScreenShot

  • Rendered Blocks: lists all rendered blocks involved in current page build process, including performance profiling.
  • Blocks: outlines all the Magento blocks used on the page, including information on their template and class.

ScreenShot

  • Plugins: lists all plugins created during the request processing with mapping to intercepted class.

ScreenShot

  • Intercepted methods: full information on intercepted class/method with list of its plugins and time on their execution.

ScreenShot

  • Created objects: lists all objects created on the page with time spent in constructor.
  • Observers: all observers registered in configuration with ability to filter by area.
  • Modules: lists Magento installed modules.

More Information