👷 Laravel instrumentation 1.1.x

.github/workflows/php.yml

@@ -76,6 +76,8 @@ jobs:
             php-version: 7.4
           - project: 'Instrumentation/Laravel'
             php-version: 7.4
+          - project: 'Instrumentation/Laravel'
+            php-version: 8.0
           - project: 'Instrumentation/CodeIgniter'
             php-version: 7.4
           - project: 'Instrumentation/Yii'

src/Instrumentation/Laravel/.phan/config.php

@@ -42,7 +42,7 @@
     //
     // Note that the **only** effect of choosing `'5.6'` is to infer that functions removed in php 7.0 exist.
     // (See `backward_compatibility_checks` for additional options)
-    'target_php_version' => '8.0',
+    'target_php_version' => '8.1',
 
     // If enabled, missing properties will be created when
     // they are first seen. If false, we'll report an

src/Instrumentation/Laravel/_register.php

@@ -1,18 +1,27 @@
 <?php
+/**
+ * This file must *only* be used to register SPI components, as it
+ * will be pruned automatically via the tbachert/spi plugin.
+ */
 
 declare(strict_types=1);
 
+use Nevay\SPI\ServiceLoader;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Instrumentation;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
-use OpenTelemetry\SDK\Sdk;
 
-if (class_exists(Sdk::class) && Sdk::isInstrumentationDisabled(LaravelInstrumentation::NAME) === true) {
-    return;
-}
+ServiceLoader::register(Instrumentation::class, LaravelInstrumentation::class);
 
-if (extension_loaded('opentelemetry') === false) {
-    trigger_error('The opentelemetry extension must be loaded in order to autoload the OpenTelemetry Laravel auto-instrumentation', E_USER_WARNING);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Console\Command::class);
 
-    return;
-}
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Contracts\Console\Kernel::class);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Contracts\Http\Kernel::class);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Contracts\Queue\Queue::class);
 
-LaravelInstrumentation::register();
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Foundation\Console\ServeCommand::class);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Foundation\Application::class);
+
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Queue\Queue::class);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Queue\SyncQueue::class);
+ServiceLoader::register(Hooks\Hook::class, Hooks\Illuminate\Queue\Worker::class);

src/Instrumentation/Laravel/composer.json

@@ -9,26 +9,24 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require": {
-    "php": "^8.0",
+    "php": "^8.1",
     "ext-json": "*",
-    "ext-opentelemetry": "*",
-    "laravel/framework": "^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0",
-    "open-telemetry/api": "^1.0",
+    "laravel/framework": "^10.0 || ^11.0",
+    "open-telemetry/api": "^1.1.1",
     "open-telemetry/sem-conv": "^1.24"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.50",
     "guzzlehttp/guzzle": "*",
-    "nunomaduro/collision": "*",
-    "open-telemetry/sdk": "^1.0",
+    "open-telemetry/sdk": "^1.1",
+    "open-telemetry/sdk-configuration": "^0.0.5",
     "orchestra/testbench": ">=7.41.3",
     "phan/phan": "^5.0",
     "php-http/mock-client": "*",
     "phpstan/phpstan": "^1.1",
     "phpstan/phpstan-phpunit": "^1.0",
-    "phpunit/phpunit": "^9.5",
+    "phpunit/phpunit": "^10.5 || ^11.3",
     "psalm/plugin-phpunit": "^0.18.4",
-    "spatie/laravel-ignition": "*",
     "vimeo/psalm": "^5.0"
   },
   "autoload": {
@@ -44,11 +42,25 @@
       "OpenTelemetry\\Tests\\Contrib\\Instrumentation\\Laravel\\": "tests/"
     }
   },
+  "suggest": {
+    "ext-opentelemetry": "Required to provide auto-instrumentation hooks."
+  },
+  "extra": {
+    "spi-config": {
+      "autoload-files": true
+    },
+    "spi": {
+      "OpenTelemetry\\Config\\SDK\\Configuration\\ComponentProvider": [
+        "OpenTelemetry\\Contrib\\Instrumentation\\Laravel\\ComponentProvider\\LaravelComponentProvider"
+      ]
+    }
+  },
   "config": {
     "lock": false,
     "sort-packages": true,
     "allow-plugins": {
-      "php-http/discovery": false
+      "php-http/discovery": false,
+      "tbachert/spi": true
     }
   }
 }

src/Instrumentation/Laravel/phpunit.xml.dist

@@ -5,6 +5,7 @@
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
     backupGlobals="false"
     backupStaticAttributes="false"
+    bootstrap="tests/bootstrap.php"
     cacheResult="false"
     colors="false"
     convertErrorsToExceptions="true"
@@ -41,7 +42,10 @@
         <env name="MAIL_MAILER" value="array"/>
         <env name="QUEUE_CONNECTION" value="sync"/>
         <env name="SESSION_DRIVER" value="array"/>
-        <env name="TELESCOPE_ENABLED" value="false"/>        
+        <env name="TELESCOPE_ENABLED" value="false"/>
+
+        <server name="OTEL_PHP_AUTOLOAD_ENABLED" value="true"/>
+        <server name="OTEL_EXPERIMENTAL_CONFIG_FILE" value="tests/Fixtures/otel-instrumentation.yaml"/>
     </php>
 
     <testsuites>

