feat(otel-hook): autoload registration of otel hook

hooks/OpenTelemetry/README.md

@@ -12,6 +12,10 @@ OpenTelemetry is an open specification for distributed tracing, metrics, and log
 
 This package also builds on various PSRs (PHP Standards Recommendations) such as the Logger interfaces (PSR-3) and the Basic and Extended Coding Standards (PSR-1 and PSR-12).
 
+### Autoloading
+
+This package supports Composer autoloading. Thus, simply installing the package is all you need in order to immediately get started with OpenTracing for OpenFeature! Examples are provided that showcase the simple setup as well. Check out the Usage section for more info.
+
 ### OpenTelemetry Package Status
 
 The OpenTelemetry package for PHP is still in beta, so there could be changes required. However, it exposes global primitives for span retrieval that should not require any configuration upfront for the provider to just work.
@@ -37,6 +41,8 @@ OpenTelemetryHook::register();
 
 For more information on OpenTelemetry, check out [their documentation](https://opentelemetry.io/docs/instrumentation/php/).
 
+For more examples, see the [examples](./examples/).
+
 ## Development
 
 ### PHP Versioning

hooks/OpenTelemetry/composer.json

@@ -23,7 +23,7 @@
   ],
   "require": {
     "php": "^7.4 || ^8",
-    "open-feature/sdk": "^1.1.0",
+    "open-feature/sdk": "^1.2.0",
     "open-telemetry/api": "^0.0.17"
   },
   "require-dev": {
@@ -54,7 +54,10 @@
   "autoload": {
     "psr-4": {
       "OpenFeature\\Hooks\\OpenTelemetry\\": "src"
-    }
+    },
+    "files": [
+      "src/_autoload.php"
+    ]
   },
   "autoload-dev": {
     "psr-4": {
@@ -109,7 +112,7 @@
     "dev:test:unit:teardown": "echo 'Tore down for unit tests...'",
     "dev:test:integration": [
       "@dev:test:integration:setup",
-      "echo 'No integration tests to run'",
+      "phpunit --colors=always --testdox --testsuite=integration",
       "@dev:test:integration:teardown"
     ],
     "dev:test:integration:debug": "phpunit --colors=always --testdox -d xdebug.profiler_enable=on",

hooks/OpenTelemetry/examples/AutoloadOTelSDK/README.md

@@ -0,0 +1,5 @@
+# OpenFeature OpenTelemetry Hook example
+
+This example provides an example of bootstrapping and using the OpenTelemetry hook for OpenFeature.
+
+It showcases the auto-instrumentation functionality of OpenFeature and OpenTelemetry, neither of which requiring imperative interactions with OTel to bootstrap, configure, and utilize it.

hooks/OpenTelemetry/examples/AutoloadOTelSDK/composer.json

@@ -0,0 +1,16 @@
+{
+    "name": "open-feature/otel-manual-instrumentation-example",
+    "description": "An example of using the OpenTelemetry hook for OpenFeature with manual instrumentation",
+    "type": "project",
+    "license": "Apache-2.0",
+    "authors": [
+        {
+            "name": "Tom Carrio",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "open-telemetry/api": "0.0.17",
+        "open-feature/sdk": "^1.2.0"
+    }
+}

hooks/OpenTelemetry/examples/AutoloadOTelSDK/src/main.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+use OpenFeature\OpenFeatureAPI;
+
+putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
+putenv('OTEL_TRACES_EXPORTER=otlp');
+putenv('OTEL_EXPORTER_OTLP_PROTOCOL=grpc');
+putenv('OTEL_METRICS_EXPORTER=otlp');
+putenv('OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=grpc');
+putenv('OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4317');
+putenv('OTEL_PHP_TRACES_PROCESSOR=batch');
+putenv('OTEL_PROPAGATORS=b3,baggage,tracecontext');
+
+echo 'autoloading SDK example starting...' . PHP_EOL;
+
+// Composer autoloader will execute SDK/_autoload.php which will register global instrumentation from environment configuration
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+$client = OpenFeatureAPI::getInstance()->getClient('dev.openfeature.contrib.php.demo', '1.0.0');
+
+$version = $client->getStringValue('dev.openfeature.contrib.php.version-value', 'unknown');
+
+echo 'Version is ' . $version;

hooks/OpenTelemetry/examples/OTelManualInstrumentation/README.md

@@ -1,3 +1,5 @@
 # OpenFeature OpenTelemetry Hook example
 
 This example provides an example of bootstrapping and using the OpenTelemetry hook for OpenFeature.
+
+It showcases how you can manually configure the OTel SDK for metrics, tracing, and more. This is then utilized under the hood by OpenFeature within its hook lifecycles to report the feature flag semantic events via the tracer. 

hooks/OpenTelemetry/examples/OTelManualInstrumentation/composer.json

@@ -3,11 +3,6 @@
     "description": "An example of using the OpenTelemetry hook for OpenFeature with manual instrumentation",
     "type": "project",
     "license": "Apache-2.0",
-    "autoload": {
-        "psr-4": {
-            "OpenFeature\\Providers\\Examples\\OTelManualInstrumentation\\": "src/"
-        }
-    },
     "authors": [
         {
             "name": "Tom Carrio",
@@ -22,6 +17,6 @@
         "php-di/slim-bridge": "^3.2",
         "open-telemetry/api": "0.0.17",
         "open-telemetry/sdk": "0.0.17",
-        "open-feature/sdk": "^1.1"
+        "open-feature/sdk": "^1.2.0"
     }
 }

hooks/OpenTelemetry/examples/OTelManualInstrumentation/src/main.php

@@ -32,7 +32,7 @@
 use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
 use Slim\Routing\RouteContext;
 
-// Registering the OTel hook requires only the following!
+// Manually registering the OTel hook requires only the following!
 // The rest of the work is simply using OpenFeature as you normally would
 // The current context span will be used to emit trace events.
 OpenTelemetryHook::register();

hooks/OpenTelemetry/src/OpenTelemetryHook.php

@@ -42,7 +42,7 @@ public static function register(): void
             self::$instance = new OpenTelemetryHook();
         }
 
-        if (self::$registeredHook) {
+        if (self::$registeredHook && self::isRegisteredInHooks()) {
             return;
         }
 
@@ -88,4 +88,21 @@ public function supportsFlagValueType(string $flagValueType): bool
     {
         return true;
     }
+
+    /**
+     * Hooks can be cleared by other means so we can't simply memoize whether a registration has occurred
+     *
+     * However if no registration has yet happened then we can absolutely determine that the hook will
+     * not be registered yet.
+     */
+    private static function isRegisteredInHooks(): bool
+    {
+        foreach (OpenFeatureAPI::getInstance()->getHooks() as $hook) {
+            if ($hook instanceof OpenTelemetryHook) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

hooks/OpenTelemetry/src/_autoload.php

@@ -0,0 +1,6 @@
+<?php
+
+declare(strict_types=1);
+
+// automatically registers the OTel hook for OpenFeature
+OpenFeature\Hooks\OpenTelemetry\OpenTelemetryHook::register();

hooks/OpenTelemetry/tests/integration/OpenTelemetryHookTest.php

@@ -11,16 +11,37 @@
 
 class OpenTelemetryHookTest extends TestCase
 {
+    public function testAutoload(): void
+    {
+        // Given
+        $api = OpenFeatureAPI::getInstance();
+        $api->clearHooks();
+
+        // When
+        $this->simulateAutoload();
+
+        // Then
+
+        $this->assertCount(1, $api->getHooks());
+        $this->assertInstanceOf(Hook::class, $api->getHooks()[0]);
+    }
+
     public function testCanBeRegistered(): void
     {
         // Given
         $api = OpenFeatureAPI::getInstance();
+        $api->clearHooks();
 
         // When
         OpenTelemetryHook::register();
 
         // Then
-        $this->assertNotEmpty($api->getHooks());
+        $this->assertCount(1, $api->getHooks());
         $this->assertInstanceOf(Hook::class, $api->getHooks()[0]);
     }
+
+    private function simulateAutoload(): void
+    {
+        require __DIR__ . '/../../src/_autoload.php';
+    }
 }

providers/CloudBees/composer.json

@@ -24,7 +24,7 @@
   ],
   "require": {
     "php": "^7.4 || ^8",
-    "open-feature/sdk": "^1.0.0",
+    "open-feature/sdk": "^1.2.0",
     "rollout/rox": "^5.0"
   },
   "require-dev": {

providers/CloudBees/examples/CloudBees/composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "open-feature/sdk": "^0.0.5",
+        "open-feature/sdk": "^1.2.0",
         "open-feature/cloudbees-provider": "^0.0.1"
     }
 }

providers/Flagd/examples/Grpc/composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "open-feature/sdk": "^0.0.5",
+        "open-feature/sdk": "^1.2.0",
         "monolog/monolog": "^2.8"
     }
 }

providers/Flagd/examples/Http/composer.json

@@ -15,6 +15,6 @@
         }
     ],
     "require": {
-        "open-feature/sdk": "^0.0.5"
+        "open-feature/sdk": "^1.2.0"
     }
 }

providers/Split/composer.json

@@ -23,7 +23,7 @@
   ],
   "require": {
     "php": "^7.4 || ^8",
-    "open-feature/sdk": "^1.1.0",
+    "open-feature/sdk": "^1.2.0",
     "splitsoftware/split-sdk-php": "^7.1"
   },
   "require-dev": {

providers/Split/examples/SplitSDK/composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "open-feature/sdk": "^0.0.5",
+        "open-feature/sdk": "^1.2.0",
         "open-feature/split-provider": "^0.0.1"
     }
 }