Merge pull request #1923 from getsentry/merge-master

Merge master

Author: Litarnus

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+### Description
+<!-- What changed and why? -->
+
+#### Issues
+<!--
+* resolves: #1234
+* resolves: LIN-1234
+-->
+
+#### Reminders
+- Add GH Issue ID _&_ Linear ID
+- PR title should use [conventional commit](https://develop.sentry.dev/engineering-practices/commit-messages/#type) style (`feat:`, `fix:`, `ref:`, `meta:`)
+- For external contributors: [CONTRIBUTING.md](https://github.com/getsentry/sentry-php/blob/master/CONTRIBUTING.md), [Sentry SDK development docs](https://develop.sentry.dev/sdk/), [Discord community](https://discord.gg/Ww9hbqr)

.github/workflows/publish-release.yaml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - name: Get auth token
         id: token
-        uses: actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b # v2.1.1
+        uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
         with:
           app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
           private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}

CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 4.16.0
+
+The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v4.16.0.
+
+### Features
+
+- Remove `max_breadcrumbs` limit. [(#1890)](https://github.com/getsentry/sentry-php/pull/1890)
+- Implement `__destruct` in `LogsHandler` to make sure logs are always flushed. [(#1916)](https://github.com/getsentry/sentry-php/pull/1916)
+
+### Bug Fixes
+
+- Use PSR log level when logging messages using the PSR-3 logger within the SDK. [(#1907)](https://github.com/getsentry/sentry-php/pull/1907)
+- Remove `@internal` annotation from `Sentry\Transport\Result`. [(#1904)](https://github.com/getsentry/sentry-php/pull/1904)
+
+### Misc
+
+- Add `sentry.origin` attribute to `LogsHandler`. [(#1917)](https://github.com/getsentry/sentry-php/pull/1917)
+
 ## 4.15.2
 
 The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v4.15.2.
@@ -30,26 +48,26 @@ The Sentry SDK team is happy to announce the immediate availability of Sentry PH
   use Monolog\Logger;
   use Sentry\Monolog\LogsHandler;
   use Sentry\Logs\LogLevel;
-  
+
   // Initialize Sentry SDK first (make sure 'enable_logs' is set to true)
   \Sentry\init([
       'dsn' => '__YOUR_DSN__',
       'enable_logs' => true,
   ]);
-  
+
   // Create a Monolog logger
   $logger = new Logger('my-app');
-  
+
   // Add the Sentry logs handler
   // Optional: specify minimum log level (defaults to LogLevel::debug())
   $handler = new LogsHandler(LogLevel::info());
   $logger->pushHandler($handler);
-  
+
   // Now your logs will be sent to Sentry
   $logger->info('User logged in', ['user_id' => 123]);
   $logger->error('Payment failed', ['order_id' => 456]);
   ```
-  
+
   Note: The handler will not collect logs for exceptions (they should be handled separately via `captureException`).
 
 ### Bug Fixes

src/Client.php

@@ -32,7 +32,7 @@ class Client implements ClientInterface
     /**
      * The version of the SDK.
      */
-    public const SDK_VERSION = '4.15.2';
+    public const SDK_VERSION = '4.16.0';
 
     /**
      * Regex pattern to detect if a string is a regex pattern (starts and ends with / optionally followed by flags).

src/Logs/Log.php

@@ -82,6 +82,11 @@ public function setLevel(LogLevel $level): self
         return $this;
     }
 
+    public function getPsrLevel(): string
+    {
+        return $this->level->toPsrLevel();
+    }
+
     public function getBody(): string
     {
         return $this->body;

src/Logs/LogLevel.php

@@ -70,6 +70,24 @@ public function getPriority(): int
         return $this->priority;
     }
 
+    public function toPsrLevel(): string
+    {
+        switch ($this->value) {
+            case 'trace':
+            case 'debug':
+                return \Psr\Log\LogLevel::DEBUG;
+            case 'warn':
+                return \Psr\Log\LogLevel::WARNING;
+            case 'error':
+                return \Psr\Log\LogLevel::ERROR;
+            case 'fatal':
+                return \Psr\Log\LogLevel::CRITICAL;
+            case 'info':
+            default:
+                return \Psr\Log\LogLevel::INFO;
+        }
+    }
+
     private static function getInstance(string $value, int $priority): self
     {
         if (!isset(self::$instances[$value])) {

src/Logs/LogsAggregator.php

@@ -147,9 +147,8 @@ public function add(
             return;
         }
 
-        // We check if it's a `LogsLogger` to avoid a infinite loop where the logger is logging the logs it's writing
         if ($sdkLogger !== null) {
-            $sdkLogger->log((string) $log->getLevel(), "Logs item: {$log->getBody()}", $log->attributes()->toSimpleArray());
+            $sdkLogger->log($log->getPsrLevel(), "Logs item: {$log->getBody()}", $log->attributes()->toSimpleArray());
         }
 
         $this->logs[] = $log;

src/Monolog/LogsHandler.php

@@ -66,7 +66,7 @@ public function handle($record): bool
             self::getSentryLogLevelFromMonologLevel($record['level']),
             $record['message'],
             [],
-            array_merge($record['context'], $record['extra'])
+            array_merge($record['context'], $record['extra'], ['sentry.origin' => 'auto.logger.monolog'])
         );
 
         return $this->bubble === false;
@@ -114,4 +114,13 @@ public function getFormatter(): FormatterInterface
         // To adhere to the interface we need to return a formatter so we return a default one
         return new LineFormatter();
     }
+
+    public function __destruct()
+    {
+        try {
+            $this->close();
+        } catch (\Throwable $e) {
+            // Just in case so that the destructor can never fail.
+        }
+    }
 }

tests/Logs/LogTest.php

@@ -32,4 +32,31 @@ public function testGettersAndSetters(): void
         $log->setBody('bar');
         $this->assertSame('bar', $log->getBody());
     }
+
+    /**
+     * @dataProvider logLevelDataProvider
+     */
+    public function testLogLevelToPsrMapping(LogLevel $logLevel, $expected): void
+    {
+        $this->assertSame($expected, $logLevel->toPsrLevel());
+    }
+
+    /**
+     * @dataProvider logLevelDataProvider
+     */
+    public function testLogAndLogLevelConsistent(LogLevel $level, $expected): void
+    {
+        $log = new Log(1.0, '123', $level, 'foo');
+        $this->assertSame($expected, $log->getPsrLevel());
+    }
+
+    public function logLevelDataProvider(): \Generator
+    {
+        yield 'Debug -> Debug' => [LogLevel::debug(), \Psr\Log\LogLevel::DEBUG];
+        yield 'Trace -> Debug' => [LogLevel::trace(), \Psr\Log\LogLevel::DEBUG];
+        yield 'Info -> Info' => [LogLevel::info(), \Psr\Log\LogLevel::INFO];
+        yield 'Warn -> Warning' => [LogLevel::warn(), \Psr\Log\LogLevel::WARNING];
+        yield 'Error -> Error' => [LogLevel::error(), \Psr\Log\LogLevel::ERROR];
+        yield 'Fatal -> Critical' => [LogLevel::fatal(), \Psr\Log\LogLevel::CRITICAL];
+    }
 }

tests/Monolog/LogsHandlerTest.php

@@ -7,25 +7,22 @@
 use Monolog\Logger;
 use PHPUnit\Framework\TestCase;
 use Sentry\ClientBuilder;
+use Sentry\Event;
 use Sentry\Logs\Log;
 use Sentry\Logs\LogLevel;
 use Sentry\Logs\Logs;
 use Sentry\Monolog\LogsHandler;
 use Sentry\SentrySdk;
 use Sentry\State\Hub;
+use Sentry\Transport\Result;
+use Sentry\Transport\ResultStatus;
+use Sentry\Transport\TransportInterface;
 
 final class LogsHandlerTest extends TestCase
 {
     protected function setUp(): void
     {
         Logs::getInstance()->flush();
-    }
-
-    /**
-     * @dataProvider handleDataProvider
-     */
-    public function testHandle($record, Log $expectedLog): void
-    {
         $client = ClientBuilder::create([
             'enable_logs' => true,
             'before_send' => static function () {
@@ -35,7 +32,13 @@ public function testHandle($record, Log $expectedLog): void
 
         $hub = new Hub($client);
         SentrySdk::setCurrentHub($hub);
+    }
 
+    /**
+     * @dataProvider handleDataProvider
+     */
+    public function testHandle($record, Log $expectedLog): void
+    {
         $handler = new LogsHandler();
         $handler->handle($record);
 
@@ -65,21 +68,79 @@ static function (string $key) {
      */
     public function testLogLevels($record, int $countLogs): void
     {
+        $handler = new LogsHandler(LogLevel::warn());
+        $handler->handle($record);
+
+        $logs = Logs::getInstance()->aggregator()->all();
+        $this->assertCount($countLogs, $logs);
+    }
+
+    public function testLogsHandlerDestructor()
+    {
+        $transport = new class implements TransportInterface {
+            private $events = [];
+
+            public function send(Event $event): Result
+            {
+                $this->events[] = $event;
+
+                return new Result(ResultStatus::success());
+            }
+
+            public function close(?int $timeout = null): Result
+            {
+                return new Result(ResultStatus::success());
+            }
+
+            /**
+             * @return Event[]
+             */
+            public function getEvents(): array
+            {
+                return $this->events;
+            }
+        };
         $client = ClientBuilder::create([
             'enable_logs' => true,
-            'before_send' => static function () {
-                return null;
-            },
-        ])->getClient();
+        ])->setTransport($transport)
+            ->getClient();
 
         $hub = new Hub($client);
         SentrySdk::setCurrentHub($hub);
 
+        $this->handleLogAndDrop();
+
+        $this->assertCount(1, $transport->getEvents());
+        $this->assertSame('I was dropped :(', $transport->getEvents()[0]->getLogs()[0]->getBody());
+    }
+
+    private function handleLogAndDrop(): void
+    {
+        $handler = new LogsHandler();
+        $handler->handle(RecordFactory::create('I was dropped :(', Logger::INFO, 'chanel.foo', [], []));
+    }
+
+    public function testOriginTagAppliedWithHandler(): void
+    {
         $handler = new LogsHandler(LogLevel::warn());
-        $handler->handle($record);
+        $handler->handle(RecordFactory::create('with origin', Logger::WARNING, 'channel.foo', [], []));
 
         $logs = Logs::getInstance()->aggregator()->all();
-        $this->assertCount($countLogs, $logs);
+        $this->assertCount(1, $logs);
+        $log = $logs[0];
+        $this->assertArrayHasKey('sentry.origin', $log->attributes()->toSimpleArray());
+        $this->assertSame('auto.logger.monolog', $log->attributes()->toSimpleArray()['sentry.origin']);
+    }
+
+    public function testOriginTagNotAppliedWhenUsingDirectly()
+    {
+        \Sentry\logger()->info('No origin attribute');
+
+        $logs = Logs::getInstance()->aggregator()->all();
+        $this->assertCount(1, $logs);
+        $log = $logs[0];
+        $this->assertSame('No origin attribute', $log->getBody());
+        $this->assertArrayNotHasKey('sentry.origin', $log->attributes()->toSimpleArray());
     }
 
     public static function handleDataProvider(): iterable