Add http.response.status_code from Exception (#17)

Author: lucas-angeli-gimenes

src/Middleware/TraceMiddleware.php

@@ -4,6 +4,7 @@
 
 namespace Hyperf\OpenTelemetry\Middleware;
 
+use Hyperf\HttpMessage\Exception\HttpException;
 use Hyperf\OpenTelemetry\Support\Uri;
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\SemConv\Attributes\ClientAttributes;
@@ -62,12 +63,23 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         } catch (Throwable $exception) {
             $scope->recordException($exception);
 
+            $statusCode = $this->resolveStatusCode($exception);
+
+            $scope->setAttributes([
+                HttpAttributes::HTTP_RESPONSE_STATUS_CODE => $statusCode,
+            ]);
+
             throw $exception;
         } finally {
             $scope->end();
         }
     }
 
+    protected function resolveStatusCode(Throwable $exception): int
+    {
+        return $exception instanceof HttpException ? $exception->getStatusCode() : 500;
+    }
+
     protected function featureName(): string
     {
         return 'client_request';

tests/Unit/Middleware/TraceMiddlewareTest.php

@@ -5,6 +5,7 @@
 namespace Tests\Unit\Middleware;
 
 use Hyperf\Contract\ConfigInterface;
+use Hyperf\HttpMessage\Exception\HttpException;
 use Hyperf\OpenTelemetry\Instrumentation;
 use Hyperf\OpenTelemetry\Middleware\TraceMiddleware;
 use Hyperf\OpenTelemetry\Support\SpanScope;
@@ -258,6 +259,12 @@ public function testProcessWithException(): void
             ->method('recordException')
             ->with($exception);
 
+        $spanScope->expects($this->once())
+            ->method('setAttributes')
+            ->with([
+                HttpAttributes::HTTP_RESPONSE_STATUS_CODE => 500,
+            ]);
+
         $spanScope->expects($this->once())
             ->method('end');
 
@@ -279,6 +286,48 @@ public function testProcessWithException(): void
         $middleware->process($this->request, $handler);
     }
 
+    public function testProcessWithHttpException(): void
+    {
+        $this->configureRequestMock('POST', 'https://api.example.com:443/api/not-found');
+
+        $exception = new HttpException(404, 'Not Found');
+
+        $spanScope = $this->createMock(SpanScope::class);
+        $this->instrumentation->expects($this->once())
+            ->method('startSpan')
+            ->willReturn($spanScope);
+
+        $spanScope->expects($this->once())
+            ->method('recordException')
+            ->with($exception);
+
+        $spanScope->expects($this->once())
+            ->method('setAttributes')
+            ->with([
+                HttpAttributes::HTTP_RESPONSE_STATUS_CODE => 404,
+            ]);
+
+        $spanScope->expects($this->once())
+            ->method('end');
+
+        $handler = $this->createMock(RequestHandlerInterface::class);
+        $handler->expects($this->once())
+            ->method('handle')
+            ->with($this->request)
+            ->willThrowException($exception);
+
+        $this->expectException(HttpException::class);
+        $this->expectExceptionMessage('Not Found');
+
+        $middleware = new TraceMiddleware(
+            $this->config,
+            $this->instrumentation,
+            $this->switcher
+        );
+
+        $middleware->process($this->request, $handler);
+    }
+
     private function configureRequestMock(string $method, string $url, array $headers = []): void
     {
         $parts = parse_url($url);