Support ignore commands (#389)

Co-authored-by: Deeka Wong <[email protected]>
friendsofhyperf · Oct 30, 2023 · 834e9e5 · 834e9e5
1 parent 128da78
commit 834e9e5
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/publish/sentry.php b/publish/sentry.php
@@ -63,6 +63,10 @@
         'GET /health',
     ],
 
+    'ignore_commands' => [
+        'tinker',
+    ],
+
     // Performance monitoring specific configuration
     'tracing' => [
         'enable' => [

diff --git a/src/Factory/ClientBuilderFactory.php b/src/Factory/ClientBuilderFactory.php
@@ -24,6 +24,7 @@ class ClientBuilderFactory
 {
     public const SPECIFIC_OPTIONS = [
         'breadcrumbs',
+        'ignore_commands',
         'integrations',
         'enable',
         'tracing',

diff --git a/src/Tracing/Listener/TracingCommandListener.php b/src/Tracing/Listener/TracingCommandListener.php
@@ -16,6 +16,7 @@
 use FriendsOfHyperf\Sentry\Tracing\TraceContext;
 use Hyperf\Command\Event\AfterExecute;
 use Hyperf\Command\Event\BeforeHandle;
+use Hyperf\Contract\ConfigInterface;
 use Hyperf\Event\Contract\ListenerInterface;
 use Sentry\SentrySdk;
 use Sentry\State\HubInterface;
@@ -30,10 +31,14 @@
  */
 class TracingCommandListener implements ListenerInterface
 {
+    protected array $ignoreCommands = [];
+
     public function __construct(
+        ConfigInterface $config,
         protected Switcher $switcher,
         protected TagManager $tagManager
     ) {
+        $this->ignoreCommands = $config->get('sentry.ignore_commands', []);
     }
 
     public function listen(): array
@@ -49,6 +54,10 @@ public function listen(): array
      */
     public function process(object $event): void
     {
+        if (in_array($event->getCommand()->getName(), $this->ignoreCommands)) {
+            return;
+        }
+
         $sentry = SentrySdk::getCurrentHub();
 
         match ($event::class) {