Improved error processing and service naming

src/Spryker/Service/Opentelemetry/Instrumentation/SprykerInstrumentationBootstrap.php

@@ -12,6 +12,7 @@
 use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
 use OpenTelemetry\API\Trace\SpanInterface;
 use OpenTelemetry\API\Trace\SpanKind;
+use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Contrib\Grpc\GrpcTransportFactory;
 use OpenTelemetry\Contrib\Otlp\OtlpUtil;
@@ -33,7 +34,9 @@
 use Spryker\Service\Opentelemetry\Instrumentation\SpanProcessor\PostFilterBatchSpanProcessor;
 use Spryker\Service\Opentelemetry\Instrumentation\Tracer\TracerProvider;
 use Spryker\Service\Opentelemetry\OpentelemetryInstrumentationConfig;
+use Spryker\Service\Opentelemetry\Plugin\OpentelemetryMonitoringExtensionPlugin;
 use Spryker\Service\Opentelemetry\Storage\CustomParameterStorage;
+use Spryker\Service\Opentelemetry\Storage\ExceptionStorage;
 use Spryker\Service\Opentelemetry\Storage\ResourceNameStorage;
 use Spryker\Service\Opentelemetry\Storage\RootSpanNameStorage;
 use Spryker\Shared\Opentelemetry\Instrumentation\CachedInstrumentation;
@@ -295,20 +298,32 @@ protected static function formatSpanName(Request $request): string
     public static function shutdownHandler(): void
     {
         $resourceName = ResourceNameStorage::getInstance()->getName();
+        $customParamsStorage = CustomParameterStorage::getInstance();
         if ($resourceName) {
+            if ($customParamsStorage->getAttribute(OpentelemetryMonitoringExtensionPlugin::ATTRIBUTE_IS_CONSOLE_COMMAND)) {
+                $resourceName = sprintf('CLI %s', $resourceName);
+            }
             static::$resourceInfo->setServiceName($resourceName);
         }
         $scope = Context::storage()->scope();
         if (!$scope) {
             return;
         }
+
         $scope->detach();
         $span = static::$rootSpan;
         $name = RootSpanNameStorage::getInstance()->getName();
         if ($name) {
             $span->updateName($name);
         }
-        $customParamsStorage = CustomParameterStorage::getInstance();
+
+        $exceptions = ExceptionStorage::getInstance()->getExceptions();
+        foreach ($exceptions as $exception) {
+            $span->recordException($exception);
+        }
+
+        $span->setStatus($exceptions ? StatusCode::STATUS_ERROR : StatusCode::STATUS_OK);
+
         $span->setAttributes($customParamsStorage->getAttributes());
         $span->end();
     }

src/Spryker/Service/Opentelemetry/OpentelemetryService.php

@@ -9,6 +9,7 @@
 
 use Spryker\Service\Kernel\AbstractService;
 use Spryker\Service\Opentelemetry\Storage\ResourceNameStorage;
+use Throwable;
 
 /**
  * @method \Spryker\Service\Opentelemetry\OpentelemetryServiceFactory getFactory()
@@ -31,6 +32,10 @@ public function setCustomParameter(string $key, $value): void
     }
 
     /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
      * @param string $name
      *
      * @return void
@@ -41,6 +46,10 @@ public function setRootSpanName(string $name): void
     }
 
     /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
      * @param string $name
      *
      * @return void
@@ -49,4 +58,19 @@ public function setResourceName(string $name): void
     {
        $this->getFactory()->createResourceNameStorage()->setName($name);
     }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param string $message
+     * @param \Throwable $exception
+     *
+     * @return void
+     */
+    public function setError(string $message, Throwable $exception): void
+    {
+        $this->getFactory()->createExceptionStorage()->addException($exception);
+    }
 }

src/Spryker/Service/Opentelemetry/OpentelemetryServiceFactory.php

@@ -10,6 +10,8 @@
 use Spryker\Service\Kernel\AbstractServiceFactory;
 use Spryker\Service\Opentelemetry\Storage\CustomParameterStorage;
 use Spryker\Service\Opentelemetry\Storage\CustomParameterStorageInterface;
