mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-07-30 09:50:26 +02:00
Code Issues Releases Wiki Activity

Add basic support to Google Cloud Logging format (#1690)

Browse Source 
Google Cloud Logging doesn't show the correct level log when using
JsonFormatter, making observability a bit trickier. This applies minor
tweaks to the default format, allowing log entries to be properly
represented.

There are alternative packages to this but they add fields that aren't
strictly required - also performing `debug_backtrace()` calls that are
usually not desired when in production mode.

Signed-off-by: Luís Cobucci <lcobucci@gmail.com>
This commit is contained in:
Luís Cobucci
2022-07-22 13:03:58 +02:00
committed by GitHub
parent 100d0f1625
commit 1ae4f609ba
2 changed files with 93 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/Monolog/Formatter/GoogleCloudLoggingFormatter.php Normal file
View File

@@ -0,0 +1,39 @@
<?php declare(strict_types=1);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Formatter;
use DateTimeInterface;
use Monolog\LogRecord;
/**
* Encodes message information into JSON in a format compatible with Cloud logging.
*
* @see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
*
* @author Luís Cobucci <lcobucci@gmail.com>
*/
final class GoogleCloudLoggingFormatter extends JsonFormatter
{
protected function normalizeRecord(LogRecord $record): array
{
$normalized = parent::normalizeRecord($record);
// Re-key level for GCP logging
$normalized['severity'] = $normalized['level_name'];
$normalized['timestamp'] = $record->datetime->format(DateTimeInterface::RFC3339_EXTENDED);
// Remove keys that are not used by GCP
unset($normalized['level'], $normalized['level_name'], $normalized['datetime']);
return $normalized;
}
}

54
tests/Monolog/Formatter/GoogleCloudLoggingFormatterTest.php Normal file
View File

@@ -0,0 +1,54 @@
<?php declare(strict_types=1);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Formatter;
use DateTimeInterface;
use Monolog\Test\TestCase;
use function json_decode;
class GoogleCloudLoggingFormatterTest extends TestCase
{
/**
* @test
*
* @covers \Monolog\Formatter\JsonFormatter
* @covers \Monolog\Formatter\GoogleCloudLoggingFormatter::normalizeRecord
*/
public function formatProvidesRfc3339Timestamps(): void
{
$formatter = new GoogleCloudLoggingFormatter();
$record = $this->getRecord();
$formatted_decoded = json_decode($formatter->format($record), true);
$this->assertArrayNotHasKey("datetime", $formatted_decoded);
$this->assertArrayHasKey("timestamp", $formatted_decoded);
$this->assertSame($record->datetime->format(DateTimeInterface::RFC3339_EXTENDED), $formatted_decoded["timestamp"]);
}
/**
* @test
*
* @covers \Monolog\Formatter\JsonFormatter
* @covers \Monolog\Formatter\GoogleCloudLoggingFormatter::normalizeRecord
*/
public function formatIntroducesLogSeverity(): void
{
$formatter = new GoogleCloudLoggingFormatter();
$record = $this->getRecord();
$formatted_decoded = json_decode($formatter->format($record), true);
$this->assertArrayNotHasKey("level", $formatted_decoded);
$this->assertArrayNotHasKey("level_name", $formatted_decoded);
$this->assertArrayHasKey("severity", $formatted_decoded);
$this->assertSame($record->level->getName(), $formatted_decoded["severity"]);
}
}