auto-instrumentation registration

composer.json

@@ -145,7 +145,15 @@
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordExporterConsole",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordExporterOtlp",
                 "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordProcessorBatch",
-                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordProcessorSimple"
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordProcessorSimple",
+
+                "OpenTelemetry\\Example\\ExampleConfigProvider"
+            ],
+            "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\HookManager": [
+                "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\ExtensionHookManager"
+            ],
+            "OpenTelemetry\\API\\Instrumentation\\AutoInstrumentation\\Instrumentation": [
+                "OpenTelemetry\\Example\\ExampleInstrumentation"
             ]
         }
     }

examples/instrumentation/configure_instrumentation.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace _;
+
+use Nevay\SPI\ServiceLoader;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\ExtensionHookManager;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
+use OpenTelemetry\Config\SDK\Configuration;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\Example\Example;
+use const PHP_EOL;
+
+/**
+ * This example uses SPI (see root composer.json extra.spi) to configure an example auto-instrumentation from a YAML file
+ */
+// EXAMPLE_INSTRUMENTATION_SPAN_NAME=test1234 php examples/instrumentation/configure_instrumentation.php
+
+require __DIR__ . '/../../vendor/autoload.php';
+
+$sdk = Configuration::parseFile(__DIR__ . '/otel-sdk.yaml')->create(new Context())->setAutoShutdown(true)->setHookManager(new ExtensionHookManager())->build();
+$configuration = \OpenTelemetry\Config\SDK\Instrumentation::parseFile(__DIR__ . '/otel-instrumentation.yaml')->create();
+
+$context = new Context($sdk->getTracerProvider());
+$storage = \OpenTelemetry\Context\Context::storage();
+
+foreach (ServiceLoader::load(Instrumentation::class) as $instrumentation) {
+    $instrumentation->register($sdk->getHookManager(), $context, $configuration, $storage);
+}
+
+$scope = $storage->attach($sdk->getHookManager()->enable($storage->current()));
+
+try {
+    echo (new Example())->test(), PHP_EOL;
+} finally {
+    $scope->detach();
+}

examples/instrumentation/configure_instrumentation_global.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace _;
+
+use OpenTelemetry\Example\Example;
+use const PHP_EOL;
+
+/**
+ * This example uses SPI (see root composer.json extra.spi) to configure an example auto-instrumentation from a YAML file
+ */
+// EXAMPLE_INSTRUMENTATION_SPAN_NAME=test1234 php examples/instrumentation/configure_instrumentation.php
+putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
+putenv(sprintf('OTEL_PHP_SDK_CONFIG_FILE=%s/%s', __DIR__, 'otel-sdk.yaml'));
+putenv(sprintf('OTEL_PHP_INSTRUMENTATION_CONFIG_FILE=%s/%s', __DIR__, 'otel-instrumentation.yaml'));
+
+require __DIR__ . '/../../vendor/autoload.php';
+
+echo (new Example())->test(), PHP_EOL;

examples/instrumentation/otel-instrumentation.yaml

@@ -0,0 +1,3 @@
+config:
+  - example_instrumentation:
+      span_name: ${EXAMPLE_INSTRUMENTATION_SPAN_NAME:-example span}

examples/instrumentation/otel-sdk.yaml

@@ -0,0 +1,7 @@
+file_format: '0.1'
+
+tracer_provider:
+  processors:
+  - simple:
+      exporter:
+        console: {}

examples/src/Example.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Example;
+
+final class Example
+{
+
+    public function test(): int
+    {
+        return 42;
+    }
+}

examples/src/ExampleConfig.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Example;
+
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\InstrumentationConfiguration;
+
+final class ExampleConfig implements InstrumentationConfiguration
+{
+
+    public function __construct(
+        public readonly string $spanName,
+        public readonly bool $enabled = true,
+    ) {
+    }
+}

examples/src/ExampleConfigProvider.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Example;
+
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\InstrumentationConfiguration;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\Config\SDK\Configuration\Validation;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+/**
+ * @implements ComponentProvider<InstrumentationConfiguration>
+ */
+final class ExampleConfigProvider implements ComponentProvider
+{
+
+    /**
+     * @psalm-suppress MoreSpecificImplementedParamType
+     * @param array{
+     *     span_name: string,
+     *     enabled: bool,
+     * } $properties
+     */
+    public function createPlugin(array $properties, Context $context): InstrumentationConfiguration
+    {
+        return new ExampleConfig(
+            spanName: $properties['span_name'],
+            enabled: $properties['enabled'],
+        );
+    }
+
+    /**
+     * @psalm-suppress UndefinedInterfaceMethod
+     */
+    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    {
+        $root = new ArrayNodeDefinition('example_instrumentation');
+        $root
+            ->children()
+                ->scalarNode('span_name')->isRequired()->validate()->always(Validation::ensureString())->end()->end()
+            ->end()
+            ->canBeDisabled()
+        ;
+
+        return $root;
+    }
+}