+use Spryker\Service\Opentelemetry\Storage\ExceptionStorage;
+use Spryker\Service\Opentelemetry\Storage\ExceptionStorageInterface;
 use Spryker\Service\Opentelemetry\Storage\ResourceNameStorage;
 use Spryker\Service\Opentelemetry\Storage\RootSpanNameStorage;
 use Spryker\Service\Opentelemetry\Storage\RootSpanNameStorageInterface;
@@ -39,4 +41,12 @@ public function createResourceNameStorage(): ResourceNameStorage
     {
         return ResourceNameStorage::getInstance();
     }
+
+    /**
+     * @return \Spryker\Service\Opentelemetry\Storage\ExceptionStorageInterface
+     */
+    public function createExceptionStorage(): ExceptionStorageInterface
+    {
+        return ExceptionStorage::getInstance();
+    }
 }

src/Spryker/Service/Opentelemetry/OpentelemetryServiceInterface.php

@@ -7,6 +7,8 @@
 
 namespace Spryker\Service\Opentelemetry;
 
+use Throwable;
+
 interface OpentelemetryServiceInterface
 {
     /**
@@ -34,4 +36,29 @@ public function setCustomParameter(string $key, $value): void;
      * @return void
      */
     public function setRootSpanName(string $name): void;
+
+    /**
+     * Specification:
+     * - Sets service name to the root span.
+     *
+     * @api
+     *
+     * @param string $name
+     *
+     * @return void
+     */
+    public function setResourceName(string $name): void;
+
+    /**
+     * Specification:
+     * - Adds error event to the root span.
+     *
+     * @api
+     *
+     * @param string $message
+     * @param \Throwable $exception
+     *
+     * @return void
+     */
+    public function setError(string $message, Throwable $exception): void;
 }

src/Spryker/Service/Opentelemetry/Plugin/OpentelemetryMonitoringExtensionPlugin.php

@@ -7,16 +7,19 @@
 
 namespace Spryker\Service\Opentelemetry\Plugin;
 
-use OpenTelemetry\Context\Context;
 use Spryker\Service\Kernel\AbstractPlugin;
 use Spryker\Service\MonitoringExtension\Dependency\Plugin\MonitoringExtensionPluginInterface;
