Skip to content

fix(logs): Allow passing string and enum Monolog level #959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 24, 2025
Merged

fix(logs): Allow passing string and enum Monolog level #959

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5cdd6d
fix(logs): Allow passing string and enum Monolog level
HypeMC Sep 18, 2025
de332aa
Review
HypeMC Sep 22, 2025
52e6ca6
Merge branch 'master' into improve-logshandler
cleptric Sep 23, 2025
b1f689f
Merge branch 'master' into improve-logshandler
cleptric Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@
<code><![CDATA[isMasterRequest]]></code>
</UndefinedMethod>
</file>
<file src="src/Monolog/LogsHandler.php">
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to be a bug in Psalm when using const on enums: https://psalm.dev/r/a6f9298b82

<InvalidParamDefault>
<code><![CDATA[value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::*]]></code>
</InvalidParamDefault>
<UndefinedClass>
<code><![CDATA[value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::*]]></code>
</UndefinedClass>
<UndefinedDocblockClass>
<code><![CDATA[value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::*]]></code>
</UndefinedDocblockClass>
<UnresolvableConstant>
<code><![CDATA[value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::*]]></code>
</UnresolvableConstant>
</file>
<file src="src/Tracing/Cache/TraceableCacheAdapterTrait.php">
<LessSpecificImplementedReturnType>
<code><![CDATA[iterable]]></code>
Expand Down
13 changes: 12 additions & 1 deletion src/Monolog/LogsHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

namespace Sentry\SentryBundle\Monolog;

use Monolog\Level as MonologLevel;
use Monolog\Logger as MonologLogger;
use Monolog\LogRecord;
use Psr\Log\LogLevel as PsrLogLevel;
use Sentry\Monolog\CompatibilityLogLevelTrait;
use Sentry\Monolog\LogsHandler as BaseLogsHandler;

Expand All @@ -18,8 +20,17 @@ class LogsHandler extends BaseLogsHandler
{
use CompatibilityLogLevelTrait;

public function __construct(int $level = MonologLogger::DEBUG, bool $bubble = true)
/**
* @param int|string|MonologLevel|PsrLogLevel::* $level
*
* @phpstan-param value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::* $level
*/
public function __construct($level = MonologLogger::DEBUG, bool $bubble = true)
{
$level = MonologLogger::toMonologLevel($level);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will throw if an invalid level is passed. Please default to Info in such a case like getSentryLogLevelFromMonologLevel does. Also this would benefit from a test case.

Copy link
Contributor Author

@HypeMC HypeMC Sep 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Litarnus Done, de332aa

if ($level instanceof MonologLevel) { // Monolog >= 3
$level = $level->value;
}
$logLevel = self::getSentryLogLevelFromMonologLevel($level);
parent::__construct($logLevel, $bubble);
}
Expand Down
36 changes: 36 additions & 0 deletions tests/Monolog/LogsHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

namespace Sentry\SentryBundle\Tests\Monolog;

use Monolog\Level as MonologLevel;
use Monolog\Logger as MonologLogger;
use PHPUnit\Framework\TestCase;
use Psr\Log\LogLevel as PsrLogLevel;
use Sentry\SentryBundle\Monolog\LogsHandler;

final class LogsHandlerTest extends TestCase
Expand Down Expand Up @@ -48,4 +50,38 @@ public function testHandleReturnsTrueAboveThresholdWhenBubbleFalse(): void

$this->assertTrue($handler->handle($record));
}

/**
* @dataProvider levelProvider
*
* @param int|string|MonologLevel $level
*
* @phpstan-param value-of<MonologLevel::VALUES>|value-of<MonologLevel::NAMES>|MonologLevel|PsrLogLevel::* $level
*/
public function testHandlerAcceptsVariousTypesAsLevel($level): void
{
$handler = new LogsHandler($level, false);
$record = [
'level' => MonologLogger::WARNING,
'message' => 'msg',
'context' => [],
'extra' => [],
];

$this->assertTrue($handler->handle($record));
}

/**
* @return iterable<array{0: int|string|MonologLevel}>
*/
public static function levelProvider(): iterable
{
yield [MonologLogger::DEBUG];
yield ['DEBUG'];
yield [PsrLogLevel::DEBUG];

if (class_exists(MonologLevel::class)) {
yield [MonologLevel::Debug];
}
}
}
Loading