335 lines
11 KiB
PHP
335 lines
11 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\DataCollector;
|
||
|
|
|
||
|
|
use Symfony\Component\ErrorHandler\Exception\SilencedErrorContext;
|
||
|
|
use Symfony\Component\HttpFoundation\Request;
|
||
|
|
use Symfony\Component\HttpFoundation\RequestStack;
|
||
|
|
use Symfony\Component\HttpFoundation\Response;
|
||
|
|
use Symfony\Component\HttpKernel\Log\DebugLoggerConfigurator;
|
||
|
|
use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
|
||
|
|
use Symfony\Component\VarDumper\Cloner\Data;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
||
|
|
*
|
||
|
|
* @final
|
||
|
|
*/
|
||
|
|
class LoggerDataCollector extends DataCollector implements LateDataCollectorInterface
|
||
|
|
{
|
||
|
|
private ?DebugLoggerInterface $logger;
|
||
|
|
private ?Request $currentRequest = null;
|
||
|
|
private ?array $processedLogs = null;
|
||
|
|
|
||
|
|
public function __construct(
|
||
|
|
?object $logger = null,
|
||
|
|
private ?string $containerPathPrefix = null,
|
||
|
|
private ?RequestStack $requestStack = null,
|
||
|
|
) {
|
||
|
|
$this->logger = DebugLoggerConfigurator::getDebugLogger($logger);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
|
||
|
|
{
|
||
|
|
$this->currentRequest = $this->requestStack && $this->requestStack->getMainRequest() !== $request ? $request : null;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function lateCollect(): void
|
||
|
|
{
|
||
|
|
if ($this->logger) {
|
||
|
|
$containerDeprecationLogs = $this->getContainerDeprecationLogs();
|
||
|
|
$this->data = $this->computeErrorsCount($containerDeprecationLogs);
|
||
|
|
// get compiler logs later (only when they are needed) to improve performance
|
||
|
|
$this->data['compiler_logs'] = [];
|
||
|
|
$this->data['compiler_logs_filepath'] = $this->containerPathPrefix.'Compiler.log';
|
||
|
|
$this->data['logs'] = $this->sanitizeLogs(array_merge($this->logger->getLogs($this->currentRequest), $containerDeprecationLogs));
|
||
|
|
$this->data = $this->cloneVar($this->data);
|
||
|
|
}
|
||
|
|
$this->currentRequest = null;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getLogs(): Data|array
|
||
|
|
{
|
||
|
|
return $this->data['logs'] ?? [];
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getProcessedLogs(): array
|
||
|
|
{
|
||
|
|
if (null !== $this->processedLogs) {
|
||
|
|
return $this->processedLogs;
|
||
|
|
}
|
||
|
|
|
||
|
|
$rawLogs = $this->getLogs();
|
||
|
|
if ([] === $rawLogs) {
|
||
|
|
return $this->processedLogs = $rawLogs;
|
||
|
|
}
|
||
|
|
|
||
|
|
$logs = [];
|
||
|
|
foreach ($this->getLogs()->getValue() as $rawLog) {
|
||
|
|
$rawLogData = $rawLog->getValue();
|
||
|
|
|
||
|
|
if ($rawLogData['priority']->getValue() > 300) {
|
||
|
|
$logType = 'error';
|
||
|
|
} elseif (isset($rawLogData['scream']) && false === $rawLogData['scream']->getValue()) {
|
||
|
|
$logType = 'deprecation';
|
||
|
|
} elseif (isset($rawLogData['scream']) && true === $rawLogData['scream']->getValue()) {
|
||
|
|
$logType = 'silenced';
|
||
|
|
} else {
|
||
|
|
$logType = 'regular';
|
||
|
|
}
|
||
|
|
|
||
|
|
$logs[] = [
|
||
|
|
'type' => $logType,
|
||
|
|
'errorCount' => $rawLog['errorCount'] ?? 1,
|
||
|
|
'timestamp' => $rawLogData['timestamp_rfc3339']->getValue(),
|
||
|
|
'priority' => $rawLogData['priority']->getValue(),
|
||
|
|
'priorityName' => $rawLogData['priorityName']->getValue(),
|
||
|
|
'channel' => $rawLogData['channel']->getValue(),
|
||
|
|
'message' => $rawLogData['message'],
|
||
|
|
'context' => $rawLogData['context'],
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
// sort logs from oldest to newest
|
||
|
|
usort($logs, static fn ($logA, $logB) => $logA['timestamp'] <=> $logB['timestamp']);
|
||
|
|
|
||
|
|
return $this->processedLogs = $logs;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getFilters(): array
|
||
|
|
{
|
||
|
|
$filters = [
|
||
|
|
'channel' => [],
|
||
|
|
'priority' => [
|
||
|
|
'Debug' => 100,
|
||
|
|
'Info' => 200,
|
||
|
|
'Notice' => 250,
|
||
|
|
'Warning' => 300,
|
||
|
|
'Error' => 400,
|
||
|
|
'Critical' => 500,
|
||
|
|
'Alert' => 550,
|
||
|
|
'Emergency' => 600,
|
||
|
|
],
|
||
|
|
];
|
||
|
|
|
||
|
|
$allChannels = [];
|
||
|
|
foreach ($this->getProcessedLogs() as $log) {
|
||
|
|
if ('' === trim($log['channel'] ?? '')) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$allChannels[] = $log['channel'];
|
||
|
|
}
|
||
|
|
$channels = array_unique($allChannels);
|
||
|
|
sort($channels);
|
||
|
|
$filters['channel'] = $channels;
|
||
|
|
|
||
|
|
return $filters;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getPriorities(): Data|array
|
||
|
|
{
|
||
|
|
return $this->data['priorities'] ?? [];
|
||
|
|
}
|
||
|
|
|
||
|
|
public function countErrors(): int
|
||
|
|
{
|
||
|
|
return $this->data['error_count'] ?? 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function countDeprecations(): int
|
||
|
|
{
|
||
|
|
return $this->data['deprecation_count'] ?? 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function countWarnings(): int
|
||
|
|
{
|
||
|
|
return $this->data['warning_count'] ?? 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function countScreams(): int
|
||
|
|
{
|
||
|
|
return $this->data['scream_count'] ?? 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getCompilerLogs(): Data
|
||
|
|
{
|
||
|
|
return $this->cloneVar($this->getContainerCompilerLogs($this->data['compiler_logs_filepath'] ?? null));
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getName(): string
|
||
|
|
{
|
||
|
|
return 'logger';
|
||
|
|
}
|
||
|
|
|
||
|
|
private function getContainerDeprecationLogs(): array
|
||
|
|
{
|
||
|
|
if (null === $this->containerPathPrefix || !is_file($file = $this->containerPathPrefix.'Deprecations.log')) {
|
||
|
|
return [];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' === $logContent = trim(file_get_contents($file))) {
|
||
|
|
return [];
|
||
|
|
}
|
||
|
|
|
||
|
|
$bootTime = filemtime($file);
|
||
|
|
$logs = [];
|
||
|
|
foreach (unserialize($logContent) as $log) {
|
||
|
|
$log['context'] = ['exception' => new SilencedErrorContext($log['type'], $log['file'], $log['line'], $log['trace'], $log['count'])];
|
||
|
|
$log['timestamp'] = $bootTime;
|
||
|
|
$log['timestamp_rfc3339'] = (new \DateTimeImmutable())->setTimestamp($bootTime)->format(\DateTimeInterface::RFC3339_EXTENDED);
|
||
|
|
$log['priority'] = 100;
|
||
|
|
$log['priorityName'] = 'DEBUG';
|
||
|
|
$log['channel'] = null;
|
||
|
|
$log['scream'] = false;
|
||
|
|
unset($log['type'], $log['file'], $log['line'], $log['trace'], $log['count']);
|
||
|
|
$logs[] = $log;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $logs;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function getContainerCompilerLogs(?string $compilerLogsFilepath = null): array
|
||
|
|
{
|
||
|
|
if (!$compilerLogsFilepath || !is_file($compilerLogsFilepath)) {
|
||
|
|
return [];
|
||
|
|
}
|
||
|
|
|
||
|
|
$logs = [];
|
||
|
|
foreach (file($compilerLogsFilepath, \FILE_IGNORE_NEW_LINES) as $log) {
|
||
|
|
$log = explode(': ', $log, 2);
|
||
|
|
if (!isset($log[1]) || !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)++$/', $log[0])) {
|
||
|
|
$log = ['Unknown Compiler Pass', implode(': ', $log)];
|
||
|
|
}
|
||
|
|
|
||
|
|
$logs[$log[0]][] = ['message' => $log[1]];
|
||
|
|
}
|
||
|
|
|
||
|
|
return $logs;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function sanitizeLogs(array $logs): array
|
||
|
|
{
|
||
|
|
$sanitizedLogs = [];
|
||
|
|
$silencedLogs = [];
|
||
|
|
|
||
|
|
foreach ($logs as $log) {
|
||
|
|
if (!$this->isSilencedOrDeprecationErrorLog($log)) {
|
||
|
|
$sanitizedLogs[] = $log;
|
||
|
|
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$message = '_'.$log['message'];
|
||
|
|
$exception = $log['context']['exception'];
|
||
|
|
|
||
|
|
if ($exception instanceof SilencedErrorContext) {
|
||
|
|
if (isset($silencedLogs[$id = spl_object_id($exception)])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$silencedLogs[$id] = true;
|
||
|
|
|
||
|
|
if (!isset($sanitizedLogs[$message])) {
|
||
|
|
$sanitizedLogs[$message] = $log + [
|
||
|
|
'errorCount' => 0,
|
||
|
|
'scream' => true,
|
||
|
|
];
|
||
|
|
}
|
||
|
|
$sanitizedLogs[$message]['errorCount'] += $exception->count;
|
||
|
|
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$errorId = hash('xxh128', "{$exception->getSeverity()}/{$exception->getLine()}/{$exception->getFile()}\0{$message}", true);
|
||
|
|
|
||
|
|
if (isset($sanitizedLogs[$errorId])) {
|
||
|
|
++$sanitizedLogs[$errorId]['errorCount'];
|
||
|
|
} else {
|
||
|
|
$log += [
|
||
|
|
'errorCount' => 1,
|
||
|
|
'scream' => false,
|
||
|
|
];
|
||
|
|
|
||
|
|
$sanitizedLogs[$errorId] = $log;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return array_values($sanitizedLogs);
|
||
|
|
}
|
||
|
|
|
||
|
|
private function isSilencedOrDeprecationErrorLog(array $log): bool
|
||
|
|
{
|
||
|
|
if (!isset($log['context']['exception'])) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
$exception = $log['context']['exception'];
|
||
|
|
|
||
|
|
if ($exception instanceof SilencedErrorContext) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($exception instanceof \ErrorException && \in_array($exception->getSeverity(), [\E_DEPRECATED, \E_USER_DEPRECATED], true)) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function computeErrorsCount(array $containerDeprecationLogs): array
|
||
|
|
{
|
||
|
|
$silencedLogs = [];
|
||
|
|
$count = [
|
||
|
|
'error_count' => $this->logger->countErrors($this->currentRequest),
|
||
|
|
'deprecation_count' => 0,
|
||
|
|
'warning_count' => 0,
|
||
|
|
'scream_count' => 0,
|
||
|
|
'priorities' => [],
|
||
|
|
];
|
||
|
|
|
||
|
|
foreach ($this->logger->getLogs($this->currentRequest) as $log) {
|
||
|
|
if (isset($count['priorities'][$log['priority']])) {
|
||
|
|
++$count['priorities'][$log['priority']]['count'];
|
||
|
|
} else {
|
||
|
|
$count['priorities'][$log['priority']] = [
|
||
|
|
'count' => 1,
|
||
|
|
'name' => $log['priorityName'],
|
||
|
|
];
|
||
|
|
}
|
||
|
|
if ('WARNING' === $log['priorityName']) {
|
||
|
|
++$count['warning_count'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->isSilencedOrDeprecationErrorLog($log)) {
|
||
|
|
$exception = $log['context']['exception'];
|
||
|
|
if ($exception instanceof SilencedErrorContext) {
|
||
|
|
if (isset($silencedLogs[$id = spl_object_id($exception)])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$silencedLogs[$id] = true;
|
||
|
|
$count['scream_count'] += $exception->count;
|
||
|
|
} else {
|
||
|
|
++$count['deprecation_count'];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($containerDeprecationLogs as $deprecationLog) {
|
||
|
|
$count['deprecation_count'] += $deprecationLog['context']['exception']->count;
|
||
|
|
}
|
||
|
|
|
||
|
|
ksort($count['priorities']);
|
||
|
|
|
||
|
|
return $count;
|
||
|
|
}
|
||
|
|
}
|