src/Instrumentation/Laravel/src/ComponentProvider/LaravelComponentProvider.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Contrib\Instrumentation\Laravel\ComponentProvider;
+
+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\Contrib\Instrumentation\Laravel\LaravelConfiguration;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+class LaravelComponentProvider implements ComponentProvider
+{
+    /**
+     * @phan-suppress PhanTypeMismatchReturn
+     */
+    public function createPlugin(array $properties, Context $context): InstrumentationConfiguration
+    {
+        return LaravelConfiguration::fromArray($properties);
+    }
+
+    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    {
+        $root = new ArrayNodeDefinition('laravel');
+
+        return $root
+            ->canBeDisabled()
+            ->addDefaultsIfNotSet()
+        ;
+    }
+}

src/Instrumentation/Laravel/src/Hooks/Hook.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks;
+
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Context as InstrumentationContext;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManagerInterface;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
+
+interface Hook
+{
+    public function instrument(
+        LaravelInstrumentation $instrumentation,
+        HookManagerInterface $hookManager,
+        InstrumentationContext $context,
+    ): void;
+}

src/Instrumentation/Laravel/src/Hooks/Illuminate/Console/Command.php

@@ -5,34 +5,43 @@
 namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Illuminate\Console;
 
 use Illuminate\Console\Command as IlluminateCommand;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Context as InstrumentationContext;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManagerInterface;
 use OpenTelemetry\API\Trace\Span;
+use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\Context\Context;
-use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHook;
-use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHookTrait;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Hook;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\PostHookTrait;
-use function OpenTelemetry\Instrumentation\hook;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
 use OpenTelemetry\SemConv\TraceAttributes;
+use OpenTelemetry\SemConv\Version;
 use Throwable;
 
-class Command implements LaravelHook
+class Command implements Hook
 {
-    use LaravelHookTrait;
     use PostHookTrait;
 
-    public function instrument(): void
-    {
-        $this->hookExecute();
+    public function instrument(
+        LaravelInstrumentation $instrumentation,
+        HookManagerInterface $hookManager,
+        InstrumentationContext $context,
+    ): void {
+        $tracer = $context->tracerProvider->getTracer(
+            $instrumentation->buildProviderName('console', 'command'),
+            schemaUrl: Version::VERSION_1_24_0->url(),
+        );
+
+        $this->hookExecute($hookManager, $tracer);
     }
 
-    protected function hookExecute(): bool
+    protected function hookExecute(HookManagerInterface $hookManager, TracerInterface $tracer): void
     {
-        return hook(
+        $hookManager->hook(
             IlluminateCommand::class,
             'execute',
-            pre: function (IlluminateCommand $command, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
+            preHook: function (IlluminateCommand $command, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($tracer) {
                 /** @psalm-suppress ArgumentTypeCoercion */
-                $builder = $this->instrumentation
-                    ->tracer()
+                $builder = $tracer
                     ->spanBuilder(sprintf('Command %s', $command->getName() ?: 'unknown'))
                     ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
                     ->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
@@ -45,7 +54,7 @@ protected function hookExecute(): bool
 
                 return $params;
             },
-            post: function (IlluminateCommand $command, array $params, ?int $exitCode, ?Throwable $exception) {
+            postHook: function (IlluminateCommand $command, array $params, ?int $exitCode, ?Throwable $exception) {
                 $scope = Context::storage()->scope();
                 if (!$scope) {
                     return;

src/Instrumentation/Laravel/src/Hooks/Illuminate/Contracts/Console/Kernel.php

@@ -6,41 +6,49 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Console\Kernel as KernelContract;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\Context as InstrumentationContext;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManagerInterface;
 use OpenTelemetry\API\Trace\Span;
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\StatusCode;
+use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\Context\Context;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Hook;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Illuminate\Queue\AttributesBuilder;
-use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHook;
-use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHookTrait;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\PostHookTrait;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
-use function OpenTelemetry\Instrumentation\hook;
 use OpenTelemetry\SemConv\TraceAttributes;
+use OpenTelemetry\SemConv\Version;
 use Throwable;
 
-class Kernel implements LaravelHook
+class Kernel implements Hook
 {
     use AttributesBuilder;
-    use LaravelHookTrait;
     use PostHookTrait;
 
-    public function instrument(): void
-    {
-        if (LaravelInstrumentation::shouldTraceCli()) {
-            $this->hookHandle();
+    public function instrument(
+        LaravelInstrumentation $instrumentation,
+        HookManagerInterface $hookManager,
+        InstrumentationContext $context,
+    ): void {
+        $tracer = $context->tracerProvider->getTracer(
+            $instrumentation->buildProviderName('console', 'kernel'),
+            schemaUrl: Version::VERSION_1_24_0->url(),
+        );
+
+        if ($instrumentation->shouldTraceCli()) {
+            $this->hookHandle($hookManager, $tracer);
         }
     }
 
-    private function hookHandle(): bool
+    private function hookHandle(HookManagerInterface $hookManager, TracerInterface $tracer): void
     {
-        return hook(
+        $hookManager->hook(
             KernelContract::class,
             'handle',
-            pre: function (KernelContract $kernel, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
+            preHook: function (KernelContract $kernel, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($tracer) {
                 /** @psalm-suppress ArgumentTypeCoercion */
-                $builder = $this->instrumentation
-                    ->tracer()
+                $builder = $tracer
                     ->spanBuilder('Artisan handler')
                     ->setSpanKind(SpanKind::KIND_PRODUCER)
                     ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
@@ -54,7 +62,7 @@ private function hookHandle(): bool
 
                 return $params;
             },
-            post: function (KernelContract $kernel, array $params, ?int $exitCode, ?Throwable $exception) {
+            postHook: function (KernelContract $kernel, array $params, ?int $exitCode, ?Throwable $exception) {
                 $scope = Context::storage()->scope();
                 if (!$scope) {
                     return;