examples/src/ExampleInstrumentation.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Example;
+
+use Exception;
+use OpenTelemetry\API\Globals;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\ConfigurationRegistry;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
+use OpenTelemetry\API\Trace\Span;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\Context\ContextStorageInterface;
+
+final class ExampleInstrumentation implements Instrumentation
+{
+
+    public function register(HookManager $hookManager, ?Context $context, ConfigurationRegistry $configuration, ContextStorageInterface $storage): void
+    {
+        $config = $configuration->get(ExampleConfig::class) ?? throw new Exception('example instrumentation must be configured');
+        if (!$config->enabled) {
+            return;
+        }
+
+        $tracer = $context ? $context->tracerProvider->getTracer('example-instrumentation') : Globals::tracerProvider()->getTracer('example-instrumentation');
+
+        $hookManager->hook(
+            Example::class,
+            'test',
+            static function () use ($tracer, $config, $storage): void {
+                $context = $storage->current();
+
+                $span = $tracer
+                    ->spanBuilder($config->spanName)
+                    ->setParent($context)
+                    ->startSpan();
+
+                $storage->attach($span->storeInContext($context));
+            },
+            static function () use ($storage): void {
+                if (!$scope = $storage->scope()) {
+                    return;
+                }
+
+                $scope->detach();
+
+                $span = Span::fromContext($scope->context());
+                $span->end();
+            }
+        );
+    }
+}

src/API/Globals.php

@@ -7,6 +7,7 @@
 use function assert;
 use Closure;
 use const E_USER_WARNING;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
 use OpenTelemetry\API\Instrumentation\Configurator;
 use OpenTelemetry\API\Instrumentation\ContextKeys;
 use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
@@ -34,6 +35,7 @@ public function __construct(
         private readonly LoggerProviderInterface $loggerProvider,
         private readonly EventLoggerProviderInterface $eventLoggerProvider,
         private readonly TextMapPropagatorInterface $propagator,
+        private readonly HookManager $hookManager,
     ) {
     }
 
@@ -62,6 +64,11 @@ public static function eventLoggerProvider(): EventLoggerProviderInterface
         return Context::getCurrent()->get(ContextKeys::eventLoggerProvider()) ?? self::globals()->eventLoggerProvider;
     }
 
+    public static function hookManager(): HookManager
+    {
+        return Context::getCurrent()->get(ContextKeys::hookManager()) ?? self::globals()->hookManager;
+    }
+
     /**
      * @param Closure(Configurator): Configurator $initializer
      *
@@ -103,10 +110,16 @@ private static function globals(): self
         $propagator = $context->get(ContextKeys::propagator());
         $loggerProvider = $context->get(ContextKeys::loggerProvider());
         $eventLoggerProvider = $context->get(ContextKeys::eventLoggerProvider());
+        $hookManager = $context->get(ContextKeys::hookManager());
 
-        assert(isset($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator));
+        assert(isset($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator, $hookManager));
 
-        return self::$globals = new self($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator);
+        return self::$globals = new self($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $propagator, $hookManager);
+    }
+
+    public static function init(): void
+    {
+        self::globals();
     }
 
     /**

src/API/Instrumentation/AutoInstrumentation/ConfigurationRegistry.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Instrumentation\AutoInstrumentation;
+
+final class ConfigurationRegistry
+{
+
+    private array $configurations = [];
+
+    public function add(InstrumentationConfiguration $configuration): self
+    {
+        $this->configurations[$configuration::class] = $configuration;
+
+        return $this;
+    }
+
+    /**
+     * @template C of InstrumentationConfiguration
+     * @param class-string<C> $id
+     * @return C|null
+     */
+    public function get(string $id): ?InstrumentationConfiguration
+    {
+        return $this->configurations[$id] ?? null;
+    }
+}

src/API/Instrumentation/AutoInstrumentation/ExtensionHookManager.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\API\Instrumentation\AutoInstrumentation;
+
+use function assert;
+use Closure;
+use function extension_loaded;
+use OpenTelemetry\Context\Context;
+use OpenTelemetry\Context\ContextKeyInterface;
+use ReflectionFunction;
+
+// #[Nevay\SPI\ServiceProviderDependency\ExtensionDependency('opentelemetry', '^1.0')]
+final class ExtensionHookManager implements HookManager
+{
+
+    private readonly ContextKeyInterface $contextKey;
+
+    public function __construct()
+    {
+        $this->contextKey = Context::createKey(self::class);
+    }
+
+    /**
+     * @phan-suppress PhanUndeclaredFunction
+     */
+    public function hook(?string $class, string $function, ?Closure $preHook = null, ?Closure $postHook = null): void
+    {
+        assert(extension_loaded('opentelemetry'));
+
+        /** @noinspection PhpFullyQualifiedNameUsageInspection */
+        \OpenTelemetry\Instrumentation\hook($class, $function, $this->bindHookScope($preHook), $this->bindHookScope($postHook));
+    }
+
+    public function enable(Context $context): Context
+    {
+        return $context->with($this->contextKey, true);
+    }
+
+    public function disable(Context $context): Context
+    {
+        return $context->with($this->contextKey, null);
+    }
+
+    private function bindHookScope(?Closure $closure): ?Closure
+    {
+        if (!$closure) {
+            return null;
+        }
+
+        $contextKey = $this->contextKey;
+        $reflection = new ReflectionFunction($closure);
+
+        // TODO Add an option flag to ext-opentelemetry `hook` that configures whether return values should be used?
+        if (!$reflection->getReturnType() || (string) $reflection->getReturnType() === 'void') {
+            return static function (mixed ...$args) use ($closure, $contextKey): void {
+                /*if (!Context::getCurrent()->get($contextKey)) {
+                    return;
+                }*/
+
+                $closure(...$args);
+            };
+        }
+
+        return static function (mixed ...$args) use ($closure, $contextKey): mixed {
+            /*if (!Context::getCurrent()->get($contextKey)) {
+                return null;
+            }*/
+
+            return $closure(...$args);
+        };
+    }
+}