👷 Laravel instrumentation 1.1.x

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,18 +9,16 @@
   "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",
-    "open-telemetry/sem-conv": "^1.24"
+    "laravel/framework": "^10.0 || ^11.0",
+    "open-telemetry/opentelemetry": "dev-auto-instrumentation-registration"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.50",
     "guzzlehttp/guzzle": "*",
     "nunomaduro/collision": "*",
-    "open-telemetry/sdk": "^1.0",
     "orchestra/testbench": ">=7.41.3",
     "phan/phan": "^5.0",
     "php-http/mock-client": "*",
@@ -44,11 +42,28 @@
       "OpenTelemetry\\Tests\\Contrib\\Instrumentation\\Laravel\\": "tests/"
     }
   },
+  "extra": {
+    "spi-config": {
+      "autoload-files": true
+    },
+    "spi": {
+      "OpenTelemetry\\Config\\SDK\\Configuration\\ComponentProvider": [
+        "OpenTelemetry\\Contrib\\Instrumentation\\Laravel\\LaravelComponentProvider"
+      ]
+    }
+  },
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/brettmc/opentelemetry-php"
+    }
+  ],
   "config": {
     "lock": false,
     "sort-packages": true,
     "allow-plugins": {
-      "php-http/discovery": false
+      "php-http/discovery": false,
+      "tbachert/spi": true
     }
   }
 }

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

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks;
+
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
+use OpenTelemetry\API\Logs\LoggerInterface;
+use OpenTelemetry\API\Metrics\MeterInterface;
+use OpenTelemetry\API\Trace\TracerInterface;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelConfiguration;
+
+interface Hook
+{
+    public function instrument(
+        HookManager $hookManager,
+        LaravelConfiguration $configuration,
+        LoggerInterface $logger,
+        MeterInterface $meter,
+        TracerInterface $tracer,
+    ): void;
+}

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

@@ -5,34 +5,40 @@
 namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Illuminate\Console;
 
 use Illuminate\Console\Command as IlluminateCommand;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
+use OpenTelemetry\API\Logs\LoggerInterface;
+use OpenTelemetry\API\Metrics\MeterInterface;
 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\LaravelConfiguration;
 use OpenTelemetry\SemConv\TraceAttributes;
 use Throwable;
 
-class Command implements LaravelHook
+class Command implements Hook
 {
-    use LaravelHookTrait;
     use PostHookTrait;
 
-    public function instrument(): void
-    {
-        $this->hookExecute();
+    public function instrument(
+        HookManager $hookManager,
+        LaravelConfiguration $configuration,
+        LoggerInterface $logger,
+        MeterInterface $meter,
+        TracerInterface $tracer,
+    ): void {
+        $this->hookExecute($hookManager, $tracer);
     }
 
-    protected function hookExecute(): bool
+    protected function hookExecute(HookManager $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 +51,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,47 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Console\Kernel as KernelContract;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
+use OpenTelemetry\API\Logs\LoggerInterface;
+use OpenTelemetry\API\Metrics\MeterInterface;
 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\LaravelConfiguration;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
-use function OpenTelemetry\Instrumentation\hook;
 use OpenTelemetry\SemConv\TraceAttributes;
 use Throwable;
 
-class Kernel implements LaravelHook
+class Kernel implements Hook
 {
     use AttributesBuilder;
-    use LaravelHookTrait;
     use PostHookTrait;
 
-    public function instrument(): void
-    {
+    public function instrument(
+        HookManager $hookManager,
+        LaravelConfiguration $configuration,
+        LoggerInterface $logger,
+        MeterInterface $meter,
+        TracerInterface $tracer,
+    ): void {
         if (LaravelInstrumentation::shouldTraceCli()) {
-            $this->hookHandle();
+            $this->hookHandle($hookManager, $tracer);
         }
     }
 
-    private function hookHandle(): bool
+    private function hookHandle(HookManager $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 +60,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;

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

@@ -8,41 +8,47 @@
 use Illuminate\Http\Request;
 use Illuminate\Routing\Route;
 use OpenTelemetry\API\Globals;
+use OpenTelemetry\API\Instrumentation\AutoInstrumentation\HookManager;
+use OpenTelemetry\API\Logs\LoggerInterface;
+use OpenTelemetry\API\Metrics\MeterInterface;
 use OpenTelemetry\API\Trace\Span;
 use OpenTelemetry\API\Trace\SpanInterface;
 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\LaravelHook;
-use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHookTrait;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Hook;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\PostHookTrait;
+use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelConfiguration;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Propagators\HeadersPropagator;
 use OpenTelemetry\Contrib\Instrumentation\Laravel\Propagators\ResponsePropagationSetter;
-use function OpenTelemetry\Instrumentation\hook;
 use OpenTelemetry\SemConv\TraceAttributes;
 use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
-class Kernel implements LaravelHook
+class Kernel implements Hook
 {
-    use LaravelHookTrait;
     use PostHookTrait;
 
-    public function instrument(): void
-    {
-        $this->hookHandle();
+    public function instrument(
+        HookManager $hookManager,
+        LaravelConfiguration $configuration,
+        LoggerInterface $logger,
+        MeterInterface $meter,
+        TracerInterface $tracer,
+    ): void {
+        $this->hookHandle($hookManager, $tracer);
     }
 
-    protected function hookHandle(): bool
+    protected function hookHandle(HookManager $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) {
                 $request = ($params[0] instanceof Request) ? $params[0] : null;
                 /** @psalm-suppress ArgumentTypeCoercion */
-                $builder = $this->instrumentation
-                    ->tracer()
+                $builder = $tracer
                     ->spanBuilder(sprintf('%s', $request?->method() ?? 'unknown'))
                     ->setSpanKind(SpanKind::KIND_SERVER)
                     ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
@@ -75,7 +81,7 @@ protected function hookHandle(): bool
 
                 return [$request];
             },
-            post: function (KernelContract $kernel, array $params, ?Response $response, ?Throwable $exception) {
+            postHook: function (KernelContract $kernel, array $params, ?Response $response, ?Throwable $exception) {
                 $scope = Context::storage()->scope();
                 if (!$scope) {
                     return;