Feature/otel optimisation

.github/workflows/ci.yml

@@ -14,8 +14,8 @@ jobs:
             fail-fast: false
             matrix:
                 php-version: [
-                    '8.1',
-                    '8.2'
+                    '8.2',
+                    '8.3'
                 ]
 
         steps:

_register.php

@@ -5,7 +5,11 @@
 use OpenTelemetry\SDK\Sdk;
 use Spryker\Service\Opentelemetry\Instrumentation\SprykerInstrumentationBootstrap;
 
-if (class_exists(Sdk::class) && Sdk::isInstrumentationDisabled(SprykerInstrumentationBootstrap::NAME) === true) {
+if (!class_exists(Sdk::class)) {
+    return;
+}
+
+if (Sdk::isDisabled()) {
     return;
 }
 

composer.json

@@ -4,10 +4,15 @@
     "description": "Opentelemetry module",
     "license": "proprietary",
     "require": {
+        "ext-grpc": "*",
+        "ext-opentelemetry": "*",
         "open-telemetry/api": "^1.0",
+        "open-telemetry/exporter-otlp": "^1.0",
+        "open-telemetry/gen-otlp-protobuf": "^1.1",
+        "open-telemetry/transport-grpc": "^1.0",
         "open-telemetry/sdk": "^1.0",
         "open-telemetry/sem-conv": "^1.0",
-        "php": ">=8.1",
+        "php": ">=8.2",
         "spryker/kernel": "^3.30.0",
         "spryker/monitoring-extension": "^1.0.0",
         "spryker/symfony": "^3.0.0"

otel-autoload-example.php

@@ -3,12 +3,14 @@
  * This file should be copied to the root of Spryker application and enabled in `autoload.files` section of composer.json file.
  */
 
+use OpenTelemetry\SDK\Sdk;
+
 $autoload = function (string $class)
 {
     $convertedClassName = str_replace('\\', '-', $class);
     $hookFilePath = __DIR__.'/src/Generated/OpenTelemetry/Hooks/' . $convertedClassName . 'Hook.php';
 
-    if (getenv('OTEL_SDK_DISABLED') !== true && file_exists($hookFilePath)) {
+    if (!Sdk::isDisabled() && file_exists($hookFilePath)) {
         include_once $hookFilePath;
     }
 };

src/Spryker/Service/Opentelemetry/Instrumentation/Resource/CompositeResourceDetector.php

@@ -0,0 +1,35 @@
+<?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\Instrumentation\Resource;
+
+use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
+
+class CompositeResourceDetector implements ResourceDetectorInterface
+{
+    /**
+     * @param array<\OpenTelemetry\SDK\Resource\ResourceDetectorInterface> $resourceDetectors
+     */
+    public function __construct(protected array $resourceDetectors)
+    {
+    }
+
+    /**
+     * @return \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo
+     */
+    public function getResource(): ResourceInfo
+    {
+        $resource = ResourceInfoFactory::emptyResource();
+        foreach ($this->resourceDetectors as $resourceDetector) {
+            $detectorResource = $resourceDetector->getResource();
+            $resourceToMerge = new ResourceInfo($detectorResource->getAttributes(), $detectorResource->getSchemaUrl());
+            $resource = $resource->mergeSprykerResource($resourceToMerge);
+        }
+
+        return $resource;
+    }
+}

src/Spryker/Service/Opentelemetry/Instrumentation/Resource/ResourceInfo.php

@@ -0,0 +1,95 @@
+<?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\Instrumentation\Resource;
+
+use OpenTelemetry\SDK\Common\Attribute\AttributesInterface;
+use OpenTelemetry\SDK\Resource\ResourceInfo as OtelResourceInfo;
+use OpenTelemetry\SemConv\ResourceAttributes;
+use Spryker\Service\Opentelemetry\Instrumentation\Span\Attributes;
+use Spryker\Service\Opentelemetry\Instrumentation\Span\WritableAttributesInterface;
+
+class ResourceInfo extends OtelResourceInfo
+{
+    public function __construct(
+        protected AttributesInterface $attributes,
+        protected ?string $schemaUrl = null,
+    ) {
+    }
+
+    /**
+     * @param string $name
+     * @return void
+     */
+    public function setServiceName(string $name): void
+    {
+        if ($this->attributes instanceof WritableAttributesInterface) {
+            $this->attributes->set(ResourceAttributes::SERVICE_NAME, $name);
+        }
+    }
+
+    /**
+     * @return \OpenTelemetry\SDK\Common\Attribute\AttributesInterface
+     */
+    public function getAttributes(): AttributesInterface
+    {
+        return $this->attributes;
+    }
+
+    /**
+     * @param \OpenTelemetry\SDK\Common\Attribute\AttributesInterface $attributes
+     * @param string|null $schemaUrl
+     *
+     * @return \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo
+     */
+    public static function createSprykerResource(AttributesInterface $attributes, ?string $schemaUrl = null): ResourceInfo
+    {
+        return new ResourceInfo($attributes, $schemaUrl);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getSchemaUrl(): ?string
+    {
+        return $this->schemaUrl;
+    }
+
+    /**
+     * @param \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo $updating
+     *
+     * @return \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo
+     */
+    public function mergeSprykerResource(ResourceInfo $updating): ResourceInfo
+    {
+        $schemaUrl = static::mergeSchemaUrl($this->getSchemaUrl(), $updating->getSchemaUrl());
+        $attributes = Attributes::factory()->builder()->merge($this->getAttributes(), $updating->getAttributes());
+
+        return ResourceInfo::createSprykerResource($attributes, $schemaUrl);
+    }
+
+    /**
+     * @param string|null $old
+     * @param string|null $updating
+     *
+     * @return string|null
+     */
+    protected static function mergeSchemaUrl(?string $old, ?string $updating): ?string
+    {
+        if (empty($old)) {
+            return $updating;
+        }
+        if (empty($updating)) {
+            return $old;
+        }
+        if ($old === $updating) {
+            return $old;
+        }
+
+        return null;
+    }
+}

src/Spryker/Service/Opentelemetry/Instrumentation/Resource/ResourceInfoFactory.php

@@ -0,0 +1,57 @@
+<?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\Instrumentation\Resource;
+
+use OpenTelemetry\SDK\Registry;
+use OpenTelemetry\SDK\Resource\Detectors\Composer;
+use OpenTelemetry\SDK\Resource\Detectors\Environment;
+use OpenTelemetry\SDK\Resource\Detectors\Host;
+use OpenTelemetry\SDK\Resource\Detectors\OperatingSystem;
+use OpenTelemetry\SDK\Resource\Detectors\Process;
+use OpenTelemetry\SDK\Resource\Detectors\ProcessRuntime;
+use OpenTelemetry\SDK\Resource\Detectors\Sdk;
+use OpenTelemetry\SDK\Resource\Detectors\SdkProvided;
+use Spryker\Service\Opentelemetry\Instrumentation\Span\Attributes;
+
+class ResourceInfoFactory
+{
+    /**
+     * @var \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo|null
+     */
+    protected static ?ResourceInfo $emptyResource = null;
+
+    /**
+     * @return \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo
+     */
+    public static function defaultResource(): ResourceInfo
+    {
+        return (new CompositeResourceDetector([
+            new Host(),
+            new OperatingSystem(),
+            new Process(),
+            new ProcessRuntime(),
+            new Sdk(),
+            new SdkProvided(),
+            new Composer(),
+            ...Registry::resourceDetectors(),
+            new Environment(),
+        ]))->getResource();
+    }
+
+    /**
+     * @return \Spryker\Service\Opentelemetry\Instrumentation\Resource\ResourceInfo
+     */
+    public static function emptyResource(): ResourceInfo
+    {
+        if (null === self::$emptyResource) {
+            self::$emptyResource = ResourceInfo::createSprykerResource(Attributes::create([]));
+        }
+
+        return self::$emptyResource;
+    }
+}