Refactored logging to use the same sink for tests and tools (#102)

* Fixed ResourceAttributes deprecated

* Moved parseBoolValue to PhpPartFacade

* Renamed appCodeArgs to appCodeRequestArgs

* Initial change to ComponentTestCaseBase

* Renamed appCodeArguments to appCodeRequestArgs

* Renamed ResourcesClient to ResourcesCleanerClient

* Renamed RESOURCES_CLIENT to RESOURCES_CLEANER_CLIENT

* Refactored PackagesPhpRequirementTest

* Refactored test classes that can use implTestForAppCodeSetsHowFinished

* Fixed ProcessUtilTest

* Refactored BootstrapStageLoggingClassTrait

* Fixed ComponentTestCaseBase::copyProdOptionsToAppCodeHostParams

* Synced BootstrapStageLoggingClassTrait::addContextToMessage

* Merged Add_feature_to_BootstrapStageLoggingClassTrait to Refactor_tests_tools_logging

* Refactored logging to use the same sink for tests and tools

* Temporarily disabled ComponentTestsUtilComponentTest::test0WithoutEscalation

* Temporarily disabled ComponentTestsUtilComponentTest::test0WithoutEscalation

* Re-enable ComponentTestsUtilComponentTest::test0WithoutEscalation

* Fixed ComponentTestsUtilComponentTest

* Fixed bootstrap_build_tools.php

* Fixed test clean-up timing out

* Make sure to close spawned process handle to allow it to exit normally

* Refactored MySqliAutoInstrumentationTest to use implTestForAppCodeSetsHowFinished

* Refactored PgSqlAutoInstrumentationTest

* Started removal of BuildToolsLog

* Fixed test case when MySQLi/ PostgreSQL instrumentation is disabled

* Replaced separate build tools logging by prod logging

* Added LoggingClassTraitTest::testWithIsNotEvaluatedIfLevelDisabled

* Improved alignment of tests logging with prod and tests

* Renamed feature to featureOrCategory where applicable

Author: SergeyKleyman

packaging/test/smokeTest.php

@@ -39,8 +39,31 @@
 echo CGREEN."OK\n".CDEF;
 
 echo "Trying to log something to stderr: ";
-$loggerClass = "{$scopeName}OpenTelemetry\\Distro\\BootstrapStageLogger";
-$loggerClass::logDebug("This is just a message to test logger", __FILE__, __LINE__, __CLASS__, __FUNCTION__);
+/**
+ * @var class-string<\OpenTelemetry\Distro\Log\LogBackend> $logBackendClass
+ * @noinspection PhpFullyQualifiedNameUsageInspection
+ */
+$logBackendClass = "{$scopeName}OpenTelemetry\\Distro\\Log\\LogBackend";
+/**
+ * @var class-string<\OpenTelemetry\Distro\Log\LogFeature> $logFeatureClass
+ * @noinspection PhpFullyQualifiedNameUsageInspection
+ */
+$logFeatureClass = "{$scopeName}OpenTelemetry\\Distro\\Log\\LogFeature";
+/**
+ * @var class-string<\OpenTelemetry\Distro\Log\LogLevel> $logLevelClass
+ * @noinspection PhpFullyQualifiedNameUsageInspection
+ */
+$logLevelClass = "{$scopeName}OpenTelemetry\\Distro\\Log\\LogLevel";
+$logBackendClass::getSingletonInstance()->write(
+    file: __FILE__,
+    line: __LINE__,
+    func: __FUNCTION__,
+    featureOrCategory: $logFeatureClass::BOOTSTRAP,
+    level: $logLevelClass::off,
+    message: 'This is just a dummy message to test production code logging',
+    context: ['dummy ctx key' => 'dummy ctx value'],
+    isForced: true
+);
 echo CGREEN."OK\n".CDEF;
 
 echo CGREEN."Smoke test passed\n".CDEF;

prod/php/OpenTelemetry/Distro/AutoloaderForClassesInDirectory.php

@@ -1,16 +1,16 @@
 <?php
 
-/** @noinspection PhpIllegalPsrClassPathInspection */
-
 declare(strict_types=1);
 
 namespace OpenTelemetry\Distro;
 
+use OpenTelemetry\Distro\Log\LoggingClassTrait;
 use OpenTelemetry\Distro\Log\LogFeature;
+use OpenTelemetry\Distro\Util\DistroRuntimeException;
 
 final class AutoloaderForClassesInDirectory
 {
-    use BootstrapStageLoggingClassTrait;
+    use LoggingClassTrait;
 
     private readonly int $autoloadFqClassNamePrefixLength;
 
@@ -24,7 +24,9 @@ private function __construct(
     public static function register(string $dirRootNamespace, string $dirFullPath): void
     {
         $autoloader = new self(autoloadFqClassNamePrefix: $dirRootNamespace . '\\', srcFilePathPrefix: $dirFullPath . DIRECTORY_SEPARATOR);
-        spl_autoload_register(($autoloader)->autoloadCodeForClass(...));
+        if (!spl_autoload_register(($autoloader)->autoloadCodeForClass(...))) {
+            throw new DistroRuntimeException('spl_autoload_register() returned false', context: compact('dirRootNamespace', 'dirFullPath'));
+        }
     }
 
     private function shouldAutoloadCodeForClass(string $fqClassName): bool
@@ -37,10 +39,11 @@ public function autoloadCodeForClass(string $fqClassName): void
     {
         // Example of $fqClassName: OpenTelemetry\Distro\Autoloader
 
-        self::logTrace(__LINE__, __FUNCTION__, 'Entered', compact('fqClassName'));
+        $logTrace = self::logTrace(__FUNCTION__);
+        $logTrace?->with(__LINE__, 'Entered', compact('fqClassName'));
 
         if (!self::shouldAutoloadCodeForClass($fqClassName)) {
-            self::logTrace(__LINE__, __FUNCTION__, 'shouldAutoloadCodeForClass returned false', compact('fqClassName'));
+            $logTrace?->with(__LINE__, 'shouldAutoloadCodeForClass returned false', compact('fqClassName'));
             return;
         }
 
@@ -52,34 +55,26 @@ public function autoloadCodeForClass(string $fqClassName): void
         $classSrcFileAbsolute = $this->srcFilePathPrefix . $classSrcFileRelative;
 
         if (file_exists($classSrcFileAbsolute)) {
-            self::logTrace(__LINE__, __FUNCTION__, 'Before require', compact('classSrcFileAbsolute'));
+            $logTrace?->with(__LINE__, 'Before require', compact('classSrcFileAbsolute'));
             require $classSrcFileAbsolute;
-            self::logTrace(__LINE__, __FUNCTION__, 'After require', compact('classSrcFileAbsolute'));
+            $logTrace?->with(__LINE__, 'After require', compact('classSrcFileAbsolute'));
         } else {
-            self::logTrace(__LINE__, __FUNCTION__, 'File with the code for class does not exist', compact('fqClassName', 'classSrcFileAbsolute'));
+            $logTrace?->with(__LINE__, 'File with the code for class does not exist', compact('fqClassName', 'classSrcFileAbsolute'));
         }
     }
 
     /**
-     * Must be defined in class using BootstrapStageLoggingClassTrait
+     * Must be defined in class using LoggingClassTrait
      */
     private static function getCurrentSourceCodeFile(): string
     {
         return __FILE__;
     }
 
     /**
-     * Must be defined in class using BootstrapStageLoggingClassTrait
-     */
-    private static function getCurrentSourceCodeClass(): string
-    {
-        return __CLASS__;
-    }
-
-    /**
-     * Must be defined in class using BootstrapStageLoggingClassTrait
+     * Must be defined in class using LoggingClassTrait
      */
-    private static function getCurrentLogFeature(): int
+    private static function getCurrentOptionalLogProdFeatureIntOrCategoryString(): int
     {
         return LogFeature::BOOTSTRAP;
     }