refactor(sentry): improve span lifecycle management and code clarity

src/sentry/publish/sentry.php

@@ -59,7 +59,10 @@
     ],
 
     'breadcrumbs' => [
+        'async_queue' => env('SENTRY_BREADCRUMBS_ASYNC_QUEUE', true),
         'cache' => env('SENTRY_BREADCRUMBS_CACHE', true),
+        'command' => env('SENTRY_BREADCRUMBS_COMMAND', true),
+        'command_input' => env('SENTRY_BREADCRUMBS_COMMAND_INPUT', true),
         'sql_queries' => env('SENTRY_BREADCRUMBS_SQL_QUERIES', true),
         'sql_bindings' => env('SENTRY_BREADCRUMBS_SQL_BINDINGS', true),
         'sql_transaction' => env('SENTRY_BREADCRUMBS_SQL_TRANSACTION', true),
@@ -113,6 +116,7 @@
             'exception.stack_trace' => true,
             'amqp.result' => false,
             'annotation.result' => false,
+            'db.sql.bindings' => true,
             'db.result' => false,
             'elasticsearch.result' => false,
             'http.response.body.contents' => false,

src/sentry/src/Aspect/CacheAspect.php

@@ -40,7 +40,7 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
         $startTime = microtime(true);
 
         return tap($proceedingJoinPoint->process(), function ($result) use ($proceedingJoinPoint, $startTime) {
-            if (! $this->switcher->isBreadcrumbEnable('cache')) {
+            if (! $this->switcher->isBreadcrumbEnabled('cache')) {
                 return;
             }
             $arguments = $proceedingJoinPoint->arguments['keys'];

src/sentry/src/Aspect/GuzzleHttpClientAspect.php

@@ -36,7 +36,7 @@ public function __construct(protected Switcher $switcher)
     public function process(ProceedingJoinPoint $proceedingJoinPoint)
     {
         // If the guzzle aspect is disabled, we will not record the request.
-        if (! $this->switcher->isBreadcrumbEnable('guzzle')) {
+        if (! $this->switcher->isBreadcrumbEnabled('guzzle')) {
             return $proceedingJoinPoint->process();
         }
 

src/sentry/src/Aspect/LoggerAspect.php

@@ -39,7 +39,7 @@ public function __construct(protected Switcher $switcher)
     public function process(ProceedingJoinPoint $proceedingJoinPoint)
     {
         return tap($proceedingJoinPoint->process(), function ($result) use ($proceedingJoinPoint) {
-            if (! $this->switcher->isBreadcrumbEnable('logs')) {
+            if (! $this->switcher->isBreadcrumbEnabled('logs')) {
                 return;
             }
 

src/sentry/src/Aspect/RedisAspect.php

@@ -42,7 +42,7 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
         return tap($proceedingJoinPoint->process(), function ($result) use ($arguments, $startTime) {
             if (
                 class_exists(CommandExecuted::class)
-                || ! $this->switcher->isBreadcrumbEnable('redis')
+                || ! $this->switcher->isBreadcrumbEnabled('redis')
             ) {
                 return;
             }

src/sentry/src/Crons/Listener/EventHandleListener.php

@@ -44,7 +44,7 @@ public function listen(): array
      */
     public function process(object $event): void
     {
-        if (! $this->switcher->isCronsEnable()) {
+        if (! $this->switcher->isCronsEnabled()) {
             return;
         }
 

src/sentry/src/Listener/EventHandleListener.php

@@ -33,8 +33,15 @@
 use Psr\Container\ContainerInterface;
 use Sentry\Breadcrumb;
 use Sentry\SentrySdk;
+use Sentry\State\Scope;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Input\InputInterface;
 use Throwable;
 
+/**
+ * @property InputInterface $input
+ * @property int $exitCode
+ */
 class EventHandleListener implements ListenerInterface
 {
     public const HUB = 'sentry.context.hub';
@@ -156,7 +163,6 @@ public function process(object $event): void
 
             // Command events
             CommandEvent\BeforeHandle::class => $this->handleCommandStarting($event),
-            CommandEvent\FailToHandle::class => $this->handleCommandFailed($event),
             CommandEvent\AfterExecute::class => $this->handleCommandFinished($event),
 
             // Async Queue events
@@ -233,8 +239,8 @@ protected function setupRequestLifecycle(): void
         }
 
         if (
-            ! $this->switcher->isEnable('request')
-            && ! $this->switcher->isTracingEnable('request')
+            ! $this->switcher->isEnabled('request')
+            && ! $this->switcher->isTracingEnabled('request')
         ) {
             return;
         }
@@ -277,7 +283,7 @@ protected function setupRedisEventEnable(): void
      */
     protected function handleDbQueryExecuted(object $event): void
     {
-        if (! $this->switcher->isBreadcrumbEnable('sql_queries')) {
+        if (! $this->switcher->isBreadcrumbEnabled('sql_queries')) {
             return;
         }
 
@@ -287,7 +293,7 @@ protected function handleDbQueryExecuted(object $event): void
             $data['executionTimeMs'] = $event->time;
         }
 
-        if ($this->switcher->isBreadcrumbEnable('sql_bindings')) {
+        if ($this->switcher->isBreadcrumbEnabled('sql_bindings')) {
             $data['bindings'] = $event->bindings;
         }
 
@@ -305,7 +311,7 @@ protected function handleDbQueryExecuted(object $event): void
      */
     protected function handleDbTransaction(object $event): void
     {
-        if (! $this->switcher->isBreadcrumbEnable('sql_transaction')) {
+        if (! $this->switcher->isBreadcrumbEnabled('sql_transaction')) {
             return;
         }
 
@@ -325,7 +331,7 @@ protected function handleDbTransaction(object $event): void
      */
     protected function handleRedisCommandExecuted(object $event): void
     {
-        if (! $this->switcher->isBreadcrumbEnable('redis')) {
+        if (! $this->switcher->isBreadcrumbEnabled('redis')) {
             return;
         }
 
@@ -347,7 +353,7 @@ protected function handleRedisCommandExecuted(object $event): void
      */
     protected function handleRequestReceived(object $event): void
     {
-        if (! $this->switcher->isEnable('request')) {
+        if (! $this->switcher->isEnabled('request')) {
             return;
         }
 
@@ -359,7 +365,7 @@ protected function handleRequestReceived(object $event): void
      */
     protected function handleRequestTerminated(object $event): void
     {
-        if (! $this->switcher->isEnable('request')) {
+        if (! $this->switcher->isEnabled('request')) {
             return;
         }
 
@@ -372,56 +378,108 @@ protected function handleRequestTerminated(object $event): void
      */
     protected function handleCommandStarting(object $event): void
     {
-        if (! $this->switcher->isEnable('command')) {
+        if (! $this->switcher->isEnabled('command')) {
             return;
         }
 
         $this->setupSentrySdk();
-    }
 
-    /**
-     * @param CommandEvent\FailToHandle $event
-     */
-    protected function handleCommandFailed(object $event): void
-    {
-        if (! $this->switcher->isEnable('command')) {
-            return;
-        }
+        Integration::configureScope(static function (Scope $scope) use ($event): void {
+            $scope->setTag('command', $event->getCommand()->getName());
+        });
 
-        $this->captureException($event->getThrowable());
-        $this->flushEvents();
+        if ($this->switcher->isBreadcrumbEnabled('command')) {
+            $data = [];
+            if ($this->switcher->isBreadcrumbEnabled('command_input')) {
+                /** @var InputInterface $input */
+                $input = (fn () => $this->input)->call($event->getCommand());
+                $data['input'] = $this->extractConsoleCommandInput($input);
+            }
+
+            Integration::addBreadcrumb(new Breadcrumb(
+                Breadcrumb::LEVEL_INFO,
+                Breadcrumb::TYPE_DEFAULT,
+                'command',
+                'Starting command: ' . $event->getCommand()->getName(),
+                $data
+            ));
+        }
     }
 
     /**
      * @param CommandEvent\AfterExecute $event
      */
     protected function handleCommandFinished(object $event): void
     {
-        if (! $this->switcher->isEnable('command')) {
+        if (! $this->switcher->isEnabled('command')) {
             return;
         }
 
+        if ($this->switcher->isBreadcrumbEnabled('command')) {
+            /** @var InputInterface $input */
+            /** @var int $exitCode */
+            [$input, $exitCode] = (function () {
+                return [
+                    $this->input,
+                    $this->exitCode,
+                ];
+            })->call($event->getCommand());
+            $data = ['exit' => $exitCode];
+
+            if ($this->switcher->isBreadcrumbEnabled('command_input')) {
+                $data['input'] = $this->extractConsoleCommandInput($input);
+            }
+
+            Integration::addBreadcrumb(new Breadcrumb(
+                Breadcrumb::LEVEL_INFO,
+                Breadcrumb::TYPE_DEFAULT,
+                'command',
+                'Finished command: ' . $event->getCommand()->getName(),
+                $data
+            ));
+        }
+
+        $this->captureException($event->getThrowable());
         $this->flushEvents();
+
+        Integration::configureScope(static function (Scope $scope): void {
+            $scope->removeTag('command');
+        });
     }
 
     /**
      * @param AsyncQueueEvent\BeforeHandle $event
      */
     protected function handleAsyncQueueJobProcessing(object $event): void
     {
-        if (! $this->switcher->isEnable('async_queue')) {
+        if (! $this->switcher->isEnabled('async_queue')) {
             return;
         }
 
         $this->setupSentrySdk();
+
+        if ($this->switcher->isBreadcrumbEnabled('async_queue')) {
+            $job = [
+                'job' => $event->getMessage()->job()::class,
+                'attempts' => $event->getMessage()->getAttempts(),
+            ];
+
+            Integration::addBreadcrumb(new Breadcrumb(
+                Breadcrumb::LEVEL_INFO,
+                Breadcrumb::TYPE_DEFAULT,
+                'queue.job',
+                'Processing async_queue job',
+                $job
+            ));
+        }
     }
 
     /**
      * @param AsyncQueueEvent\AfterHandle $event
      */
     protected function handleAsyncQueueJobProcessed(object $event): void
     {
-        if (! $this->switcher->isEnable('async_queue')) {
+        if (! $this->switcher->isEnabled('async_queue')) {
             return;
         }
 
@@ -433,7 +491,7 @@ protected function handleAsyncQueueJobProcessed(object $event): void
      */
     protected function handleAsyncQueueJobRetryOrFailed(object $event): void
     {
-        if (! $this->switcher->isEnable('async_queue')) {
+        if (! $this->switcher->isEnabled('async_queue')) {
             return;
         }
 
@@ -446,7 +504,7 @@ protected function handleAsyncQueueJobRetryOrFailed(object $event): void
      */
     protected function handleCrontabTaskStarting(object $event): void
     {
-        if (! $this->switcher->isEnable('crontab')) {
+        if (! $this->switcher->isEnabled('crontab')) {
             return;
         }
 
@@ -458,7 +516,7 @@ protected function handleCrontabTaskStarting(object $event): void
      */
     protected function handleCrontabTaskFinished(object $event): void
     {
-        if (! $this->switcher->isEnable('crontab')) {
+        if (! $this->switcher->isEnabled('crontab')) {
             return;
         }
 
@@ -470,7 +528,7 @@ protected function handleCrontabTaskFinished(object $event): void
      */
     protected function handleCrontabTaskFailed(object $event): void
     {
-        if (! $this->switcher->isEnable('crontab')) {
+        if (! $this->switcher->isEnabled('crontab')) {
             return;
         }
 
@@ -483,7 +541,7 @@ protected function handleCrontabTaskFailed(object $event): void
      */
     protected function handleAmqpMessageProcessing(object $event): void
     {
-        if (! $this->switcher->isEnable('amqp')) {
+        if (! $this->switcher->isEnabled('amqp')) {
             return;
         }
 
@@ -495,7 +553,7 @@ protected function handleAmqpMessageProcessing(object $event): void
      */
     protected function handleAmqpMessageProcessed(object $event): void
     {
-        if (! $this->switcher->isEnable('amqp')) {
+        if (! $this->switcher->isEnabled('amqp')) {
             return;
         }
 
@@ -507,7 +565,7 @@ protected function handleAmqpMessageProcessed(object $event): void
      */
     protected function handleAmqpMessageFailed(object $event): void
     {
-        if (! $this->switcher->isEnable('amqp')) {
+        if (! $this->switcher->isEnabled('amqp')) {
             return;
         }
 
@@ -520,7 +578,7 @@ protected function handleAmqpMessageFailed(object $event): void
      */
     protected function handleKafkaMessageProcessing(object $event): void
     {
-        if (! $this->switcher->isEnable('kafka')) {
+        if (! $this->switcher->isEnabled('kafka')) {
             return;
         }
 
@@ -532,7 +590,7 @@ protected function handleKafkaMessageProcessing(object $event): void
      */
     protected function handleKafkaMessageProcessed(object $event): void
     {
-        if (! $this->switcher->isEnable('kafka')) {
+        if (! $this->switcher->isEnabled('kafka')) {
             return;
         }
 
@@ -544,11 +602,23 @@ protected function handleKafkaMessageProcessed(object $event): void
      */
     protected function handleKafkaMessageFailed(object $event): void
     {
-        if (! $this->switcher->isEnable('kafka')) {
+        if (! $this->switcher->isEnabled('kafka')) {
             return;
         }
 
         $this->captureException($event->getThrowable());
         $this->flushEvents();
     }
+
+    /**
+     * Extract the command input arguments if possible.
+     */
+    private function extractConsoleCommandInput(?InputInterface $input): ?string
+    {
+        if ($input instanceof ArgvInput) {
+            return (string) $input;
+        }
+
+        return null;
+    }
 }