-use Spryker\Service\Opentelemetry\Instrumentation\Span\Span;
 
 /**
- * @method \Spryker\Service\Opentelemetry\OpentelemetryService getService()
+ * @method \Spryker\Service\Opentelemetry\OpentelemetryServiceInterface getService()
  */
 class OpentelemetryMonitoringExtensionPlugin extends AbstractPlugin implements MonitoringExtensionPluginInterface
 {
+    /**
+     * @var string
+     */
+    public const ATTRIBUTE_IS_CONSOLE_COMMAND = 'is_console_command';
+
     /**
      * Specification:
      * - Adds error to the current active span.
@@ -30,13 +33,7 @@ class OpentelemetryMonitoringExtensionPlugin extends AbstractPlugin implements M
      */
     public function setError(string $message, $exception): void
     {
-        $scope = Context::storage()->scope();
-        if (!$scope) {
-            return;
-        }
-
-        $span = Span::fromContext($scope->context());
-        $span->recordException($exception);
+        $this->getService()->setError($message, $exception);
     }
 
     /**
@@ -53,7 +50,8 @@ public function setError(string $message, $exception): void
      */
     public function setApplicationName(?string $application = null, ?string $store = null, ?string $environment = null): void
     {
-        $this->getService()->setResourceName(sprintf('%s-%s (%s)', $application ?? '', $store ?? '', $environment ?? ''));
+        $storeRegion = $store ?? (defined('APPLICATION_REGION') ? APPLICATION_REGION : '');
+        $this->getService()->setResourceName(sprintf('%s-%s (%s)', $application ?? '', $storeRegion, $environment ?? ''));
     }
 
     /**
@@ -112,15 +110,16 @@ public function markIgnoreTransaction(): void
 
     /**
      * Specification:
-     * - Opentelemetry has no attributes to specify background jobs. Service name already defined for CLI commands.
+     * - Adds custom param into the root span that can be used to show only console commands.
+     * - Trace service name will be prepended with `CLI` prefix if this param is true.
      *
      * @api
      *
      * @return void
      */
     public function markAsConsoleCommand(): void
     {
-        return;
+        $this->getService()->setCustomParameter(static::ATTRIBUTE_IS_CONSOLE_COMMAND, true);
     }
 
     /**

src/Spryker/Service/Opentelemetry/Storage/CustomParameterStorage.php

@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
 namespace Spryker\Service\Opentelemetry\Storage;
 
 class CustomParameterStorage implements CustomParameterStorageInterface

src/Spryker/Service/Opentelemetry/Storage/CustomParameterStorageInterface.php

@@ -1,9 +1,17 @@
 <?php
 
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
 namespace Spryker\Service\Opentelemetry\Storage;
 
 interface CustomParameterStorageInterface
 {
+    /**
+     * @return \Spryker\Service\Opentelemetry\Storage\CustomParameterStorage
+     */
     public static function getInstance(): CustomParameterStorage;
 
     /**

src/Spryker/Service/Opentelemetry/Storage/ExceptionStorage.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Spryker\Service\Opentelemetry\Storage;
+
+use Throwable;
+
+class ExceptionStorage implements ExceptionStorageInterface
+{
+    /**
+     * @var \Spryker\Service\Opentelemetry\Storage\ExceptionStorageInterface|null
+     */
+    private static ?ExceptionStorageInterface $instance = null;
+
+    /**
+     * @var array<\Throwable>
+     */
+    protected array $exceptions = [];
+
+    /**
+     * @return \Spryker\Service\Opentelemetry\Storage\ExceptionStorageInterface
+     */
+    public static function getInstance(): ExceptionStorageInterface
+    {
+        if (static::$instance === null) {
+            static::$instance = new static();
+        }
+
+        return static::$instance;
+    }
+
+    /**
+     * @return array<\Throwable>
+     */
+    public function getExceptions(): array
+    {
+        return $this->exceptions;
+    }
+
+    /**
+     * @param \Throwable $exception
+     *
+     * @return void
+     */
+    public function addException(Throwable $exception): void
+    {
+        $this->exceptions[] = $exception;
+    }
+}

src/Spryker/Service/Opentelemetry/Storage/ExceptionStorageInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Spryker\Service\Opentelemetry\Storage;
+
+use Throwable;
+
+interface ExceptionStorageInterface
+{
+    /**
+     * @return \Spryker\Service\Opentelemetry\Storage\ExceptionStorageInterface
+     */
+    public static function getInstance(): ExceptionStorageInterface;
+
+    /**
+     * @return array<\Throwable>
+     */
+    public function getExceptions(): array;
+
+    /**
+     * @param \Throwable $exception
+     *
+     * @return void
+     */
+    public function addException(Throwable $exception): void;
+}

src/Spryker/Zed/Opentelemetry/Business/Generator/ContentCreator/HookContentCreator.php

@@ -73,8 +73,6 @@ function: \'%s\',
 
                     $type = $params[1] ?? \\Symfony\\Component\\HttpKernel\\HttpKernelInterface::MAIN_REQUEST;
 
-                    $request = \\Spryker\\Shared\\OpenTelemetry\\Request\\RequestProcessor::getRequest();
-
                     $span = \\Spryker\\Shared\\OpenTelemetry\\Instrumentation\\CachedInstrumentation::getCachedInstrumentation()
                         ->tracer()
                         ->spanBuilder(\'%s\')
@@ -110,8 +108,8 @@ function: \'%s\',
 
                     if ($exception !== null) {
                         $span->recordException($exception);
-                        $span->setAttribute(\'error_message\', isset($exception) ? $exception->getMessage() : \'\');
-                        $span->setAttribute(\'error_code\', isset($exception) ? $exception->getCode() : \'\');
+                        $span->setAttribute(\'error_message\', $exception->getMessage());
+                        $span->setAttribute(\'error_code\', $exception->getCode());
                     }
 
                     $span->setStatus($exception !== null ? \\OpenTelemetry\\API\\Trace\\StatusCode::STATUS_ERROR : \\OpenTelemetry\\API\\Trace\\StatusCode::STATUS_OK);