[Console] Update the doc for automatic console logging #7373

chalasr · 2017-01-16T09:14:14Z

In symfony/symfony#21003 we are going to provide automatic error/exception logging for the console, similar to what is done in an HTTP context.

In the docs, there is a whole chapter dedicated to this topic. Right now I just removed it, maybe it should be done differently or mentioned somewhere that error/exceptions are automatically logged on the console channel?

Thanks

javiereguiluz · 2017-01-16T11:01:49Z

Yes, we should remove the contents of this article ... but maybe it's too son to remove the article itself. Otherwise, all the .../current/console/logging.html links will break. What if we just add the following content to the article:

In Symfony versions prior to 3.3, the Console component didn't provide any
logging capabilities out of the box and you had to implement your own exception
lister for the console.

Starting from Symfony 3.3, the Console component provides automatic error and
exception logging. <Here a link to read more details about enabling/configuring this>

chalasr · 2017-01-17T15:17:27Z

@javiereguiluz Let's do it like that 👍
However, I have no idea of where should lead the "read more" link you mentioned (nor what it should contain) :/
It is not planed to make this feature opt-in (AFAIK it is not for exception logging in HTTP context), exceptions will be logged as any other.
Maybe could we add it this link at first, and see for a more detailed reading if the feature becomes configurable?

javiereguiluz · 2017-01-17T15:58:16Z

@chalasr then we can remove the link entirely and add it later if needed:

In Symfony versions prior to 3.3, the Console component didn't provide any
logging capabilities out of the box and you had to implement your own exception
lister for the console.

Starting from Symfony 3.3, the Console component provides automatic error and
exception logging.

chalasr · 2017-01-17T16:54:44Z

Oops, that's what I meant, but forgot "without" in my last sentence :) I made the change

javiereguiluz

👍

chalasr · 2017-01-18T09:25:20Z

I re-added the page title so that other pages can have links to, the travis build was failing if missing.

…eshalsall, chalasr) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console][FrameworkBundle] Log console exceptions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #10895 | License | MIT | Doc PR | symfony/symfony-docs#7373 Continues #19382, fixing some issues including: - ability to display the input string for any `InputInterface` implementation (cast to string if possible, use the command name otherwise) - if the input can be casted as string, cleanup the result (from `command "'command:name' --foo=bar" ` to `command "command:name --foo=bar"`) - made `ExceptionLister::$logger` private instead of protected - changed methods name from `onKernel*` to `onConsole*` (e.g. `onConsoleException`) and removed unnecessary doc blocks - Added more tests Log for an exception: > [2016-12-22 00:34:42] app.ERROR: Exception thrown while running command: "cache:clear -vvv". Message: "An error occured!" {"exception":"[object] (RuntimeException(code: 0): An error occured! at /Volumes/HD/Sites/tests/sf-demo-3.2/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php:61)","command":"cache:clear -vvv","message":"An error occured!"} [] Commits ------- 919041c1ad Add Console ExceptionListener 9896547a4d Add basic support for automatic console exception logging

…eshalsall, chalasr) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console][FrameworkBundle] Log console exceptions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #10895 | License | MIT | Doc PR | symfony/symfony-docs#7373 Continues #19382, fixing some issues including: - ability to display the input string for any `InputInterface` implementation (cast to string if possible, use the command name otherwise) - if the input can be casted as string, cleanup the result (from `command "'command:name' --foo=bar" ` to `command "command:name --foo=bar"`) - made `ExceptionLister::$logger` private instead of protected - changed methods name from `onKernel*` to `onConsole*` (e.g. `onConsoleException`) and removed unnecessary doc blocks - Added more tests Log for an exception: > [2016-12-22 00:34:42] app.ERROR: Exception thrown while running command: "cache:clear -vvv". Message: "An error occured!" {"exception":"[object] (RuntimeException(code: 0): An error occured! at /Volumes/HD/Sites/tests/sf-demo-3.2/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php:61)","command":"cache:clear -vvv","message":"An error occured!"} [] Commits ------- 919041c Add Console ExceptionListener 9896547 Add basic support for automatic console exception logging

