Fixed attributes used central configuration in Kibana

prod/php/ElasticOTel/Autoloader.php → prod/php/ElasticOTel/AutoloaderElasticOTelClasses.php

@@ -30,7 +30,7 @@
  *
  * @internal
  */
-final class Autoloader
+final class AutoloaderElasticOTelClasses
 {
     private const AUTOLOAD_FQ_CLASS_NAME_PREFIX = 'Elastic\\OTel\\';
 

prod/php/ElasticOTel/InstrumentationBridge.php

@@ -137,7 +137,7 @@ private static function elasticOTelHookNoThrow(?string $class, string $function,
         }
     }
 
-    private function retryDelayedHooks(): void
+    public function retryDelayedHooks(): void
     {
         $delayedHooksCount = count($this->delayedHooks);
         BootstrapStageLogger::logTrace('Entered. delayedHooks count: ' . $delayedHooksCount, __FILE__, __LINE__, __CLASS__, __FUNCTION__);

prod/php/ElasticOTel/OverrideOTelSdkResourceAttributes.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+declare(strict_types=1);
+
+namespace Elastic\OTel;
+
+use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Registry;
+use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
+use OpenTelemetry\SDK\Resource\ResourceInfo;
+use OpenTelemetry\SemConv\ResourceAttributes;
+
+/**
+ * Code in this file is part of implementation internals, and thus it is not covered by the backward compatibility.
+ *
+ * @internal
+ */
+final class OverrideOTelSdkResourceAttributes implements ResourceDetectorInterface
+{
+    private static ?string $distroVersion = null;
+
+    public static function register(string $elasticOTelNativePartVersion): void
+    {
+        self::$distroVersion = self::buildDistroVersion($elasticOTelNativePartVersion);
+        Registry::registerResourceDetector(self::class, new self());
+        BootstrapStageLogger::logDebug('Registered; distroVersion: ' . self::$distroVersion, __FILE__, __LINE__, __CLASS__, __FUNCTION__);
+    }
+
+    public function getResource(): ResourceInfo
+    {
+        /**
+         * @see https://github.com/elastic/apm/blob/9a8390a161db1cab0f7e27f03111ff4bececf523/specs/agents/otel-distribution.md?plain=1#L79
+         * @see https://github.com/elastic/opentelemetry-lib/blob/434982a9d78a9b0ee1f47bccb9f03d6b7bf3570f/enrichments/internal/elastic/resource.go#L102
+         * @see https://github.com/elastic/kibana/blob/v9.1.0/x-pack/solutions/observability/plugins/apm/common/agent_configuration/setting_definitions/edot_sdk_settings.ts
+         *
+         * - `telemetry.distro.name`: must be set to `elastic`
+         * - `telemetry.distro.version`: must reflect the distribution version
+         * - `agent.name`: is built by Elastic's ingestion as <telemetry.sdk.name>/<telemetry.sdk.language>/<telemetry.distro.name> and expected by Kibana to be `opentelemetry/php/elastic`
+         */
+
+        $attributes = [
+            ResourceAttributes::TELEMETRY_DISTRO_NAME => 'elastic',
+            ResourceAttributes::TELEMETRY_DISTRO_VERSION => self::getDistroVersion(),
+        ];
+
+        BootstrapStageLogger::logDebug('Returning attributes: ' . json_encode($attributes), __FILE__, __LINE__, __CLASS__, __FUNCTION__);
+        return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
+    }
+
+    private static function buildDistroVersion(string $elasticOTelNativePartVersion): string
+    {
+        if ($elasticOTelNativePartVersion === PhpPartVersion::VALUE) {
+            return $elasticOTelNativePartVersion;
+        }
+
+        $logMsg = 'Native part and PHP part versions do not match. native part version: ' . $elasticOTelNativePartVersion . '; PHP part version: ' . PhpPartVersion::VALUE;
+        BootstrapStageLogger::logWarning($logMsg, __FILE__, __LINE__, __CLASS__, __FUNCTION__);
+        return $elasticOTelNativePartVersion . '/' . PhpPartVersion::VALUE;
+    }
+
+    public static function getDistroVersion(): string
+    {
+        return self::$distroVersion ?? PhpPartVersion::VALUE;
+    }
+}

prod/php/ElasticOTel/PhpPartFacade.php

@@ -65,18 +65,6 @@ final class PhpPartFacade
 
     public const CONFIG_ENV_VAR_NAME_DEV_INTERNAL_MODE_IS_DEV = 'ELASTIC_OTEL_PHP_DEV_INTERNAL_MODE_IS_DEV';
 
-    /**
-     * We need to use TELEMETRY_DISTRO_NAME and TELEMETRY_DISTRO_VERSION attribute names before OTel SDK is loaded by composer
-     * so we copy those values to local constants
-     *
-     * @see \OpenTelemetry\SemConv\TraceAttributes::TELEMETRY_DISTRO_NAME
-     * @see \OpenTelemetry\SemConv\TraceAttributes::TELEMETRY_DISTRO_VERSION
-     *
-     * @noinspection PhpUnnecessaryFullyQualifiedNameInspection
-     */
-    public const OTEL_ATTR_NAME_TELEMETRY_DISTRO_NAME = 'telemetry.distro.name';
-    public const OTEL_ATTR_NAME_TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version';
-
     /**
      * Called by the extension
      *
@@ -114,12 +102,13 @@ public static function bootstrap(string $elasticOTelNativePartVersion, int $maxE
         }
 
         try {
-            require __DIR__ . DIRECTORY_SEPARATOR . 'Autoloader.php';
-            Autoloader::register(__DIR__);
+            require __DIR__ . DIRECTORY_SEPARATOR . 'AutoloaderElasticOTelClasses.php';
+            AutoloaderElasticOTelClasses::register(__DIR__);
 
             InstrumentationBridge::singletonInstance()->bootstrap();
-            self::prepareEnvForOTelSdk($elasticOTelNativePartVersion);
-            self::registerAutoloader();
+            self::prepareForOTelSdk();
+            self::registerAutoloaderForVendorDir();
+            OverrideOTelSdkResourceAttributes::register($elasticOTelNativePartVersion);
             self::registerNativeOtlpSerializer();
             self::registerAsyncTransportFactory();
             self::registerOtelLogWriter();
@@ -178,22 +167,6 @@ public static function inferredSpans(int $durationMs, bool $internalFunction): b
         return true;
     }
 
-    private static function buildElasticOTelVersion(string $nativePartVersion): string
-    {
-        if ($nativePartVersion === PhpPartVersion::VALUE) {
-            return $nativePartVersion;
-        }
-
-        BootstrapStageLogger::logWarning(
-            'Native part and PHP part versions do not match. native part version: ' . $nativePartVersion . '; PHP part version: ' . PhpPartVersion::VALUE,
-            __FILE__,
-            __LINE__,
-            __CLASS__,
-            __FUNCTION__
-        );
-        return $nativePartVersion . '/' . PhpPartVersion::VALUE;
-    }
-
     private static function isInDevMode(): bool
     {
         $modeIsDevEnvVarVal = getenv(self::CONFIG_ENV_VAR_NAME_DEV_INTERNAL_MODE_IS_DEV);
@@ -212,21 +185,6 @@ private static function isInDevMode(): bool
         return false;
     }
 
-    private static function prepareEnvForOTelAttributes(string $elasticOTelNativePartVersion): void
-    {
-        $envVarName = 'OTEL_RESOURCE_ATTRIBUTES';
-        $envVarValueOnEntry = getenv($envVarName);
-        $envVarValue = (is_string($envVarValueOnEntry) && strlen($envVarValueOnEntry) !== 0) ? ($envVarValueOnEntry . ',') : '';
-
-        // https://opentelemetry.io/docs/specs/semconv/resource/#telemetry-distribution-experimental
-        $envVarValue .=
-            self::OTEL_ATTR_NAME_TELEMETRY_DISTRO_NAME . '=elastic'
-            . ','
-            . self::OTEL_ATTR_NAME_TELEMETRY_DISTRO_VERSION . '=' . self::buildElasticOTelVersion($elasticOTelNativePartVersion);
-
-        self::setEnvVar($envVarName, $envVarValue);
-    }
-
     /**
      * @param non-empty-string $envVarName
      */
@@ -237,13 +195,12 @@ private static function setEnvVar(string $envVarName, string $envVarValue): void
         }
     }
 
