[WebServerBundle] Add support for Xdebug's Profiler #28298

maidmaid · 2018-08-28T19:52:45Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	/
License	MIT
Doc PR	/

Xdebug's Profiler is a powerful tool that gives you the ability to analyze your PHP code and determine bottlenecks or generally see which parts of your code are slow and could use a speed boost.

https://xdebug.org/docs/profiler

When we run/start the web server, it would be useful to enable the trigger for the Xdebug's Profiler. That means we could easily trigger the creation of a Xdebug profile and analysing it thanks to PhpStorm which provides an Execution Statistics panel (examine the summary information about execution metrics of every called function) and a Call Tree panel (explore the execution paths of all called functions). You can see these two panels in action here for a better understanding.

nicolas-grekas · 2018-08-30T15:48:40Z

src/Symfony/Bundle/WebServerBundle/WebServerConfig.php

@@ -101,6 +107,11 @@ public function getAddress()
        return $this->hostname.':'.$this->port;
    }

+    public function isXdebugUsed()


I'm not sure adding this publilc method makes sense.
Let's use extension_loaded inline instead, don't you think?

If we inline it, the developers could no longer disable this feature if wanted. Ok for you ?

Nobody is going to extend this class anyway.

fabpot · 2018-08-30T16:45:34Z

I would add a flag instead.

maidmaid · 2018-08-30T16:49:20Z

Could you be more precise please ?

fabpot · 2018-08-30T16:55:33Z

Being able to use an option (sorry, doing too much of that other language that is not PHP) on commands: --enable-xdebug or something similar.

maidmaid · 2018-08-30T18:59:23Z

--enable-xdebug

IMO, this feature should be enabled by default (if xdebug extension is loaded of course), so if we really want make this feature controllable, --disable-xdebug should make more sense. But I'd prefer to make it simple by not making it controllable : if xdebug extension is loaded, then use it, else do not.

nicolas-grekas · 2018-08-31T09:38:17Z

I'm wondering: why would you need to do this? I mean: can't you change your php.ini instead and get the same result in a more flexible way (i.e. don't force the setting to everyone?)

nicolas-grekas · 2018-08-31T09:39:53Z

Or can't we make php -dxdebug.profiler_enable_trigger=1 bin/console server:run work instead?

maidmaid · 2018-08-31T10:34:20Z

php -dxdebug.profiler_enable_trigger=1 bin/console server:run

I thought that worked firstly, but it actually does not because we enable it only in the main process, not in the sub process running php -S 127.0.0.1:8000

nicolas-grekas · 2018-08-31T10:36:01Z

Yep I know, but we can make it work. It would be better IMHO. We could even make it work for all xdebug ini settings if it makes sense, isn't it?

maidmaid · 2018-08-31T10:41:56Z

We could even make it work for all xdebug ini settings

After checking again the settings described in https://xdebug.org/docs/all_settings, just enabling the trigger of the profiler seems relevant IMO.

stof · 2018-08-31T15:02:53Z

src/Symfony/Bundle/WebServerBundle/WebServer.php

@@ -150,7 +150,9 @@ private function createServerProcess(WebServerConfig $config)
            throw new \RuntimeException('Unable to find the PHP binary.');
        }

-        $process = new Process(array_merge(array($binary), $finder->findArguments(), array('-dvariables_order=EGPCS', '-S', $config->getAddress(), $config->getRouter())));
+        $xdebugArgs = \extension_loaded('xdebug') ? array('-dxdebug.profiler_enable_trigger=1') : array();


should we check whether this setting is enabled in the current PHP instead of always adding them ? AFAIK, turning on this feature adds overhead to the execution of PHP, as Xdebug needs to instrument the code (even though it does not actually collect the profiling data).

It's the reason why I turn on only the trigger of the profiler but not the profiler itself, whose the overhead is insignifiant.

nicolas-grekas · 2018-09-01T17:10:28Z

I would really prefer this to be made to work with php -dxdebug.profiler_enable_trigger=1 bin/console server:run instead.

maidmaid · 2018-09-01T17:49:03Z

@nicolas-grekas Could you review the last version I committed ?

nicolas-grekas

(with minor comment)

nicolas-grekas · 2018-09-01T18:18:39Z

src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php

@@ -133,6 +133,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
            $config = new WebServerConfig($documentRoot, $env, $input->getArgument('addressport'), $input->getOption('router'));

            $io->success(sprintf('Server listening on http://%s', $config->getAddress()));
