feat: Added support for scope parameter

README.md

@@ -32,6 +32,13 @@ $options = [
  'sample_rate' => 1,
  'http_timeout' => 0.5,
  ],
+ 'scope_user' => [
+ 'id' => 10,
+ 'username' => '丹',
+ ],
+ 'scope_tags' => [
+ 'game_role' => '菜鸟',
+ ],
 ];
 ErrorHandler::init($options);
 ```

README_EN.md

@@ -32,6 +32,13 @@ $options = [
  'sample_rate' => 1,
  'http_timeout' => 0.5,
  ],
+ 'scope_user' => [
+ 'id' => 10,
+ 'username' => 'dan',
+ ],
+ 'scope_tags' => [
+ 'game_role' => 'rookie',
+ ],
 ];
 ErrorHandler::init($options);
 ```

composer.json

@@ -1,13 +1,15 @@
 {
- "name": "gaowei-space\/error-handler",
+ "name": "gaowei-space/error-handler",
  "description": "ErrorHandler is used to catch all php runtime errors and supports reporting to monolog or sentry.",
  "license": "MIT",
+ "homepage": "https://github.com/gaowei-space/error-handler",
  "authors": [
  {
  "name": "gaowei",
  "email": "[email protected]"
  }
  ],
+ "version": "1.2.0",
  "require": {
  "php": "^7.2|^8.0",
  "sentry/sdk": "^3.2",

examples/ErrorHandlerExample.php

@@ -52,6 +52,13 @@ public function testInitForSentry($code)
  'sample_rate' => 1, // report rate, float range 0-1
  'http_timeout' => 0.5,
  ],
+ 'scope_user' => [
+ 'id' => 100,
+ 'username' => 'dan',
+ ],
+ 'scope_tags' => [
+ 'game_role' => 'rookie'
+ ],
  ];
  ErrorHandler::init($options);
 
@@ -70,6 +77,13 @@ public function testCaptureMessageForSentry($message, $level)
  'sample_rate' => 1, // report rate, float range 0-1
  'http_timeout' => 0.5,
  ],
+ 'scope_user' => [
+ 'id' => 100,
+ 'username' => 'dan',
+ ],
+ 'scope_tags' => [
+ 'game_role' => 'rookie'
+ ],
  ];
  ErrorHandler::create($options)->captureMessage($message, $level);
  }

src/ErrorHandler.php

@@ -5,11 +5,11 @@
  *
  * @author gaowei <[email protected]>
  *
- * @version 1.0.2
+ * @version 1.2.0
  *
  * @copyright gaowei
  * @created_at 2022-05-26
- * @updated_at 2022-08-01
+ * @updated_at 2023-04-12
  */
 
 namespace GaoweiSpace\ErrorHandler;
@@ -19,18 +19,22 @@
 class ErrorHandler
 {
  public $logger;
- public $handler = 'logger'; // logger | sentry
+ public $handler  = 'logger'; // logger | sentry
  public $display_errors = false;
  public $sentry_options = [];
- public $report_level = E_ALL;
+ public $report_level = E_ALL;
+ public $scope_user = [];
+ public $scope_tags = [];
 
  public function __construct(array $options = [])
  {
  $this->display_errors = $options['display_errors'];
- $this->handler = $options['handler'];
- $this->logger = $options['logger'];
+ $this->handler  = $options['handler'];
+ $this->logger  = $options['logger'];
  $this->sentry_options = $options['sentry_options'];
- $this->report_level = $options['report_level'];
+ $this->report_level = $options['report_level'];
+ $this->scope_user = $options['scope_user'];
+ $this->scope_tags = $options['scope_tags'];
  }
 
  public static function init(array $options = [])
@@ -58,6 +62,8 @@ private static function _setDefaultOptions(array &$options)
  'sentry_options' => [],
  'display_errors' => false,
  'report_level' => E_ALL,
+ 'scope_user' => [],
+ 'scope_tags' => [],
  ], $options);
  }
 
@@ -146,9 +152,29 @@ private function _sentryCaptureException(\Throwable $exception)
  }
 
  \Sentry\init($this->sentry_options);
+
+ $this->_setScope();
+
  \Sentry\captureException($exception);
  }
 
+ private function _setScope()
+ {
+ $scope_user = $this->scope_user;
+ $scope_tags = $this->scope_tags;
+ if (!$scope_user && !$scope_tags) {
+ return false;
+ }
+
+ \Sentry\configureScope(function (\Sentry\State\Scope $scope) use ($scope_user, $scope_tags): void {
+ $scope->setUser($scope_user);
+
+ foreach ($scope_tags as $tag_name => $tag_value) {
+ $scope->setTag($tag_name, $tag_value);
+ }
+ });
+ }
+
  private function _sentryCaptureMessage($message, $level)
  {
  $this->_sentryCaptureException(new \ErrorException($message, 0, $this->_getErrorType($level)));