-
-
Notifications
You must be signed in to change notification settings - Fork 9.7k
[HttpKernel][FrameworkBundle] Add a minimalist default PSR-3 logger #24300
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\DependencyInjection; | ||
|
||
use Psr\Log\LoggerInterface; | ||
use Psr\Log\LogLevel; | ||
use Symfony\Component\HttpKernel\Log\Logger; | ||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
/** | ||
* Registers the default logger if necessary. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class LoggerPass implements CompilerPassInterface | ||
{ | ||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function process(ContainerBuilder $container) | ||
{ | ||
$alias = $container->setAlias(LoggerInterface::class, 'logger'); | ||
$alias->setPublic(false); | ||
|
||
if ($container->has('logger')) { | ||
return; | ||
} | ||
|
||
$loggerDefinition = $container->register('logger', Logger::class); | ||
$loggerDefinition->setPublic(false); | ||
if ($container->getParameter('kernel.debug')) { | ||
$loggerDefinition->addArgument(LogLevel::DEBUG); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\Log; | ||
|
||
use Psr\Log\AbstractLogger; | ||
use Psr\Log\InvalidArgumentException; | ||
use Psr\Log\LogLevel; | ||
|
||
/** | ||
* Minimalist PSR-3 logger designed to write in stderr or any other stream. | ||
* | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class Logger extends AbstractLogger | ||
{ | ||
private static $levels = array( | ||
LogLevel::DEBUG => 0, | ||
LogLevel::INFO => 1, | ||
LogLevel::NOTICE => 2, | ||
LogLevel::WARNING => 3, | ||
LogLevel::ERROR => 4, | ||
LogLevel::CRITICAL => 5, | ||
LogLevel::ALERT => 6, | ||
LogLevel::EMERGENCY => 7, | ||
); | ||
|
||
private $minLevelIndex; | ||
private $formatter; | ||
private $handle; | ||
|
||
public function __construct($minLevel = LogLevel::WARNING, $output = 'php://stderr', callable $formatter = null) | ||
{ | ||
if (!isset(self::$levels[$minLevel])) { | ||
throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $minLevel)); | ||
} | ||
|
||
$this->minLevelIndex = self::$levels[$minLevel]; | ||
$this->formatter = $formatter ?: array($this, 'format'); | ||
if (false === $this->handle = @fopen($output, 'a')) { | ||
throw new InvalidArgumentException(sprintf('Unable to open "%s".', $output)); | ||
} | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function log($level, $message, array $context = array()) | ||
{ | ||
if (!isset(self::$levels[$level])) { | ||
throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $level)); | ||
} | ||
|
||
if (self::$levels[$level] < $this->minLevelIndex) { | ||
return; | ||
} | ||
|
||
$formatter = $this->formatter; | ||
fwrite($this->handle, $formatter($level, $message, $context)); | ||
} | ||
|
||
/** | ||
* @param string $level | ||
* @param string $message | ||
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. missing $context 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. On purpose, the type is already documented by the typehint. 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. when I did so on some of my PRs, stof told me we don't do partial doc blocks :) 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. but we ma also remove the docblock entirely :) 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. Other types aren't inferable. |
||
* @param array $context | ||
* | ||
* @return string | ||
*/ | ||
private function format($level, $message, array $context) | ||
{ | ||
if (false !== strpos($message, '{')) { | ||
$replacements = array(); | ||
foreach ($context as $key => $val) { | ||
if (null === $val || is_scalar($val) || (\is_object($val) && method_exists($val, '__toString'))) { | ||
$replacements["{{$key}}"] = $val; | ||
} elseif ($val instanceof \DateTimeInterface) { | ||
$replacements["{{$key}}"] = $val->format(\DateTime::RFC3339); | ||
} elseif (\is_object($val)) { | ||
$replacements["{{$key}}"] = '[object '.\get_class($val).']'; | ||
} else { | ||
$replacements["{{$key}}"] = '['.\gettype($val).']'; | ||
} | ||
} | ||
|
||
$message = strtr($message, $replacements); | ||
} | ||
|
||
return sprintf('%s [%s] %s', date(\DateTime::RFC3339), $level, $message).\PHP_EOL; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpKernel\Tests\DependencyInjection; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Psr\Log\LoggerInterface; | ||
use Psr\Log\LogLevel; | ||
use Symfony\Component\HttpKernel\DependencyInjection\LoggerPass; | ||
use Symfony\Component\HttpKernel\Log\Logger; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
/** | ||
* @author Kévin Dunglas <dunglas@gmail.com> | ||
*/ | ||
class LoggerPassTest extends TestCase | ||
{ | ||
public function testAlwaysSetAutowiringAlias() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->register('logger', 'Foo'); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$this->assertFalse($container->getAlias(LoggerInterface::class)->isPublic()); | ||
} | ||
|
||
public function testDoNotOverrideExistingLogger() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->register('logger', 'Foo'); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$this->assertSame('Foo', $container->getDefinition('logger')->getClass()); | ||
} | ||
|
||
public function testRegisterLogger() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->setParameter('kernel.debug', false); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$definition = $container->getDefinition('logger'); | ||
$this->assertSame(Logger::class, $definition->getClass()); | ||
$this->assertFalse($definition->isPublic()); | ||
} | ||
|
||
public function testSetMinLevelWhenDebugging() | ||
{ | ||
$container = new ContainerBuilder(); | ||
$container->setParameter('kernel.debug', true); | ||
|
||
(new LoggerPass())->process($container); | ||
|
||
$definition = $container->getDefinition('logger'); | ||
$this->assertSame(LogLevel::DEBUG, $definition->getArgument(0)); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
alpha order