mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-01 19:00:20 +02:00
Code Issues Releases Wiki Activity

JsonFormatter: add option to ignore empty context and extra fields

Browse Source 
Similar to efe572cb10.
This commit is contained in:
Gabriel Caruso
2020-04-01 05:03:52 +02:00
parent 13ee5dabda
commit 6038dcb21c
2 changed files with 33 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/Monolog/Formatter/JsonFormatter.php
View File

@@ -28,16 +28,18 @@ class JsonFormatter extends NormalizerFormatter
protected $batchMode; protected $batchMode;
protected $appendNewline; protected $appendNewline;
protected $ignoreEmptyContextAndExtra;
/** /**
* @var bool * @var bool
*/ */
protected $includeStacktraces = false; protected $includeStacktraces = false;
public function __construct(int $batchMode = self::BATCH_MODE_JSON, bool $appendNewline = true) public function __construct(int $batchMode = self::BATCH_MODE_JSON, bool $appendNewline = true, bool $ignoreEmptyContextAndExtra = false)
{ {
$this->batchMode = $batchMode; $this->batchMode = $batchMode;
$this->appendNewline = $appendNewline; $this->appendNewline = $appendNewline;
$this->ignoreEmptyContextAndExtra = $ignoreEmptyContextAndExtra;
} }
/** /**
@@ -68,11 +70,20 @@ class JsonFormatter extends NormalizerFormatter
public function format(array $record): string public function format(array $record): string
{ {
$normalized = $this->normalize($record); $normalized = $this->normalize($record);
if (isset($normalized['context']) && $normalized['context'] === []) { if (isset($normalized['context']) && $normalized['context'] === []) {
$normalized['context'] = new \stdClass; if ($this->ignoreEmptyContextAndExtra) {
unset($normalized['context']);
} else {
$normalized['context'] = new \stdClass;
}
} }
if (isset($normalized['extra']) && $normalized['extra'] === []) { if (isset($normalized['extra']) && $normalized['extra'] === []) {
$normalized['extra'] = new \stdClass; if ($this->ignoreEmptyContextAndExtra) {
unset($normalized['extra']);
} else {
$normalized['extra'] = new \stdClass;
}
} }
return $this->toJson($normalized, true) . ($this->appendNewline ? "\n" : ''); return $this->toJson($normalized, true) . ($this->appendNewline ? "\n" : '');

19
tests/Monolog/Formatter/JsonFormatterTest.php
View File

@@ -295,4 +295,23 @@ class JsonFormatterTest extends TestCase
$this->assertCount(1001, $res['context'][0]); $this->assertCount(1001, $res['context'][0]);
$this->assertEquals('Over 1000 items (2000 total), aborting normalization', $res['context'][0]['...']); $this->assertEquals('Over 1000 items (2000 total), aborting normalization', $res['context'][0]['...']);
} }
public function testEmptyContextAndExtraFieldsCanBeIgnored()
{
$formatter = new JsonFormatter(JsonFormatter::BATCH_MODE_JSON, true, true);
$record = $formatter->format(array(
'level' => 100,
'level_name' => 'DEBUG',
'channel' => 'test',
'message' => 'Testing',
'context' => array(),
'extra' => array(),
));
$this->assertSame(
'{"level":100,"level_name":"DEBUG","channel":"test","message":"Testing"}'."\n",
$record
);
}
} }