Enable/Disable DB query logging commands #9264

federivo · 2017-04-15T20:52:37Z

Description

Added console commands for enabling/disabling the db query logging.

Fixed Issues (if relevant)

Create new CLI command: Enable DB logging #9200: Create new CLI command: Enable dev settings, i.e DB logging, Profiler, Template Hints

Manual testing scenarios

Run bin/magento dev:query-log:enable command.
Clear configuration cache.
Make any request to the Magento site and verify that the DB query log is being written.
Run bin/magento dev:query-log:disable command.
Clear configuration cache
Make any request to the site and verify that the DB query log have no new log data.

vrann · 2017-04-15T21:45:27Z

app/code/Magento/Developer/Console/Command/QueryLogDisableCommand.php

+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $data = ['db_logger_alias' => 'quiet'];


please use constants for db_logger_alias and quiet

db_logger_alias is not the best name for the config parameter, because we used it to set the mode of the logger: "writing to file" vs "quiet". I would suggest something like "db logger mode"

for the same reason, "quiet" might be renamed to "disabled"

vrann · 2017-04-15T21:47:07Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+        Writer $deploymentConfigWriter,
+        $name = null
+    )
+    {


braces should be on the same line

vrann · 2017-04-15T21:47:54Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $data = ['db_logger_alias' => 'file'];


you already have constant for the "file" which can be used here. Though, I'd suggest to move it out from the command to the proxy or interface

just noticed that you have constant in proxy, please use it here

vrann · 2017-04-15T21:48:08Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+        $data = ['db_logger_alias' => 'file'];
+        $this->deploymentConfigWriter->saveConfig([ConfigFilePool::APP_ENV => $data]);
+
+//        $data = [


dead code should be eliminated

vrann · 2017-04-15T21:49:13Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+    /**
+     * File logger alias
+     */
+    const FILE_LOGGER_ALIAS = 'file';


you can use constant from the proxy instead of this one

vrann · 2017-04-15T21:50:30Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+    /**
+     * Logger alias param name
+     */
+    const PARAM_ALIAS = 'db_logger_alias';


per comment earlier please rename the value of the param from "db_logger_alias" to "db_logger_mode" or something similar.

vrann · 2017-04-15T21:51:40Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+//        $data = [
+//            'db_logger' => [
+//                'logger_alias' => 'file',
+//                'log_all_queries' => false,


For simplicity, we might just default these paratemeters to:

log all queries => true

log query time => 0.001

log call stack => true
This will be the minimum requirement.

Two other options requires more implementation:

parameters passed to the proxy in the same way as the alias for the logger through the DI and env.php

create virtual types for the file writer with the different configuration, i,e FileLogAllWithStack and FileLogNoStack

Chose to handle the params the same as the alias. Need your feedback on that approach.

vrann · 2017-04-15T21:53:51Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+        $logAllQueries = false,
+        $logQueryTime = 0.05,
+        $logCallStack = false
+    )


braces should be on the same line

…ded logAllQueries, logQueryTime and logCallStack parameters so they can be configured using the command.

…r code sniffer violation

…evelop

vrann · 2017-04-17T19:28:26Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+     * @param bool $logCallStack
+     */
+    public function __construct(
+        File $file,


please avoid passing dependency which will never be used. It is better to pass Factory instead, which will create the right logger based on alias the first time logger is requested.

Done. Passed logger factories instead.

vrann · 2017-04-17T19:29:52Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+    /**
+     * Logger alias param name
+     */
+    const PARAM_ALIAS = 'db_logger_mode';


please group Deployment configuration options related to logging together and rename them:

'db_logger' => [
'output' => 'file',
'log_everything' => 1,
'query_time_threshold' => '0.001',
'include_stacktrace' => 1
]

vrann · 2017-04-17T19:30:37Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+        $this->setName(self::COMMAND_NAME)
+            ->setDescription('Enable DB query logging');
+
+        $this->addArgument(


please change arguments to options, so that it will allow named parameters vs positional.

vrann · 2017-04-17T19:31:44Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+    /**
+     * input parameter log-query-time
+     */
+    const INPUT_ARG_LOG_QUERY_TIME = 'log-query-time';


please remove "log-" prefix on all these options names
rename option to query-time-threshold

vrann · 2017-04-17T19:32:00Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+    /**
+     * input parameter log-all-queries
+     */
+    const INPUT_ARG_LOG_ALL_QUERIES = 'log-all-queries';


please rename to include-all-queries

vrann · 2017-04-17T19:32:20Z

app/code/Magento/Developer/Console/Command/QueryLogEnableCommand.php

+    /**
+     * input parameter log-call-stack
+     */
+    const INPUT_ARG_LOG_CALL_STACK = 'log-call-stack';


please rename to include-call-stack

vrann · 2017-04-17T19:36:08Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+                break;
+        }
+
+        parent::__construct($logAllQueries, $logQueryTime, $logCallStack);


I noticed that the $logCallStack option does not work. I think the reason behind it is that File and Quiet should be constructed with this parameter passed to the constructor.

This call to the parent method is not really needed because that's File or Quiet should be constructed with these parameters

You're right. Now it's working.

vrann · 2017-04-17T19:37:33Z

lib/internal/Magento/Framework/DB/Logger/LoggerProxy.php

+ */
+namespace Magento\Framework\DB\Logger;
+
+class LoggerProxy extends LoggerAbstract


LoggerProxy should not extend the abstract, instead it should implement the LoggerInterface and delegate all calls to the class which extends the abstract, such as File or Quiet

…ers instead of actual loggers in LoggerProxy. Added config path to ConfigOptionsListConstants. Fixed unit tests as needed.

… in the review.

…ore than 3 chars long

…oggerProxy. Unit test modified accordingly.

magento-team · 2017-04-19T06:10:12Z

@federivo thank you for your contribution. Your Pull Request has been successfully merged

mslabko · 2017-04-21T12:38:19Z

Hi @federivo,
Thank you for your contribution! Here is some code we use internally for debugging sql\app which is nice to have in CLI command tool to make it multifunctional like a Swiss Army knife :)