+            if (\extension_loaded('xdebug') && '1' === ini_get('xdebug.profiler_enable_trigger')) {


if (ini_get('xdebug.profiler_enable_trigger')) { would be enough to me (same below)

nicolas-grekas · 2018-09-03T09:49:25Z

src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php

@@ -133,6 +133,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
            $config = new WebServerConfig($documentRoot, $env, $input->getArgument('addressport'), $input->getOption('router'));

            $io->success(sprintf('Server listening on http://%s', $config->getAddress()));
+            if ('1' === ini_get('xdebug.profiler_enable_trigger')) {


The '1' === doesn't make really sense.
The really correct way to check a boolean ini setting is by using filter_var:
filter_var(ini_get('xdebug.profiler_enable_trigger'), FILTER_VALIDATE_BOOLEAN)
See http://php.net/manual/fr/function.filter-var.php#121263
I'd suggest to either make a loose comparison (thus my original proposal: if (ini_get('xdebug.profiler_enable_trigger')) {) or a strict one using filter_var, but not something in between.

ini_get return the normalized value instead of the one present in the php.ini file, so the return value will be '1' ou '' here (or false if xdebug is not loaded).

Oh great! Let's use if (ini_get('xdebug.profiler_enable_trigger')) { then, to be consistent with the code base at least.

nicolas-grekas · 2018-09-09T09:51:37Z

Thank you @maidmaid.

…aidmaid) This PR was merged into the 4.2-dev branch. Discussion ---------- [WebServerBundle] Add support for Xdebug's Profiler | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | / | License | MIT | Doc PR | / > Xdebug's Profiler is a powerful tool that gives you the ability to analyze your PHP code and determine bottlenecks or generally see which parts of your code are slow and could use a speed boost. https://xdebug.org/docs/profiler When we run/start the web server, it would be useful to enable the trigger for the Xdebug's Profiler. That means we could easily trigger the creation of a Xdebug profile and analysing it [thanks to PhpStorm](https://www.jetbrains.com/help/phpstorm/analyzing-xdebug-profiling-data.html) which provides an **Execution Statistics** panel (examine the summary information about execution metrics of every called function) and a **Call Tree** panel (explore the execution paths of all called functions). You can see these two panels in action [here](https://youtu.be/_ua_O01IICg?t=1m22s) for a better understanding. Commits ------- 0f4c0a6 Add support for Xdebug Profiler

carsonbot added Status: Needs Review Feature labels Aug 28, 2018

nicolas-grekas reviewed Aug 30, 2018

View reviewed changes

nicolas-grekas added this to the next milestone Aug 30, 2018

maidmaid force-pushed the webserverbundle-xdebug branch 2 times, most recently from e25fe30 to 62852ab Compare August 30, 2018 19:01

stof approved these changes Aug 31, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Aug 31, 2018

maidmaid force-pushed the webserverbundle-xdebug branch from 62852ab to 8ef25cc Compare September 1, 2018 17:47

nicolas-grekas approved these changes Sep 1, 2018

View reviewed changes

maidmaid force-pushed the webserverbundle-xdebug branch from 8ef25cc to 34930ec Compare September 1, 2018 18:53

nicolas-grekas reviewed Sep 3, 2018

View reviewed changes

Add support for Xdebug Profiler

0f4c0a6

maidmaid force-pushed the webserverbundle-xdebug branch from 34930ec to 0f4c0a6 Compare September 9, 2018 09:48

nicolas-grekas merged commit 0f4c0a6 into symfony:master Sep 9, 2018

nicolas-grekas removed this from the next milestone Nov 1, 2018

nicolas-grekas added this to the 4.2 milestone Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WebServerBundle] Add support for Xdebug's Profiler #28298

[WebServerBundle] Add support for Xdebug's Profiler #28298

maidmaid commented Aug 28, 2018 •

edited

Loading

nicolas-grekas Aug 30, 2018

maidmaid Aug 30, 2018

fabpot Aug 30, 2018

fabpot commented Aug 30, 2018

maidmaid commented Aug 30, 2018

fabpot commented Aug 30, 2018

maidmaid commented Aug 30, 2018

nicolas-grekas commented Aug 31, 2018

nicolas-grekas commented Aug 31, 2018 •

edited

Loading

maidmaid commented Aug 31, 2018

nicolas-grekas commented Aug 31, 2018

maidmaid commented Aug 31, 2018 •

edited

Loading

stof Aug 31, 2018

maidmaid Sep 1, 2018

nicolas-grekas commented Sep 1, 2018

maidmaid commented Sep 1, 2018

nicolas-grekas left a comment

nicolas-grekas Sep 1, 2018

maidmaid Sep 1, 2018

nicolas-grekas Sep 3, 2018

jvasseur Sep 3, 2018

nicolas-grekas Sep 3, 2018

maidmaid Sep 9, 2018

nicolas-grekas commented Sep 9, 2018

[WebServerBundle] Add support for Xdebug's Profiler #28298

[WebServerBundle] Add support for Xdebug's Profiler #28298

Conversation

maidmaid commented Aug 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Aug 30, 2018

maidmaid commented Aug 30, 2018

fabpot commented Aug 30, 2018

maidmaid commented Aug 30, 2018

nicolas-grekas commented Aug 31, 2018

nicolas-grekas commented Aug 31, 2018 • edited Loading

maidmaid commented Aug 31, 2018

nicolas-grekas commented Aug 31, 2018

maidmaid commented Aug 31, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Sep 1, 2018

maidmaid commented Sep 1, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Sep 9, 2018

maidmaid commented Aug 28, 2018 •

edited

Loading

nicolas-grekas commented Aug 31, 2018 •

edited

Loading

maidmaid commented Aug 31, 2018 •

edited

Loading