feat: Implement OpenTelemetry Basic Instrumentation (#320)

* feat: install keepsuit/laravel-opentelemetry library

* feat: add otlp driver to Monolog

* feat: add basic instrumentation middleware

* fix: final fixes in middleware

* fix: MR comments, generating dynamic span id

* feat: Add Open Telemetry environment vars

* feat: default for env variable

Author: rreynametova

.env.example

@@ -203,4 +203,8 @@ EMAIL_TEMPLATE_GENERIC_SPEAKER_BANNER=https://spaces.fnvirtual.app/FNTECH/Generi
 EMAIL_TEMPLATE_TICKET_TOP_GRAPHIC=https://spaces.fnvirtual.app/emails/REGISTRATION_ATTENDEE_TICKET/header-top.jpg
 EMAIL_TEMPLATE_TICKET_BOTTOM_GRAPHIC=https://spaces.fnvirtual.app/emails/REGISTRATION_ATTENDEE_TICKET/header-bottom.jpg
 EMAIL_TEMPLATE_PRIMARY_COLOR="#000000"
-EMAIL_TEMPLATE_SECONDARY_COLOR="#808080"
+EMAIL_TEMPLATE_SECONDARY_COLOR="#808080"
+
+#Open Telemetry vars
+OTEL_EXPORTER_OTLP_ENDPOINT=
+TRACE_SPAN_PREFIX=SPAN

app/Http/Kernel.php

@@ -28,6 +28,7 @@ class Kernel extends HttpKernel
     protected $middleware = [
         //\App\Http\Middleware\TrustProxies::class,
         \App\Http\Middleware\CheckForMaintenanceMode::class,
+        \App\Http\Middleware\TrackRequestMiddleware::class,
         \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
         \App\Http\Middleware\TrimStrings::class,
         //\Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,

app/Http/Middleware/TrackRequestMiddleware.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Http\Request;
+use Closure;
+use Illuminate\Support\Str;
+use \OpenTelemetry\API\Trace\SpanInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Illuminate\Log\LogManager;
+use Keepsuit\LaravelOpenTelemetry\Facades\Tracer;
+
+
+class TrackRequestMiddleware
+{
+    /**
+     * @var LogManager
+     */
+    protected LogManager $logger;
+
+    /**
+     * @var float
+     */
+    protected float $startTime = 0;
+
+    /**
+     * @var SpanInterface
+     */
+    protected SpanInterface $span;
+
+    /**
+     * Constructor del middleware.
+     * Laravel inyectará el LogManager aquí.
+     *
+     * @param LogManager $logger
+     */
+    public function __construct(LogManager $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        try {
+            // generating dynamic id for span with configurable prefix
+            $spanId = env('TRACE_SPAN_PREFIX', 'SPAN') . '_' . Str::uuid();
+            $this->startTime = microtime(true);
+            $this->span = Tracer::newSpan($spanId)->start();
+
+            $this->logger->channel('otlp')->info('Request started.', [
+                'endpoint' => $request->url(),
+                'method' => $request->method(),
+                'timestamp_utc' => now()->toIso8601String(),
+            ]);
+        } catch (\Throwable $e) {
+            // forcing 'single' channel in case otlp log fails
+            $this->logger->channel('single')->error("Error on request tracking" . $e->getMessage());
+        }
+
+        $response = $next($request);
+        return $response;
+    }
+
+    /**
+     * @param Request $request
+     * @param Response $response
+     * @return void
+     */
+    public function terminate(Request $request, Response $response): void
+    {
+        try {
+            $endTime = microtime(true);
+            $responseTime = intval(($endTime - $this->startTime) * 1000);
+            $this->logger->channel('otlp')->info('Request finished.', [
+                'response_time' => $responseTime,
+            ]);
+
+            if (isset($this->span)) {
+                $this->span->end();
+            }
+
+        } catch (\Throwable $e) {
+            // forcing 'single' channel in case otlp log fails
+            $this->logger->channel('single')->error("Error on request tracking: " . $e->getMessage());
+        }
+    }
+}

composer.json

@@ -15,14 +15,8 @@
         "ext-openssl": "*",
         "ext-pdo": "*",
         "ext-zlib": "*",
-        "laravel/framework": "12.1.1",
-        "laravel/helpers": "^1.7.0",
-        "laravel/tinker": "2.10.1",
-        "laravel-doctrine/orm": "3.1.1",
-        "laravel-doctrine/extensions": "2.0.1",
-        "laravel-doctrine/migrations": "3.4.0",
-        "beberlei/doctrineextensions": "1.5.0",
         "affinipay/chargeio-php": "dev-master",
+        "beberlei/doctrineextensions": "1.5.0",
         "behat/transliterator": "^1.2",
         "caseyamcl/guzzle_retry_middleware": "^2.6",
         "cocur/slugify": "^2.3",
@@ -33,6 +27,14 @@
         "google/apiclient": "^2.2",
         "guzzlehttp/guzzle": "7.8.2",
         "guzzlehttp/uri-template": "^1.0",
+        "keepsuit/laravel-opentelemetry": "^1.6",
+        "laminas/laminas-math": "^3.7",
+        "laravel-doctrine/extensions": "2.0.1",
+        "laravel-doctrine/migrations": "3.4.0",
+        "laravel-doctrine/orm": "3.1.1",
+        "laravel/framework": "12.1.1",
+        "laravel/helpers": "^1.7.0",
+        "laravel/tinker": "2.10.1",
         "league/csv": "^9.6",
         "league/flysystem-aws-s3-v3": "3.8.0",
         "league/oauth2-client": "^2.4",
@@ -48,8 +50,7 @@
         "stripe/stripe-php": "^7.95.0",
         "symfony/yaml": "^7.1.1",
         "tecnickcom/tcpdf": "^6.2",
-        "vladimir-yuldashev/laravel-queue-rabbitmq": "v14.2.0",
-        "laminas/laminas-math": "^3.7"
+        "vladimir-yuldashev/laravel-queue-rabbitmq": "v14.2.0"
     },
     "require-dev": {
         "fakerphp/faker": "^1.23",
@@ -114,7 +115,9 @@
         "sort-packages": true,
         "optimize-autoloader": true,
         "allow-plugins": {
-            "composer/package-versions-deprecated": true
+            "composer/package-versions-deprecated": true,
+            "php-http/discovery": true,
+            "tbachert/spi": true
         }
     },
     "minimum-stability": "dev",