Adds executed sql queries to the bottom of page, so you can determinate during development which queries are executed on the page https://gist.github.com/mslabko/06b8dd2e80670f8e1abbf19f70ffd99f how it looks
Allows to add watches for specific classes, methods, etc and monitor elapsed time, cpu, sql and more https://gist.github.com/kandy/7ae16d74e2bdc35ffd7b524f089259c2
But this one require installed tideways extension (https://tideways.io/profiler/docs/setup/installation) and there is no open documentation how it works, so need to digg into source code for find some usefull features. how it looks

Dedicated "Up For Grabs" GitHub issue - #9341

federivo added 3 commits April 15, 2017 16:00

Added DB logger proxy. Modified logger interface preference in di.xml

565ba43

Moved logger alias to const

25adbf7

Added console commands for enabling and disabling query logging

65f7b3c

vrann self-assigned this Apr 15, 2017

vrann added this to the April 2017 milestone Apr 15, 2017

vrann suggested changes Apr 15, 2017

View reviewed changes

federivo added 4 commits April 16, 2017 18:13

Moved constants to LoggerProxy. Fixed issues with code convention. Ad…

d31bb17

…ded logAllQueries, logQueryTime and logCallStack parameters so they can be configured using the command.

Removed type hint from logQueryTime param

a9a2257

Removed type hint from logQueryTime param. Added space after comma pe…

b9afcf3

…r code sniffer violation

Merge branch 'develop' of https://github.com/federivo/magento2 into d…

5d46ea8

…evelop

vrann approved these changes Apr 16, 2017

View reviewed changes

Added unit tests for commands and LoggerProxy

cbfac52

vrann suggested changes Apr 17, 2017

View reviewed changes

federivo added 4 commits April 18, 2017 03:19

Fixed review issues. Grouped config params. Inject factories for logg…

3bb5d62

…ers instead of actual loggers in LoggerProxy. Added config path to ConfigOptionsListConstants. Fixed unit tests as needed.

Renamed command options. Moved from arguments to options as suggested…

3f42615

… in the review.

Modified param name because codacy check requires variable names of m…

09904a6

…ore than 3 chars long

Moved logger initialization logic out of the constructor in LoggerProxy

f3a5a90

vrann approved these changes Apr 18, 2017

View reviewed changes

getLogger() is now private so the internal logger is not exposed in L…

8209744

…oggerProxy. Unit test modified accordingly.

magento-team merged commit 8209744 into magento:develop Apr 19, 2017

magento-team pushed a commit that referenced this pull request Apr 19, 2017

MAGETWO-67501: Enable/Disable DB query logging commands #9264

31b63be

magento-team pushed a commit that referenced this pull request Apr 19, 2017

MAGETWO-67501: Enable/Disable DB query logging commands #9264

5185548

Enable/Disable DB query logging commands #9264

Enable/Disable DB query logging commands #9264

Conversation

federivo commented Apr 15, 2017 • edited by vrann Loading

Description

Fixed Issues (if relevant)

Manual testing scenarios

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

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

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

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

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

magento-team commented Apr 19, 2017

mslabko commented Apr 21, 2017 • edited by maghamed Loading

federivo commented Apr 15, 2017 •

edited by vrann

Loading

mslabko commented Apr 21, 2017 •

edited by maghamed

Loading