191 lines
5.9 KiB
PHP
191 lines
5.9 KiB
PHP
<?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;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Symfony\Component\HttpFoundation\RequestStack;
|
|
|
|
/**
|
|
* Minimalist PSR-3 logger designed to write in stderr or any other stream.
|
|
*
|
|
* @author Kévin Dunglas <dunglas@gmail.com>
|
|
*/
|
|
class Logger extends AbstractLogger implements DebugLoggerInterface
|
|
{
|
|
private const LEVELS = [
|
|
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 const PRIORITIES = [
|
|
LogLevel::DEBUG => 100,
|
|
LogLevel::INFO => 200,
|
|
LogLevel::NOTICE => 250,
|
|
LogLevel::WARNING => 300,
|
|
LogLevel::ERROR => 400,
|
|
LogLevel::CRITICAL => 500,
|
|
LogLevel::ALERT => 550,
|
|
LogLevel::EMERGENCY => 600,
|
|
];
|
|
|
|
private int $minLevelIndex;
|
|
private \Closure $formatter;
|
|
private bool $debug = false;
|
|
private array $logs = [];
|
|
private array $errorCount = [];
|
|
|
|
/** @var resource|null */
|
|
private $handle;
|
|
|
|
/**
|
|
* @param string|resource|null $output
|
|
*/
|
|
public function __construct(?string $minLevel = null, $output = null, ?callable $formatter = null, private readonly ?RequestStack $requestStack = null, bool $debug = false)
|
|
{
|
|
if (null === $minLevel) {
|
|
$minLevel = null === $output || 'php://stdout' === $output || 'php://stderr' === $output ? LogLevel::ERROR : LogLevel::WARNING;
|
|
|
|
if (isset($_ENV['SHELL_VERBOSITY']) || isset($_SERVER['SHELL_VERBOSITY'])) {
|
|
$minLevel = match ((int) ($_ENV['SHELL_VERBOSITY'] ?? $_SERVER['SHELL_VERBOSITY'])) {
|
|
-1 => LogLevel::ERROR,
|
|
1 => LogLevel::NOTICE,
|
|
2 => LogLevel::INFO,
|
|
3 => LogLevel::DEBUG,
|
|
default => $minLevel,
|
|
};
|
|
}
|
|
}
|
|
|
|
if (!isset(self::LEVELS[$minLevel])) {
|
|
throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $minLevel));
|
|
}
|
|
|
|
$this->minLevelIndex = self::LEVELS[$minLevel];
|
|
$this->formatter = null !== $formatter ? $formatter(...) : $this->format(...);
|
|
if ($output && false === $this->handle = \is_resource($output) ? $output : @fopen($output, 'a')) {
|
|
throw new InvalidArgumentException(sprintf('Unable to open "%s".', $output));
|
|
}
|
|
$this->debug = $debug;
|
|
}
|
|
|
|
public function enableDebug(): void
|
|
{
|
|
$this->debug = true;
|
|
}
|
|
|
|
public function log($level, $message, array $context = []): void
|
|
{
|
|
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;
|
|
if ($this->handle) {
|
|
@fwrite($this->handle, $formatter($level, $message, $context).\PHP_EOL);
|
|
} else {
|
|
error_log($formatter($level, $message, $context, false));
|
|
}
|
|
|
|
if ($this->debug && $this->requestStack) {
|
|
$this->record($level, $message, $context);
|
|
}
|
|
}
|
|
|
|
public function getLogs(?Request $request = null): array
|
|
{
|
|
if ($request) {
|
|
return $this->logs[spl_object_id($request)] ?? [];
|
|
}
|
|
|
|
return array_merge(...array_values($this->logs));
|
|
}
|
|
|
|
public function countErrors(?Request $request = null): int
|
|
{
|
|
if ($request) {
|
|
return $this->errorCount[spl_object_id($request)] ?? 0;
|
|
}
|
|
|
|
return array_sum($this->errorCount);
|
|
}
|
|
|
|
public function clear(): void
|
|
{
|
|
$this->logs = [];
|
|
$this->errorCount = [];
|
|
}
|
|
|
|
private function format(string $level, string $message, array $context, bool $prefixDate = true): string
|
|
{
|
|
if (str_contains($message, '{')) {
|
|
$replacements = [];
|
|
foreach ($context as $key => $val) {
|
|
if (null === $val || \is_scalar($val) || $val instanceof \Stringable) {
|
|
$replacements["{{$key}}"] = $val;
|
|
} elseif ($val instanceof \DateTimeInterface) {
|
|
$replacements["{{$key}}"] = $val->format(\DateTimeInterface::RFC3339);
|
|
} elseif (\is_object($val)) {
|
|
$replacements["{{$key}}"] = '[object '.$val::class.']';
|
|
} else {
|
|
$replacements["{{$key}}"] = '['.\gettype($val).']';
|
|
}
|
|
}
|
|
|
|
$message = strtr($message, $replacements);
|
|
}
|
|
|
|
$log = sprintf('[%s] %s', $level, $message);
|
|
if ($prefixDate) {
|
|
$log = date(\DateTimeInterface::RFC3339).' '.$log;
|
|
}
|
|
|
|
return $log;
|
|
}
|
|
|
|
private function record($level, $message, array $context): void
|
|
{
|
|
$request = $this->requestStack->getCurrentRequest();
|
|
$key = $request ? spl_object_id($request) : '';
|
|
|
|
$this->logs[$key][] = [
|
|
'channel' => null,
|
|
'context' => $context,
|
|
'message' => $message,
|
|
'priority' => self::PRIORITIES[$level],
|
|
'priorityName' => $level,
|
|
'timestamp' => time(),
|
|
'timestamp_rfc3339' => date(\DATE_RFC3339_EXTENDED),
|
|
];
|
|
|
|
$this->errorCount[$key] ??= 0;
|
|
switch ($level) {
|
|
case LogLevel::ERROR:
|
|
case LogLevel::CRITICAL:
|
|
case LogLevel::ALERT:
|
|
case LogLevel::EMERGENCY:
|
|
++$this->errorCount[$key];
|
|
}
|
|
}
|
|
}
|