ignored routes

Author: overtrue

.idea/laravel-open-telemetry.iml

@@ -32,6 +32,14 @@
         // ...
     ],
 
+    /**
+     * Ignore routes will not be traced. You can use `*` as wildcard.
+     */
+    'ignore_routes' => [
+        // 'api/*',
+        // 'webhook/*',
+    ],
+
     /**
      * The name of the header that will be used to pass the trace id in the response.
      * if set to `null`, the header will not be added to the response.

.idea/php.xml

@@ -4,7 +4,7 @@
 
 use Closure;
 use Illuminate\Http\Request;
-use OpenTelemetry\API\Trace\SpanInterface;
+use Illuminate\Support\Str;
 use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\SemConv\TraceAttributes;
 use Overtrue\LaravelOpenTelemetry\Facades\Measure;
@@ -22,6 +22,12 @@ class MeasureRequest
      */
     public function handle(Request $request, Closure $next, ?string $name = null)
     {
+        // skip if ignored by config `otel.ignore_routes`
+        $ignoredRoutes = config('otel.ignore_routes', []);
+        if (Str::is($ignoredRoutes, $request->path())) {
+            return $next($request);
+        }
+
         static::$allowedHeaders = $this->normalizeHeaders(config('otel.allowed_headers', []));
 
         static::$sensitiveHeaders = array_merge(
@@ -50,8 +56,6 @@ public function handle(Request $request, Closure $next, ?string $name = null)
         }
     }
 
-
-
     protected static function httpHostName(Request $request): string
     {
         if (method_exists($request, 'host')) {

config/otel.php

@@ -7,9 +7,7 @@
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Support\ServiceProvider;
-use OpenTelemetry\API\Common\Time\Clock;
 use Overtrue\LaravelOpenTelemetry\Middlewares\MeasureRequest;
-use Overtrue\LaravelOpenTelemetry\Support\CarbonClock;
 use Overtrue\LaravelOpenTelemetry\Support\GuzzleTraceMiddleware;
 use Overtrue\LaravelOpenTelemetry\Support\Measure;
 

src/Middlewares/MeasureRequest.php

@@ -4,7 +4,6 @@
 
 use Closure;
 use GuzzleHttp\Promise\PromiseInterface;
-use OpenTelemetry\API\Globals;
 use OpenTelemetry\API\Trace\SpanInterface;
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\StatusCode;
@@ -22,7 +21,12 @@ public static function make(): Closure
     {
         return static function (callable $handler): callable {
             return static function (RequestInterface $request, array $options) use ($handler) {
-                $span = \Overtrue\LaravelOpenTelemetry\Facades\Measure::span(sprintf('HTTP %s', $request->getMethod()))
+                $name = sprintf(
+                    '[HTTP] %s %s',
+                    $request->getMethod(),
+                    $request->getUri()->__toString()
+                );
+                $span = \Overtrue\LaravelOpenTelemetry\Facades\Measure::span($name)
                     ->setSpanKind(SpanKind::KIND_CLIENT)
                     ->setAttribute(TraceAttributes::URL_FULL, sprintf('%s://%s%s', $request->getUri()->getScheme(), $request->getUri()->getHost(), $request->getUri()->getPath()))
                     ->setAttribute(TraceAttributes::URL_PATH, $request->getUri()->getPath())
@@ -91,4 +95,4 @@ protected static function recordHeaders(SpanInterface $span, RequestInterface|Re
 
         return $span;
     }
-}
+}

src/OpenTelemetryServiceProvider.php

@@ -26,8 +26,12 @@ public function __construct(protected Application $app)
         $app->terminating($this->flush(...));
     }
 
-    public function span(string $name): SpanBuilder
+    public function span(string $name, ?string $prefix = null): SpanBuilder
     {
+        if ($prefix) {
+            $name = sprintf('[%s] %s', $prefix, $name);
+        }
+
         return new SpanBuilder($this->tracer()->spanBuilder($name));
     }
 

src/Support/GuzzleTraceMiddleware.php

@@ -18,7 +18,7 @@ public static function instance(): self
     {
         static $instance;
 
-        return $instance ??= new self();
+        return $instance ??= new self;
     }
 
     public function set(&$carrier, string $key, string $value): void

src/Support/Measure.php

@@ -13,8 +13,7 @@ class SpanBuilder
 {
     public function __construct(
         protected SpanBuilderInterface $spanBuilder
-    ) {
-    }
+    ) {}
 
     public function setParent(?ContextInterface $context): SpanBuilder
     {
@@ -73,6 +72,9 @@ public function start(): SpanInterface
         return $this->spanBuilder->startSpan();
     }
 
+    /**
+     * @throws \Throwable
+     */
     public function measure(\Closure $callback): mixed
     {
         $span = $this->spanBuilder->startSpan();

src/Support/ResponsePropagationSetter.php

@@ -7,7 +7,5 @@
 
 class StartedSpan
 {
-    public function __construct(public SpanInterface $span, public ScopeInterface $scope)
-    {
-    }
+    public function __construct(public SpanInterface $span, public ScopeInterface $scope) {}
 }