Allow custom traces enrichment (#23)

* feat: add custom append methods for override

* chore: change get root span method visibility

* feat: allow append custom span

Author: fkw3t

src/Aspect/HttpClientAspect.php

@@ -104,31 +104,45 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
         $options['headers'] = array_replace($options['headers'] ?? [], $appendHeaders);
         $proceedingJoinPoint->arguments['keys']['options'] = $options;
 
+        $this->appendCustomSpan($span, $options);
+
         /** @var PromiseInterface $result */
         $result = $proceedingJoinPoint->process();
         $result->then(
-            $this->onFullFilled($span),
-            $this->onRejected($span)
+            $this->onFullFilled($span, $options),
+            $this->onRejected($span, $options)
         );
         $span->finish();
 
         return $result;
     }
 
-    private function onFullFilled(Span $span): callable
+    protected function appendCustomSpan(Span $span, array $options): void
     {
-        return function (ResponseInterface $response) use ($span) {
+        // just for override
+    }
+
+    protected function appendCustomResponseSpan(Span $span, array $options, ?ResponseInterface $response): void
+    {
+        // just for override
+    }
+
+    private function onFullFilled(Span $span, array $options): callable
+    {
+        return function (ResponseInterface $response) use ($span, $options) {
             $span->setTag(
                 $this->spanTagManager->get('http_client', 'http.status_code'),
                 $response->getStatusCode()
             );
             $span->setTag('otel.status_code', 'OK');
+
+            $this->appendCustomResponseSpan($span, $options, $response);
         };
     }
 
-    private function onRejected(Span $span): callable
+    private function onRejected(Span $span, array $options): callable
     {
-        return function (RequestException $exception) use ($span) {
+        return function (RequestException $exception) use ($span, $options) {
             if ($this->switchManager->isEnabled('exception')) {
                 $this->appendExceptionToSpan($span, $exception);
             }
@@ -138,6 +152,8 @@ private function onRejected(Span $span): callable
                 $exception->getResponse()->getStatusCode()
             );
 
+            $this->appendCustomResponseSpan($span, $options, $exception->getResponse());
+
             return Create::rejectionFor($exception);
         };
     }

src/Middleware/TraceMiddleware.php

@@ -92,7 +92,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             $response = $handler->handle($request);
             $span->setTag($this->spanTagManager->get('response', 'status_code'), $response->getStatusCode());
             $span->setTag('otel.status_code', 'OK');
-            $this->appendCustomResponseSpan($span, $response);
+            $this->appendCustomResponseSpan($span, $request, $response);
         } catch (Throwable $exception) {
             $this->switchManager->isEnabled('exception') && $this->appendExceptionToSpan($span, $exception);
             if ($exception instanceof HttpException) {
@@ -112,7 +112,12 @@ protected function appendCustomExceptionSpan(Span $span, Throwable $exception):
         // just for override
     }
 
-    protected function appendCustomResponseSpan(Span $span, ResponseInterface $response): void
+    protected function appendCustomSpan(Span $span, ServerRequestInterface $request): void
+    {
+        // just for override
+    }
+
+    protected function appendCustomResponseSpan(Span $span, ServerRequestInterface $request, ResponseInterface $response): void
     {
         // just for override
     }
@@ -146,6 +151,8 @@ protected function buildSpan(ServerRequestInterface $request): Span
             $span->setTag("attribute.{$key}", $value);
         }
 
+        $this->appendCustomSpan($span, $request);
+
         return $span;
     }
 

src/SpanStarter.php

@@ -70,7 +70,7 @@ protected function startSpan(
         return $child;
     }
 
-    private function getTracerRoot(int $coroutineId): ?Span
+    public function getTracerRoot(int $coroutineId): ?Span
     {
         /** @var null|Span $root */
         $root = Context::get('tracer.root', null, $coroutineId);