Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork9.7k
[Bridge/Monolog] Enhance the Console Handler#21705
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
5 changes: 5 additions & 0 deletionssrc/Symfony/Bridge/Monolog/CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
189 changes: 172 additions & 17 deletionssrc/Symfony/Bridge/Monolog/Formatter/ConsoleFormatter.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -11,45 +11,200 @@ | ||
| namespace Symfony\Bridge\Monolog\Formatter; | ||
| use Monolog\Formatter\FormatterInterface; | ||
| use Monolog\Logger; | ||
| use Symfony\Component\VarDumper\Cloner\Data; | ||
| use Symfony\Component\VarDumper\Cloner\Stub; | ||
| use Symfony\Component\VarDumper\Cloner\VarCloner; | ||
| use Symfony\Component\VarDumper\Dumper\CliDumper; | ||
| /** | ||
| * Formats incoming records for console output by coloring them depending on log level. | ||
| * | ||
| * @author Tobias Schultze <http://tobion.de> | ||
| * @author Grégoire Pineau <lyrixx@lyrixx.info> | ||
| */ | ||
| class ConsoleFormatterimplements FormatterInterface | ||
| { | ||
| const SIMPLE_FORMAT = "%datetime% %start_tag%%level_name%%end_tag% <comment>[%channel%]</> %message%%context%%extra%\n"; | ||
| const SIMPLE_DATE = 'H:i:s'; | ||
| private static $levelColorMap = array( | ||
| Logger::DEBUG => 'fg=white', | ||
| Logger::INFO => 'fg=green', | ||
| Logger::NOTICE => 'fg=blue', | ||
| Logger::WARNING => 'fg=cyan', | ||
| Logger::ERROR => 'fg=yellow', | ||
| Logger::CRITICAL => 'fg=red', | ||
| Logger::ALERT => 'fg=red', | ||
| Logger::EMERGENCY => 'fg=white;bg=red', | ||
| ); | ||
| private $options; | ||
| private $cloner; | ||
| private $outputBuffer; | ||
| private $dumper; | ||
| /** | ||
| * Constructor. | ||
| * | ||
| * Available options: | ||
| * * format: The format of the outputted log string. The following placeholders are supported: %datetime%, %start_tag%, %level_name%, %end_tag%, %channel%, %message%, %context%, %extra%; | ||
| * * date_format: The format of the outputted date string; | ||
| * * colors: If true, the log string contains ANSI code to add color; | ||
| * * multiline: If false, "context" and "extra" are dumped on one line. | ||
| */ | ||
| public function __construct($options = array()) | ||
| { | ||
| // BC Layer | ||
| if (!is_array($options)) { | ||
| @trigger_error(sprintf('The constructor arguments $format, $dateFormat, $allowInlineLineBreaks, $ignoreEmptyContextAndExtra of "%s" are deprecated since 3.3 and will be removed in 4.0. Use $options instead.', self::class), E_USER_DEPRECATED); | ||
| $args = func_get_args(); | ||
| $options = array(); | ||
| if (isset($args[0])) { | ||
| $options['format'] = $args[0]; | ||
| } | ||
| if (isset($args[1])) { | ||
| $options['date_format'] = $args[1]; | ||
| } | ||
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. What about the two last arguments? MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. They are not relevant anymore. So I don't need to "map" them. Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. shouldn't MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Indeed. I will fix it in the next pr. Thanks. Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. So you intentionally removed the option to suppress emtpy context and extra data? Update: Just saw that this was mentioned in#21705 (comment) as well. | ||
| } | ||
| $this->options = array_replace(array( | ||
| 'format' => self::SIMPLE_FORMAT, | ||
| 'date_format' => self::SIMPLE_DATE, | ||
| 'colors' => true, | ||
| 'multiline' => false, | ||
| ), $options); | ||
| if (class_exists(VarCloner::class)) { | ||
| $this->cloner = new VarCloner(); | ||
| $this->cloner->addCasters(array( | ||
| '*' => array($this, 'castObject'), | ||
| )); | ||
| $this->outputBuffer = fopen('php://memory', 'r+b'); | ||
| if ($this->options['multiline']) { | ||
| $output = $this->outputBuffer; | ||
| } else { | ||
| $output = array($this, 'echoLine'); | ||
| } | ||
| $this->dumper = new CliDumper($output, null, CliDumper::DUMP_LIGHT_ARRAY | CliDumper::DUMP_COMMA_SEPARATOR); | ||
| } | ||
| } | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public functionformatBatch(array $records) | ||
| { | ||
| foreach ($records as $key => $record) { | ||
| $records[$key] = $this->format($record); | ||
| } | ||
| return $records; | ||
| } | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function format(array $record) | ||
| { | ||
| $record = $this->replacePlaceHolder($record); | ||
| $levelColor = self::$levelColorMap[$record['level']]; | ||
| if ($this->options['multiline']) { | ||
| $context = $extra = "\n"; | ||
| } else { | ||
| $context = $extra = ' '; | ||
| } | ||
| $context .= $this->dumpData($record['context']); | ||
| $extra .= $this->dumpData($record['extra']); | ||
| $formatted = strtr($this->options['format'], array( | ||
| '%datetime%' => $record['datetime']->format($this->options['date_format']), | ||
| '%start_tag%' => sprintf('<%s>', $levelColor), | ||
| '%level_name%' => sprintf('%-9s', $record['level_name']), | ||
| '%end_tag%' => '</>', | ||
| '%channel%' => $record['channel'], | ||
| '%message%' => $this->replacePlaceHolder($record)['message'], | ||
| '%context%' => $context, | ||
| '%extra%' => $extra, | ||
| )); | ||
| return $formatted; | ||
| } | ||
| /** | ||
| * @internal | ||
| */ | ||
| public function echoLine($line, $depth, $indentPad) | ||
| { | ||
| if (-1 !== $depth) { | ||
| fwrite($this->outputBuffer, $line); | ||
| } | ||
| } | ||
| /** | ||
| * @internal | ||
| */ | ||
| public function castObject($v, array $a, Stub $s, $isNested) | ||
| { | ||
| if ($this->options['multiline']) { | ||
| return $a; | ||
| } | ||
| if ($isNested && !$v instanceof \DateTimeInterface) { | ||
| $s->cut = -1; | ||
| $a = array(); | ||
| } | ||
| return $a; | ||
| } | ||
| private function replacePlaceHolder(array $record) | ||
| { | ||
| $message = $record['message']; | ||
| if (false === strpos($message, '{')) { | ||
| return $record; | ||
| } | ||
| $context = $record['context']; | ||
| $replacements = array(); | ||
| foreach ($context as $k => $v) { | ||
| $replacements['{'.$k.'}'] = sprintf('<comment>%s</>', $this->dumpData($v, false)); | ||
| } | ||
| $record['message'] = strtr($message, $replacements); | ||
| return $record; | ||
| } | ||
| private function dumpData($data, $colors = null) | ||
| { | ||
| if (null === $this->dumper) { | ||
| return ''; | ||
| } | ||
| if (null === $colors) { | ||
| $this->dumper->setColors($this->options['colors']); | ||
| } else { | ||
| $this->dumper->setColors($colors); | ||
| } | ||
| if (!$data instanceof Data) { | ||
| $data = $this->cloner->cloneVar($data); | ||
| } | ||
| $data = $data->withRefHandles(false); | ||
| $this->dumper->dump($data); | ||
| $dump = stream_get_contents($this->outputBuffer, -1, 0); | ||
| rewind($this->outputBuffer); | ||
| ftruncate($this->outputBuffer, 0); | ||
| return rtrim($dump); | ||
| } | ||
| } | ||
9 changes: 8 additions & 1 deletionsrc/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
10 changes: 8 additions & 2 deletionssrc/Symfony/Bridge/Monolog/Tests/Handler/ConsoleHandlerTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
3 changes: 2 additions & 1 deletionsrc/Symfony/Bridge/Monolog/composer.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.