A new tool for measuring performance in Drupal 8 - DrupalCamp London
0 likes1,473 views
This document introduces a new performance measurement tool for Drupal 8 called Webprofiler, which integrates with existing profiling systems and highlights various challenges in profiling Drupal applications. It discusses the limitations of current profilers, the architecture of Webprofiler, and how to instrument services in Drupal for effective performance data collection. Future developments for the tool are also outlined, including enhancements in data collection and user interface improvements.
![Workflow
Instrumented
(collect data and
store profile)
Request Response
<div id="webprofilerefa2f1"></div>
<script>
Webprofiler = (function () {
[…]
}
</script>
Response
• Add HTTP header -> X-Debug-Token: efa2f1
• Inject some javascript in the page:](https://image.slidesharecdn.com/talk-150302041602-conversion-gate01/85/A-new-tool-for-measuring-performance-in-Drupal-8-DrupalCamp-London-16-320.jpg)
![Instrumenting the config.factory service
class ConfigFactoryWrapper implements ConfigFactoryInterface {
protected $configFactory;
protected $configDataCollector;
public function __construct(ConfigDataCollector $configDataCollector,
ConfigFactoryInterface $configFactory) {
$this->configFactory = $configFactory;
$this->configDataCollector = $configDataCollector;
}
public function get($name) {
$result = $this->configFactory->get($name);
$this->configDataCollector->addConfigName($name);
return $result;
}
[..]
}
Forward to the original method
Collect datas
DrupalwebprofilerConfigConfigFactoryWrapper.php](https://image.slidesharecdn.com/talk-150302041602-conversion-gate01/85/A-new-tool-for-measuring-performance-in-Drupal-8-DrupalCamp-London-21-320.jpg)
A new tool for measuring performance in Drupal 8 - DrupalCamp London
- 1. A new tool for measuring performance in Drupal 8
- 2. Luca Lusso Senior Drupal Developer @ Wellnet • www.drupal.org/u/lussoluca • @lussoluca
- 3. Agenda • Overview of existing profilers • Introducing Webprofiler • Drupal Console integration • Future developments
- 5. How to measure performance • Hardware/OS profilers • Function-level profilers • Application profilers we focus on these
- 6. Overview of function-level profilers Open source • xDebug • XHProf / uprofiler • … Commercial • NewRelic • Blackfire.io (free for open source projects) • Zend z-ray (available in Zend Server 8) • …
- 7. Strengths • Very detailed analysis • Useful to find out which functions spends a lot of time or memory • can be used on production (sampling) Weakness • Difficult to install / commercial • Difficult to analyze data (too much and too low level) Overview of function-level profilers
- 8. Overview of application profilers In Drupal we have the great Devel module Query logger / Time and memory logger
- 9. The problem with Drupal (8) • A simple page with a couple of views can do some expensive queries • Requesting a service causes the loading of all dependent services (if not declared as lazy) • We can trigger of a lot of events • Poorly implemented cache can cause heavy operations to be executed for every request • A lot of css and js can slows down the page render • Builded but not rendered blocks • … All of those problems are difficult to discover at PHP level, we need to profile the internals of Drupal.
- 11. Symfony2 Webprofiler Built-in in Symfony2 full stack distribution
- 12. Code available in Drupal 8 and missing pieces A lot of code was already available into the core. All the infrastructure for collecting and storing profiles were in place and there was an initial set of data collectors available. • SymfonyComponentHttpKernelProfiler (in Drupal 8) • SymfonyComponentHttpKernelDataCollector (in Drupal 8)
- 13. Code available in Drupal 8 and missing pieces The missing piece was the WebProfilerBundle. In a Symfony full stack application a bundle is the equivalent of a Drupal module, the problem here is that Drupal 8 isn’t a Symfony full stack application. Drupal has its own structures and internals and uses some of the Symfony components to replace legacy code. Unfortunately a bundle doesn’t work on Drupal, we need a module. • SymfonyBundleWebProfilerBundle (not in Drupal 8)
- 14. Drupal 8 Webprofiler Available as contrib module http://www.drupal.org/project/webprofiler https://github.com/lussoluca/webprofiler
- 15. Implemented DataCollectors PHP Config Request Timeline Frontend Database User Views Block Http Extensions Events State Config Assets Cache Routing Service Forms Every widget shows data about a metric measured by a data collector on the current rendered page
- 16. Workflow Instrumented (collect data and store profile) Request Response <div id="webprofilerefa2f1"></div> <script> Webprofiler = (function () { […] } </script> Response • Add HTTP header -> X-Debug-Token: efa2f1 • Inject some javascript in the page:
- 17. Workflow Profiling turned off Ajax Request Response /profiler/efa2f1 Returns only the toolbar DOM (with embedded javascript, css and icons)
- 18. Instrumentation • To profile our application we need to inject some instrumentation code • We have to replace the original code with a version that do the same thing but, at the same time, saves runtime data. In Drupal 8 this is fairly simple because we have services and a Dependency Injection Container • These data must be saved somewhere to be used later for toolbar rendering and for further analysis
- 19. • We need to find the service that is in charge of manage the structure we want to profile (configurations reads from the Configuration Management in this case) • All core services are defined in core/core.services.yml, contrib services are in modulename.services.yml • In this example we instrument the “config.factory” service config.factory: class: DrupalCoreConfigConfigFactory tags: - { name: event_subscriber } - { name: service_collector, tag: 'config.factory.override', call: addOverride } Instrumenting the config.factory service core/core.services.yml
- 20. Instrumenting the config.factory service $container->setDefinition('config.factory.default', $container->getDefinition('config.factory')); $container->register('config.factory', 'DrupalwebprofilerConfigConfigFactoryWrapper') ->addArgument(new Reference('webprofiler.config')) ->addArgument(new Reference('config.factory.default')); • Rename the original service • Register a new service with the original name (config.factory) but with a different class (ConfigFactoryWrapper) and inject both the specific data collector service and the renamed service DrupalwebprofilerWebprofilerServiceProvider.php
- 21. Instrumenting the config.factory service class ConfigFactoryWrapper implements ConfigFactoryInterface { protected $configFactory; protected $configDataCollector; public function __construct(ConfigDataCollector $configDataCollector, ConfigFactoryInterface $configFactory) { $this->configFactory = $configFactory; $this->configDataCollector = $configDataCollector; } public function get($name) { $result = $this->configFactory->get($name); $this->configDataCollector->addConfigName($name); return $result; } [..] } Forward to the original method Collect datas DrupalwebprofilerConfigConfigFactoryWrapper.php
- 22. Instrumentation Note that instrumenting a program can cause performance issues, and may in some cases lead to inaccurate results. Webprofiler should not be used in a production environment.
- 23. Demo time
- 24. Integration with XHProf/UProfiler Drupal 8 version of XHProf module is compatibile with Webprofiler (http://www.drupal.org/project/xhprof) admin/config/development/profiler/configureadmin/config/development/xhprof
- 25. Storage backends • Database (done) • Filesystem (done) • Elasticsearch (work in progess https:// www.drupal.org/node/2356123)
- 27. Drupal Console • Leverages the Symfony Console Component to provide a powerful CLI • Started as scaffolding generator now expose an increasing number of commands to interact with a Drupal 8 installation • Modules can contribute implementing new commands
- 28. Implemented commands • webprofiler:list -> list stored profiles • webprofiler:export -> export stored profiles • webprofiler:benchmark -> benchmark a site running a huge number of request and computing statistics: $> console webprofiler:benchmark http://d8 --runs=10
- 30. Open issues • Collect initializer time/amount of dependencies for container services (#2353253) • Collect performance metrics for services over time (#2349935) • Show database performance metrics commonly found in MySQL-Tuner.pl (#2349923) • Collect slow queries and report them over time (#2349911) • Collect rebuilding time of important caches (e.g. menu router, container, etc.) (#2349867) • Collect cache / DB services timing metrics (#2349845) • …
- 31. Better UI/UX • ajax • backbone
- 32. Profiles Diff Compute and show diff of two different profiles
- 33. More offline statistics via Drupal Console • Queries • Cache hit/miss • Events • …
- 34. Thanks!