…eshalsall, chalasr) This PR was merged into the 3.3-dev branch. Discussion ---------- [Console][FrameworkBundle] Log console exceptions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #10895 | License | MIT | Doc PR | symfony/symfony-docs#7373 Continues #19382, fixing some issues including: - ability to display the input string for any `InputInterface` implementation (cast to string if possible, use the command name otherwise) - if the input can be casted as string, cleanup the result (from `command "'command:name' --foo=bar" ` to `command "command:name --foo=bar"`) - made `ExceptionLister::$logger` private instead of protected - changed methods name from `onKernel*` to `onConsole*` (e.g. `onConsoleException`) and removed unnecessary doc blocks - Added more tests Log for an exception: > [2016-12-22 00:34:42] app.ERROR: Exception thrown while running command: "cache:clear -vvv". Message: "An error occured!" {"exception":"[object] (RuntimeException(code: 0): An error occured! at /Volumes/HD/Sites/tests/sf-demo-3.2/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php:61)","command":"cache:clear -vvv","message":"An error occured!"} [] Commits ------- 919041c1ad Add Console ExceptionListener 9896547a4d Add basic support for automatic console exception logging

chalasr · 2017-01-24T08:33:26Z

symfony/symfony#21003 has been merged, this is no longer on hold.

xabbuh · 2017-02-03T07:08:24Z

Thank you @chalasr.

…(chalasr) This PR was merged into the master branch. Discussion ---------- [Console] Update the doc for automatic console logging In symfony/symfony#21003 we are going to provide automatic error/exception logging for the console, similar to what is done in an HTTP context. In the docs, there is a whole chapter dedicated to this topic. Right now I just removed it, maybe it should be done differently or mentioned somewhere that error/exceptions are automatically logged on the `console` channel? Thanks Commits ------- 76d2c91 Update the doc for automatic console logging

carsonbot added Status: Needs Review Console labels Jan 16, 2017

chalasr mentioned this pull request Jan 16, 2017

[Console][FrameworkBundle] Log console exceptions symfony/symfony#21003

Merged

xabbuh added the On hold label Jan 16, 2017

chalasr force-pushed the 3.3/console-logging branch from 368b538 to a73e932 Compare January 17, 2017 16:53

javiereguiluz approved these changes Jan 18, 2017

View reviewed changes

javiereguiluz added Status: Reviewed and removed Status: Needs Review labels Jan 18, 2017

chalasr force-pushed the 3.3/console-logging branch from a73e932 to cff3a8d Compare January 18, 2017 09:16

Update the doc for automatic console logging

76d2c91

chalasr force-pushed the 3.3/console-logging branch from cff3a8d to 76d2c91 Compare January 18, 2017 09:23

chalasr changed the title ~~[WCM][Console] Update the doc for automatic console logging~~ [Console] Update the doc for automatic console logging Jan 24, 2017

javiereguiluz removed the On hold label Jan 24, 2017

xabbuh merged commit 76d2c91 into symfony:master Feb 3, 2017

xabbuh added a commit that referenced this pull request Feb 3, 2017

[#7373] fix a minor typo

be79b90

chalasr deleted the 3.3/console-logging branch February 3, 2017 08:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Update the doc for automatic console logging #7373

[Console] Update the doc for automatic console logging #7373

chalasr commented Jan 16, 2017

javiereguiluz commented Jan 16, 2017

chalasr commented Jan 17, 2017

javiereguiluz commented Jan 17, 2017

chalasr commented Jan 17, 2017 •

edited

Loading

javiereguiluz left a comment

chalasr commented Jan 18, 2017

chalasr commented Jan 24, 2017

xabbuh commented Feb 3, 2017

[Console] Update the doc for automatic console logging #7373

[Console] Update the doc for automatic console logging #7373

Conversation

chalasr commented Jan 16, 2017

javiereguiluz commented Jan 16, 2017

chalasr commented Jan 17, 2017

javiereguiluz commented Jan 17, 2017

chalasr commented Jan 17, 2017 • edited Loading

javiereguiluz left a comment

Choose a reason for hiding this comment

chalasr commented Jan 18, 2017

chalasr commented Jan 24, 2017

xabbuh commented Feb 3, 2017

chalasr commented Jan 17, 2017 •

edited

Loading