Integrate profiler module

Last updated:
Edit on GitHub

This document describes how to integrate profiler module into a Spryker project.

Prerequisites

To start the integration, install the necessary features:

NAME VERSION INSTALLATION GUIDE
Spryker Core Install the Spryker Core feature
Web Profiler for Zed Web Profiler feature integration
Web Profiler for Yves Web Profiler feature integration

1) Enable extension

To collect execution traces, enable the xhprof extension.

version: '0.1'

namespace: spryker
tag: 'dev'

environment: docker.dev
image:
  tag: spryker/php:8.3
  php:
    enabled-extensions:
      - xhprof

2) Bootstrap the Docker setup

docker/sdk boot deploy.dev.yml

3) Install the required modules using Composer

Verification

Ensure that the following modules have been updated:

MODULE EXPECTED DIRECTORY
EventDispatcherExtension vendor/spryker/event-dispatcher-extension
WebProfilerExtension vendor/spryker/web-profiler-extension 
composer require --dev spryker/profiler --ignore-platform-reqs

Set up behavior

  1. For Yves application, register the following plugins:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProfilerRequestEventDispatcherPlugin Starts collecting the data on request events. EventDispatcherExtension Spryker\Zed\Profiler\Communication\Plugin\EventDispatcher
WebProfilerProfilerDataCollectorPlugin Shows the traces data in the web profiler toolbar. WebProfilerExtension Spryker\Zed\Profiler\Communication\Plugin\WebProfiler\WebProfilerProfilerDataCollectorPlugin 
<?php

namespace Pyz\Yves\EventDispatcher;

use Spryker\Yves\EventDispatcher\EventDispatcherDependencyProvider as SprykerEventDispatcherDependencyProvider;
use Spryker\Yves\Profiler\Plugin\EventDispatcher\ProfilerRequestEventDispatcherPlugin;


class EventDispatcherDependencyProvider extends SprykerEventDispatcherDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\EventDispatcherExtension\Dependency\Plugin\EventDispatcherPluginInterface>
     */
    protected function getEventDispatcherPlugins(): array
    {
        $plugins = [
            //...
        ];

        if (class_exists(ProfilerRequestEventDispatcherPlugin::class)) {
            $plugins[] = new ProfilerRequestEventDispatcherPlugin();
        }

        return $plugins;
    }
}

<?php

namespace Pyz\Yves\WebProfilerWidget;

use Spryker\Yves\Profiler\Plugin\WebProfiler\WebProfilerProfilerDataCollectorPlugin;
use SprykerShop\Yves\WebProfilerWidget\WebProfilerWidgetDependencyProvider as SprykerWebProfilerDependencyProvider;

class WebProfilerWidgetDependencyProvider extends SprykerWebProfilerDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\WebProfilerExtension\Dependency\Plugin\WebProfilerDataCollectorPluginInterface>
     */
    public function getDataCollectorPlugins(): array
    {
        $plugins = [
            //...
        ];

        if (class_exists(WebProfilerProfilerDataCollectorPlugin::class)) {
            $plugins[] = new WebProfilerProfilerDataCollectorPlugin();
        }

        return $plugins;
    }
}
  1. Register the following plugins for Zed application:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ProfilerRequestEventDispatcherPlugin Starts collecting the data on request events. EventDispatcherExtension Spryker\Zed\Profiler\Communication\Plugin\EventDispatcher
WebProfilerProfilerDataCollectorPlugin Shows the traces data in the web profiler toolbar. WebProfilerExtension Spryker\Zed\Profiler\Communication\Plugin\WebProfiler\WebProfilerProfilerDataCollectorPlugin 
<?php

namespace Pyz\Zed\EventDispatcher;

use Spryker\Zed\Profiler\Communication\Plugin\EventDispatcher\ProfilerRequestEventDispatcherPlugin;
use Spryker\Zed\EventDispatcher\EventDispatcherDependencyProvider as SprykerEventDispatcherDependencyProvider;

class EventDispatcherDependencyProvider extends SprykerEventDispatcherDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\EventDispatcherExtension\Dependency\Plugin\EventDispatcherPluginInterface>
     */
    protected function getEventDispatcherPlugins(): array
    {
        $plugins = [
            //...
        ];

        if (class_exists(ProfilerRequestEventDispatcherPlugin::class)) {
            $plugins[] = new ProfilerRequestEventDispatcherPlugin();
        }

        return $plugins;
    }
}

<?php

namespace Pyz\Zed\WebProfiler;

use Spryker\Zed\Profiler\Communication\Plugin\WebProfiler\WebProfilerProfilerDataCollectorPlugin;
use Spryker\Zed\WebProfiler\WebProfilerDependencyProvider as SprykerWebProfilerDependencyProvider;

class WebProfilerDependencyProvider extends SprykerWebProfilerDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\WebProfilerExtension\Dependency\Plugin\WebProfilerDataCollectorPluginInterface>
     */
    public function getDataCollectorPlugins(): array
    {
        $plugins = [
            //...
        ];

        if (class_exists(WebProfilerProfilerDataCollectorPlugin::class)) {
            $plugins[] = new WebProfilerProfilerDataCollectorPlugin();
        }

        return $plugins;
    }
}

Generate transfers

Run the console transfer:generate command to generate all the necessary transfer objects.

Enable the configuration

Module Profile works as a part of Web Profiler feature. By default, Web Profiler is disabled. To enable Web Profiler, please update config/Shared/config_default-docker.dev.php configuration file.

if (interface_exists(WebProfilerConstants::class, true)) {
    $config[WebProfilerConstants::IS_WEB_PROFILER_ENABLED]
        = $config[WebProfilerWidgetConstants::IS_WEB_PROFILER_ENABLED]
        = true;
}