-    private static function prepareEnvForOTelSdk(string $elasticOTelNativePartVersion): void
+    private static function prepareForOTelSdk(): void
     {
         self::setEnvVar('OTEL_PHP_AUTOLOAD_ENABLED', 'true');
-        self::prepareEnvForOTelAttributes($elasticOTelNativePartVersion);
     }
 
-    private static function registerAutoloader(): void
+    private static function registerAutoloaderForVendorDir(): void
     {
         $vendorDir = ProdPhpDir::$fullPath . DIRECTORY_SEPARATOR . (
             self::isInDevMode()

tests/ElasticOTelTests/ComponentTests/CurlAutoInstrumentationTest.php

@@ -27,19 +27,19 @@
 use ElasticOTelTests\ComponentTests\Util\AppCodeHostParams;
 use ElasticOTelTests\ComponentTests\Util\AppCodeRequestParams;
 use ElasticOTelTests\ComponentTests\Util\AppCodeTarget;
+use ElasticOTelTests\ComponentTests\Util\AttributesExpectations;
 use ElasticOTelTests\ComponentTests\Util\ComponentTestCaseBase;
 use ElasticOTelTests\ComponentTests\Util\CurlHandleForTests;
 use ElasticOTelTests\ComponentTests\Util\HttpAppCodeRequestParams;
 use ElasticOTelTests\ComponentTests\Util\HttpClientUtilForTests;
+use ElasticOTelTests\ComponentTests\Util\OtlpData\Span;
+use ElasticOTelTests\ComponentTests\Util\OtlpData\SpanKind;
 use ElasticOTelTests\ComponentTests\Util\PhpSerializationUtil;
 use ElasticOTelTests\ComponentTests\Util\RequestHeadersRawSnapshotSource;
 use ElasticOTelTests\ComponentTests\Util\ResourcesClient;
-use ElasticOTelTests\ComponentTests\Util\Span;
-use ElasticOTelTests\ComponentTests\Util\SpanAttributesExpectations;
 use ElasticOTelTests\ComponentTests\Util\SpanExpectationsBuilder;
-use ElasticOTelTests\ComponentTests\Util\SpanKind;
 use ElasticOTelTests\ComponentTests\Util\UrlUtil;
-use ElasticOTelTests\ComponentTests\Util\WaitForEventCounts;
+use ElasticOTelTests\ComponentTests\Util\WaitForOTelSignalCounts;
 use ElasticOTelTests\Util\AssertEx;
 use ElasticOTelTests\Util\Config\OptionForProdName;
 use ElasticOTelTests\Util\Config\OptionForTestsName;
@@ -225,7 +225,7 @@ function (AppCodeRequestParams $clientAppCodeReqParams) use ($testArgs, $appCode
         //        |------------------------------------------------------|    |--------------------------------|
         //        client app host                                             server app host
 
-        $curlClientSpanAttributesExpectations = new SpanAttributesExpectations(
+        $curlClientSpanAttributesExpectations = new AttributesExpectations(
             [
                 TraceAttributes::CODE_FUNCTION_NAME        => 'curl_exec',
                 TraceAttributes::HTTP_REQUEST_METHOD       => HttpMethods::GET,
@@ -238,7 +238,7 @@ function (AppCodeRequestParams $clientAppCodeReqParams) use ($testArgs, $appCode
         );
         $expectationsForCurlClientSpan = (new SpanExpectationsBuilder())->name(HttpMethods::GET)->kind(SpanKind::client)->attributes($curlClientSpanAttributesExpectations)->build();
 
-        $serverTxSpanAttributesExpectations = new SpanAttributesExpectations(
+        $serverTxSpanAttributesExpectations = new AttributesExpectations(
             [
                 TraceAttributes::HTTP_REQUEST_METHOD       => HttpMethods::GET,
                 TraceAttributes::HTTP_RESPONSE_STATUS_CODE => self::SERVER_RESPONSE_HTTP_STATUS,
@@ -252,25 +252,25 @@ function (AppCodeRequestParams $clientAppCodeReqParams) use ($testArgs, $appCode
         $expectedServerTxSpanName = HttpMethods::GET . ' ' . $appCodeRequestParamsForServer->urlParts->path;
         $expectationsForServerTxSpan = (new SpanExpectationsBuilder())->name($expectedServerTxSpanName)->kind(SpanKind::server)->attributes($serverTxSpanAttributesExpectations)->build();
 
-        $exportedData = $testCaseHandle->waitForEnoughExportedData(WaitForEventCounts::spans($enableCurlInstrumentationForClient ? 3 : 2));
-        $dbgCtx->add(compact('exportedData'));
+        $agentBackendComms = $testCaseHandle->waitForEnoughAgentBackendComms(WaitForOTelSignalCounts::spans($enableCurlInstrumentationForClient ? 3 : 2));
+        $dbgCtx->add(compact('agentBackendComms'));
 
         //
         // Assert
         //
 
         if ($enableCurlInstrumentationForClient) {
-            $rootSpan = $exportedData->singleRootSpan();
-            foreach ($exportedData->spans as $span) {
+            $rootSpan = $agentBackendComms->singleRootSpan();
+            foreach ($agentBackendComms->spans() as $span) {
                 self::assertSame($rootSpan->traceId, $span->traceId);
             }
-            $curlClientSpan = $exportedData->singleChildSpan($rootSpan->id);
+            $curlClientSpan = $agentBackendComms->singleChildSpan($rootSpan->id);
             $expectationsForCurlClientSpan->assertMatches($curlClientSpan);
-            $serverTxSpan = $exportedData->singleChildSpan($curlClientSpan->id);
+            $serverTxSpan = $agentBackendComms->singleChildSpan($curlClientSpan->id);
         } else {
-            $serverTxSpan = IterableUtil::singleValue($exportedData->findSpansWithAttributeValue(TraceAttributes::SERVER_PORT, $appCodeRequestParamsForServer->urlParts->port));
+            $serverTxSpan = IterableUtil::singleValue($agentBackendComms->findSpansWithAttributeValue(TraceAttributes::SERVER_PORT, $appCodeRequestParamsForServer->urlParts->port));
             self::assertNull($serverTxSpan->parentId);
-            $clientTxSpan = IterableUtil::singleValue(IterableUtil::findByPredicateOnValue($exportedData->spans, fn(Span $span) => $span->parentId === null && $span !== $serverTxSpan));
+            $clientTxSpan = IterableUtil::singleValue(IterableUtil::findByPredicateOnValue($agentBackendComms->spans(), fn(Span $span) => $span->parentId === null && $span !== $serverTxSpan));
             self::assertNotEquals($serverTxSpan->traceId, $clientTxSpan->traceId);
         }