changes for Lumen support

new999day · Apr 3, 2024 · 5664521 · 5664521
1 parent 83f0504
commit 5664521
Show file tree

Hide file tree

Showing 16 changed files with 73 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib.
 
-# OpenTelemetry Laravel auto-instrumentation
+# OpenTelemetry Lumen auto-instrumentation
 
 Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to
 install and configure the extension and SDK.

diff --git a/_register.php b/_register.php
@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-use OpenTelemetry\Contrib\Instrumentation\Laravel\LaravelInstrumentation;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\LumenInstrumentation;
 use OpenTelemetry\SDK\Sdk;
 
-if (class_exists(Sdk::class) && Sdk::isInstrumentationDisabled(LaravelInstrumentation::NAME) === true) {
+if (class_exists(Sdk::class) && Sdk::isInstrumentationDisabled(LumenInstrumentation::NAME) === true) {
     return;
 }
 
@@ -15,4 +15,4 @@
     return;
 }
 
-LaravelInstrumentation::register();
+LumenInstrumentation::register();
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
-  "name": "open-telemetry/opentelemetry-auto-laravel",
-  "description": "OpenTelemetry auto-instrumentation for Laravel",
-  "keywords": ["opentelemetry", "otel", "open-telemetry", "tracing", "laravel", "instrumentation"],
+  "name": "open-telemetry/opentelemetry-auto-lumen",
+  "description": "OpenTelemetry auto-instrumentation for Lumen",
+  "keywords": ["opentelemetry", "otel", "open-telemetry", "tracing", "lumen", "instrumentation"],
   "type": "library",
   "homepage": "https://opentelemetry.io/docs/php",
   "readme": "./README.md",
@@ -11,37 +11,22 @@
     "php": "^8.0",
     "ext-json": "*",
     "ext-opentelemetry": "*",
-    "laravel/framework": ">=6.0",
+    "illuminate/routing": "8.x-dev",
+    "laravel/lumen-framework": "^8.0",
     "open-telemetry/api": "^1.0",
     "open-telemetry/sem-conv": "^1.23"
   },
-  "require-dev": {
-    "friendsofphp/php-cs-fixer": "^3",
-    "guzzlehttp/guzzle": "*",
-    "laravel/tinker": "*",
-    "nunomaduro/collision": "*",
-    "open-telemetry/sdk": "^1.0",
-    "orchestra/testbench": ">=4.0",
-    "phan/phan": "^5.0",
-    "php-http/mock-client": "*",
-    "phpstan/phpstan": "^1.1",
-    "phpstan/phpstan-phpunit": "^1.0",
-    "phpunit/phpunit": "^9.5",
-    "psalm/plugin-phpunit": "^0.18.4",
-    "spatie/laravel-ignition": "*",
-    "vimeo/psalm": "^5.0"
-  },
   "autoload": {
     "psr-4": {
-      "OpenTelemetry\\Contrib\\Instrumentation\\Laravel\\": "src/"
+      "OpenTelemetry\\Contrib\\Instrumentation\\Lumen\\": "src/"
     },
     "files": [
       "_register.php"
     ]
   },
   "autoload-dev": {
     "psr-4": {
-      "OpenTelemetry\\Tests\\Contrib\\Instrumentation\\Laravel\\": "tests/"
+      "OpenTelemetry\\Tests\\Contrib\\Instrumentation\\Lumen\\": "tests/"
     }
   },
   "config": {

diff --git a/src/ConsoleInstrumentation.php b/src/ConsoleInstrumentation.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen;
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Console\Kernel;

diff --git a/src/HeadersPropagator.php b/src/HeadersPropagator.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen;
 
 use function assert;
 use Illuminate\Http\Request;

diff --git a/src/HttpInstrumentation.php b/src/HttpInstrumentation.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen;
 
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Http\Request;

diff --git a/src/LaravelInstrumentation.php b/src/LaravelInstrumentation.php
diff --git a/src/LumenInstrumentation.php b/src/LumenInstrumentation.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen;
+
+use Illuminate\Contracts\Foundation\Application;
+use OpenTelemetry\API\Instrumentation\CachedInstrumentation;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\CacheWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\ClientRequestWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\ExceptionWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\LogWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\QueryWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\RequestWatcher;
+use OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers\Watcher;
+use function OpenTelemetry\Instrumentation\hook;
+use Throwable;
+
+class LumenInstrumentation
+{
+    public const NAME = 'lumen';
+
+    public static function registerWatchers(Application $app, Watcher $watcher)
+    {
+        $watcher->register($app);
+    }
+
+    public static function register(): void
+    {
+        $instrumentation = new CachedInstrumentation('io.opentelemetry.contrib.php.lumen');
+
+        hook(
+            Application::class,
+            '__construct',
+            post: static function (Application $application, array $params, mixed $returnValue, ?Throwable $exception) use ($instrumentation) {
+                self::registerWatchers($application, new CacheWatcher());
+                self::registerWatchers($application, new ClientRequestWatcher($instrumentation));
+                self::registerWatchers($application, new ExceptionWatcher());
+                self::registerWatchers($application, new LogWatcher());
+                self::registerWatchers($application, new QueryWatcher($instrumentation));
+                self::registerWatchers($application, new RequestWatcher());
+            },
+        );
+
+        ConsoleInstrumentation::register($instrumentation);
+        HttpInstrumentation::register($instrumentation);
+    }
+}
diff --git a/src/ResponsePropagationSetter.php b/src/ResponsePropagationSetter.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen;
 
 use function assert;
 use Illuminate\Http\Response;

diff --git a/src/Watchers/CacheWatcher.php b/src/Watchers/CacheWatcher.php
@@ -2,13 +2,14 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Cache\Events\CacheHit;
 use Illuminate\Cache\Events\CacheMissed;
 use Illuminate\Cache\Events\KeyForgotten;
 use Illuminate\Cache\Events\KeyWritten;
 use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Support\Facades\Date;
 use OpenTelemetry\API\Trace\Span;
 use OpenTelemetry\Context\Context;
 
@@ -50,13 +51,13 @@ public function recordCacheSet(KeyWritten $event): void
             'key' => $event->key,
             'tags' => json_encode($event->tags),
             'expires_at' => $ttl > 0
-                ? now()->addSeconds($ttl)->getTimestamp()
+                ? Date::now()->addSeconds($ttl)->getTimestamp()
                 : 'never',
             'expires_in_seconds' => $ttl > 0
                 ? $ttl
                 : 'never',
             'expires_in_human' => $ttl > 0
-                ? now()->addSeconds($ttl)->diffForHumans()
+                ? Date::now()->addSeconds($ttl)->diffForHumans()
                 : 'never',
         ]);
     }

diff --git a/src/Watchers/ClientRequestWatcher.php b/src/Watchers/ClientRequestWatcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Http\Client\Events\ConnectionFailed;

diff --git a/src/Watchers/ExceptionWatcher.php b/src/Watchers/ExceptionWatcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Log\Events\MessageLogged;

diff --git a/src/Watchers/LogWatcher.php b/src/Watchers/LogWatcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Log\Events\MessageLogged;

diff --git a/src/Watchers/QueryWatcher.php b/src/Watchers/QueryWatcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\Events\QueryExecuted;

diff --git a/src/Watchers/RequestWatcher.php b/src/Watchers/RequestWatcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Routing\Events\RouteMatched;

diff --git a/src/Watchers/Watcher.php b/src/Watchers/Watcher.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Watchers;
+namespace OpenTelemetry\Contrib\Instrumentation\Lumen\Watchers;
 
 use Illuminate\Contracts\Foundation\Application;