Merge branch '5.x' into martinl/options-resolver

Litarnus · Litarnus · commit 531869dd0244 · 2025-09-25T16:42:33.000+02:00
# Conflicts:
#	src/Event.php
#	src/EventHint.php
#	src/Integration/IntegrationRegistry.php
#	src/Options.php
#	src/Stacktrace.php
#	src/State/Scope.php
#	src/UserDataBag.php
diff --git a/.github/pull_request_template.md b/.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)
diff --git a/.github/workflows/publish-release.yaml b/.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 }}
diff --git a/CHANGELOG.md b/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
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,5 +1,8 @@
 parameters:
 	ignoreErrors:
+		-
+			message: "#.*#"
+			path: src/Util/DebugType.php
 		-
 			message: "#^Method Sentry\\\\Client\\:\\:getIntegration\\(\\) should return \\(T of Sentry\\\\Integration\\\\IntegrationInterface\\)\\|null but returns \\(T of Sentry\\\\Integration\\\\IntegrationInterface\\)\\|null\\.$#"
 			count: 1
@@ -165,11 +168,6 @@ parameters:
 			count: 1
 			path: src/Options.php
 
-		-
-			message: "#^Method Sentry\\\\Options\\:\\:getMaxValueLength\\(\\) should return int but returns mixed\\.$#"
-			count: 1
-			path: src/Options.php
-
 		-
 			message: "#^Method Sentry\\\\Options\\:\\:getOrgId\\(\\) should return int\\|null but returns mixed\\.$#"
 			count: 1
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -10,6 +10,7 @@
         <directory name="src" />
         <ignoreFiles>
             <directory name="vendor" />
+            <file name="src/Util/DebugType.php" />
         </ignoreFiles>
     </projectFiles>
 
diff --git a/src/Client.php b/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).
diff --git a/src/Event.php b/src/Event.php
@@ -9,6 +9,7 @@
 use Sentry\Logs\Log;
 use Sentry\Profiling\Profile;
 use Sentry\Tracing\Span;
+use Sentry\Util\DebugType;
 
 /**
  * This is the base class for classes containing event data.
@@ -802,7 +803,7 @@ public function setExceptions(array $exceptions): self
     {
         foreach ($exceptions as $exception) {
             if (!$exception instanceof ExceptionDataBag) {
-                throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', ExceptionDataBag::class, \gettype($exception)));
+                throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', ExceptionDataBag::class, DebugType::getDebugType($exception)));
             }
         }
 
diff --git a/src/EventHint.php b/src/EventHint.php
@@ -4,6 +4,8 @@
 
 namespace Sentry;
 
+use Sentry\Util\DebugType;
+
 /**
  * This class represents hints on how to process an event.
  */
@@ -56,19 +58,19 @@ public static function fromArray(array $hintData): self
         $extra = $hintData['extra'] ?? [];
 
         if ($exception !== null && !$exception instanceof \Throwable) {
-            throw new \InvalidArgumentException(\sprintf('The value of the "exception" field must be an instance of a class implementing the "%s" interface. Got: "%s".', \Throwable::class, \gettype($exception)));
+            throw new \InvalidArgumentException(\sprintf('The value of the "exception" field must be an instance of a class implementing the "%s" interface. Got: "%s".', \Throwable::class, DebugType::getDebugType($exception)));
         }
 
         if ($mechanism !== null && !$mechanism instanceof ExceptionMechanism) {
-            throw new \InvalidArgumentException(\sprintf('The value of the "mechanism" field must be an instance of the "%s" class. Got: "%s".', ExceptionMechanism::class, \gettype($mechanism)));
+            throw new \InvalidArgumentException(\sprintf('The value of the "mechanism" field must be an instance of the "%s" class. Got: "%s".', ExceptionMechanism::class, DebugType::getDebugType($mechanism)));
         }
 
         if ($stacktrace !== null && !$stacktrace instanceof Stacktrace) {
-            throw new \InvalidArgumentException(\sprintf('The value of the "stacktrace" field must be an instance of the "%s" class. Got: "%s".', Stacktrace::class, \gettype($stacktrace)));
+            throw new \InvalidArgumentException(\sprintf('The value of the "stacktrace" field must be an instance of the "%s" class. Got: "%s".', Stacktrace::class, DebugType::getDebugType($stacktrace)));
         }
 
         if (!\is_array($extra)) {
-            throw new \InvalidArgumentException(\sprintf('The value of the "extra" field must be an array. Got: "%s".', \gettype($extra)));
+            throw new \InvalidArgumentException(\sprintf('The value of the "extra" field must be an array. Got: "%s".', DebugType::getDebugType($extra)));
         }
 
         $hint->exception = $exception;
