mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Avoid huge exception argument logging 

In some cases it might happen that you have an argument that deep down
somewhere has an array with a lot of entries (think thousands). Now
before we would just happily print them all. Which would fill the log.

Now it will just print the first 5. And add a line that there are N
more.

If you are on debug level we will still print them all.

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2020-12-29 10:50:53 +01:00 committed by backportbot[bot]
parent 25a65a34a7
commit 7d282a4e88
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/private/Log.php
View File

@ -315,7 +315,7 @@ class Log implements ILogger, IDataLogger {
$app = $context['app'] ?? 'no app in context'; $app = $context['app'] ?? 'no app in context';
$level = $context['level'] ?? ILogger::ERROR; $level = $context['level'] ?? ILogger::ERROR;
$serializer = new ExceptionSerializer(); $serializer = new ExceptionSerializer($this->config);
$data = $serializer->serializeException($exception); $data = $serializer->serializeException($exception);
$data['CustomMessage'] = $context['message'] ?? '--'; $data['CustomMessage'] = $context['message'] ?? '--';

26
lib/private/Log/ExceptionSerializer.php
View File

@ -32,6 +32,7 @@ use OC\Core\Controller\SetupController;
use OC\HintException; use OC\HintException;
use OC\Security\IdentityProof\Key; use OC\Security\IdentityProof\Key;
use OC\Setup; use OC\Setup;
use OC\SystemConfig;
class ExceptionSerializer { class ExceptionSerializer {
public const methodsWithSensitiveParameters = [ public const methodsWithSensitiveParameters = [
@ -88,6 +89,13 @@ class ExceptionSerializer {
'update', 'update',
]; ];
/** @var SystemConfig */
private $systemConfig;
public function __construct(SystemConfig $systemConfig) {
$this->systemConfig = $systemConfig;
}
public const methodsWithSensitiveParametersByClass = [ public const methodsWithSensitiveParametersByClass = [
SetupController::class => [ SetupController::class => [
'run', 'run',
@ -159,11 +167,21 @@ class ExceptionSerializer {
$data = get_object_vars($arg); $data = get_object_vars($arg);
$data['__class__'] = get_class($arg); $data['__class__'] = get_class($arg);
return array_map([$this, 'encodeArg'], $data); return array_map([$this, 'encodeArg'], $data);
} elseif (is_array($arg)) {
return array_map([$this, 'encodeArg'], $arg);
} else {
return $arg;
} }
if (is_array($arg)) {
// Only log the first 5 elements of an array unless we are on debug
if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
$elemCount = count($arg);
if ($elemCount > 5) {
$arg = array_slice($arg, 0, 5);
$arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
}
}
return array_map([$this, 'encodeArg'], $arg);
}
return $arg;
} }
public function serializeException(\Throwable $exception) { public function serializeException(\Throwable $exception) {