diff --git a/src/Integration/IntegrationRegistry.php b/src/Integration/IntegrationRegistry.php
@@ -6,6 +6,7 @@
 
 use Psr\Log\LoggerInterface;
 use Sentry\Options;
+use Sentry\Util\DebugType;
 
 /**
  * @internal
@@ -123,7 +124,7 @@ private function getIntegrationsToSetup(Options $options): array
             $integrations = $userIntegrations($defaultIntegrations);
 
             if (!\is_array($integrations)) {
-                throw new \UnexpectedValueException(\sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', \gettype($integrations)));
+                throw new \UnexpectedValueException(\sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', DebugType::getDebugType($integrations)));
             }
         }
 
diff --git a/src/Logs/Log.php b/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;
diff --git a/src/Logs/LogLevel.php b/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])) {
diff --git a/src/Logs/LogsAggregator.php b/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;
diff --git a/src/Monolog/LogsHandler.php b/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.
+        }
+    }
 }
diff --git a/src/Serializer/AbstractSerializer.php b/src/Serializer/AbstractSerializer.php
@@ -223,10 +223,6 @@ protected function serializeString(string $value): string
             $encoded = mb_convert_encoding($value, 'UTF-8') ?: '<encoding error>';
         }
 
-        if (mb_strlen($encoded) > $this->options->getMaxValueLength()) {
-            $encoded = mb_substr($encoded, 0, $this->options->getMaxValueLength() - 10, 'UTF-8') . ' {clipped}';
-        }
-
         return $encoded;
     }
 
diff --git a/src/Stacktrace.php b/src/Stacktrace.php
@@ -4,6 +4,8 @@
 
 namespace Sentry;
 
+use Sentry\Util\DebugType;
+
 /**
  * This class contains all the information about an error stacktrace.
  *
@@ -31,7 +33,7 @@ public function __construct(array $frames)
 
         foreach ($frames as $frame) {
             if (!$frame instanceof Frame) {
-                throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', Frame::class, \gettype($frame)));
+                throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', Frame::class, DebugType::getDebugType($frame)));
             }
         }
 
diff --git a/src/State/Scope.php b/src/State/Scope.php
@@ -14,6 +14,7 @@
 use Sentry\Tracing\Span;
 use Sentry\Tracing\Transaction;
 use Sentry\UserDataBag;
+use Sentry\Util\DebugType;
 
 /**
  * The scope holds data that should implicitly be sent with Sentry events. It
@@ -208,7 +209,7 @@ public function getUser(): ?UserDataBag
     public function setUser($user): self
     {
         if (!\is_array($user) && !$user instanceof UserDataBag) {
-            throw new \TypeError(\sprintf('The $user argument must be either an array or an instance of the "%s" class. Got: "%s".', UserDataBag::class, \gettype($user)));
+            throw new \TypeError(\sprintf('The $user argument must be either an array or an instance of the "%s" class. Got: "%s".', UserDataBag::class, DebugType::getDebugType($user)));
         }
 
         if (\is_array($user)) {
diff --git a/src/UserDataBag.php b/src/UserDataBag.php
@@ -4,6 +4,8 @@
 
 namespace Sentry;
 
+use Sentry\Util\DebugType;
+
 /**
  * This class stores the information about the authenticated user for a request.
  *
@@ -123,7 +125,7 @@ public function getId()
     public function setId($id): self
     {
         if ($id !== null && !\is_string($id) && !\is_int($id)) {
-            throw new \UnexpectedValueException(\sprintf('Expected an integer or string value for the $id argument. Got: "%s".', \gettype($id)));
+            throw new \UnexpectedValueException(\sprintf('Expected an integer or string value for the $id argument. Got: "%s".', DebugType::getDebugType($id)));
         }
 
         $this->id = $id;
diff --git a/src/Util/DebugType.php b/src/Util/DebugType.php
@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * Original Code: https://github.com/symfony/polyfill/blob/1.x/src/Php80/Php80.php
+ *
+ * Copyright (c) 2015-present Fabien Potencier
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+declare(strict_types=1);
+
+namespace Sentry\Util;
+
+/**
+ * @internal
+ */
+final class DebugType
+{
+    /**
+     * @param mixed $value
+     */
+    public static function getDebugType($value): string
+    {
+        if (\function_exists('get_debug_type')) {
+            return get_debug_type($value);
+        }
+
+        switch (true) {
+            case $value === null: return 'null';
+            case \is_bool($value): return 'bool';
+            case \is_string($value): return 'string';
+            case \is_array($value): return 'array';
+            case \is_int($value): return 'int';
+            case \is_float($value): return 'float';
+            case \is_object($value): break;
+            case $value instanceof \__PHP_Incomplete_Class: return '__PHP_Incomplete_Class';
+            default:
+                if (null === $type = @get_resource_type($value)) {
+                    return 'unknown';
+                }
+
+                if ($type === 'Unknown') {
+                    $type = 'closed';
+                }
+
+                return "resource ($type)";
+        }
+
+        $class = \get_class($value);
+
+        if (strpos($class, '@') === false) {
+            return $class;
+        }
+
+        return (get_parent_class($class) ?: key(class_implements($class)) ?: 'class') . '@anonymous';
+    }
+}
diff --git a/tests/Logs/LogTest.php b/tests/Logs/LogTest.php
diff --git a/tests/Monolog/LogsHandlerTest.php b/tests/Monolog/LogsHandlerTest.php
diff --git a/tests/OptionsTest.php b/tests/OptionsTest.php
diff --git a/tests/Serializer/AbstractSerializerTest.php b/tests/Serializer/AbstractSerializerTest.php
diff --git a/tests/Serializer/SerializerTest.php b/tests/Serializer/SerializerTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use Sentry\Logs\Log;`
`10`	`10`	`use Sentry\Profiling\Profile;`
`11`	`11`	`use Sentry\Tracing\Span;`
	`12`	`+use Sentry\Util\DebugType;`
`12`	`13`
`13`	`14`	`/**`
`14`	`15`	`* This is the base class for classes containing event data.`
`@@ -802,7 +803,7 @@ public function setExceptions(array $exceptions): self`
`802`	`803`	`{`
`803`	`804`	`foreach ($exceptions as $exception) {`
`804`	`805`	`if (!$exception instanceof ExceptionDataBag) {`
`805`		`- throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', ExceptionDataBag::class, \gettype($exception)));`
	`806`	`+ throw new \UnexpectedValueException(\sprintf('Expected an instance of the "%s" class. Got: "%s".', ExceptionDataBag::class, DebugType::getDebugType($exception)));`
`806`	`807`	`}`
`807`	`808`	`}`
`808`	`809`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use Psr\Log\LoggerInterface;`
`8`	`8`	`use Sentry\Options;`
	`9`	`+use Sentry\Util\DebugType;`
`9`	`10`
`10`	`11`	`/**`
`11`	`12`	`* @internal`
`@@ -123,7 +124,7 @@ private function getIntegrationsToSetup(Options $options): array`
`123`	`124`	`$integrations = $userIntegrations($defaultIntegrations);`
`124`	`125`
`125`	`126`	`if (!\is_array($integrations)) {`
`126`		`- throw new \UnexpectedValueException(\sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', \gettype($integrations)));`
	`127`	`+ throw new \UnexpectedValueException(\sprintf('Expected the callback set for the "integrations" option to return a list of integrations. Got: "%s".', DebugType::getDebugType($integrations)));`
`127`	`128`	`}`
`128`	`129`	`}`
`129`	`130`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,11 @@ public function setLevel(LogLevel $level): self`
`82`	`82`	`return $this;`
`83`	`83`	`}`
`84`	`84`
	`85`	`+ public function getPsrLevel(): string`
	`86`	`+ {`
	`87`	`+ return $this->level->toPsrLevel();`
	`88`	`+ }`
	`89`	`+`
`85`	`90`	`public function getBody(): string`
`86`	`91`	`{`
`87`	`92`	`return $this->body;`