Record completed/failed spans via SpanRecorder

Author: AdilAzhari

src/Span/SpanError.php

@@ -13,8 +13,7 @@ public function __construct(
         public string $message,
         public ?string $file,
         public ?int $line,
-    ) {
-    }
+    ) {}
 
     public static function fromThrowable(Throwable $exception): self
     {

src/Tracing/Tracer.php

@@ -6,19 +6,20 @@
 
 use DateTimeImmutable;
 use LaravelTrace\LaravelTrace\Context\TraceContext;
+use LaravelTrace\LaravelTrace\Contracts\SpanRecorder;
 use LaravelTrace\LaravelTrace\Contracts\TraceContextStore;
 use LaravelTrace\LaravelTrace\Contracts\Tracer as TracerContract;
 use LaravelTrace\LaravelTrace\Span\Span;
 use LaravelTrace\LaravelTrace\Span\SpanType;
 use LaravelTrace\LaravelTrace\Trace\Trace;
 use LogicException;
-use RuntimeException;
 use Throwable;
 
 final readonly class Tracer implements TracerContract
 {
     public function __construct(
         private TraceContextStore $contextStore,
+        private SpanRecorder $spanRecorder,
     ) {}
 
     public function start(string $name): Trace
@@ -81,16 +82,26 @@ public function clearContext(): void
 
     public function complete(Span $span): Span
     {
-        return $span->complete(
+        $completed = $span->complete(
             new DateTimeImmutable,
         );
+
+        $this->spanRecorder->record($completed);
+
+        return $completed;
     }
 
-    public function fail(Span $span,Throwable $exception,): Span
-    {
-        return $span->fail(
-            $exception,
-            new DateTimeImmutable,
+    public function fail(
+        Span $span,
+        Throwable $exception,
+    ): Span {
+        $failed = $span->fail(
+            exception: $exception,
+            finishedAt: new DateTimeImmutable,
         );
+
+        $this->spanRecorder->record($failed);
+
+        return $failed;
     }
 }

tests/Unit/Context/InMemoryTraceContextStoreTest.php

@@ -6,13 +6,13 @@
 use LaravelTrace\LaravelTrace\Context\TraceContext;
 use LaravelTrace\LaravelTrace\Trace\TraceId;
 
-it('returns null when no context exists', function () {
+it('returns null when no context exists', function (): void {
     $store = new InMemoryTraceContextStore;
 
     expect($store->get())->toBeNull();
 });
 
-it('stores and retrieves a context', function () {
+it('stores and retrieves a context', function (): void {
     $store = new InMemoryTraceContextStore;
 
     $context = new TraceContext(
@@ -24,7 +24,7 @@
     expect($store->get())->toBe($context);
 });
 
-it('can clear the current context', function () {
+it('can clear the current context', function (): void {
     $store = new InMemoryTraceContextStore;
 
     $context = new TraceContext(

tests/Unit/Context/TraceContextTest.php

@@ -6,6 +6,7 @@
 use LaravelTrace\LaravelTrace\Context\TraceContext;
 use LaravelTrace\LaravelTrace\Span\SpanId;
 use LaravelTrace\LaravelTrace\Trace\TraceId;
+use LaravelTrace\LaravelTrace\Tracing\InMemorySpanRecorder;
 use LaravelTrace\LaravelTrace\Tracing\Tracer;
 
 it('creates a context with a trace', function (): void {
@@ -50,9 +51,10 @@
         ->toBe($spanId);
 });
 
-it('sets the trace context when starting a trace', function () {
+it('sets the trace context when starting a trace', function (): void {
     $store = new InMemoryTraceContextStore;
-    $tracer = new Tracer($store);
+    $record = new InMemorySpanRecorder;
+    $tracer = new Tracer($store, $record);
 
     $trace = $tracer->start('CreateOrder');
 

tests/Unit/Span/SpanErrorTest.php

@@ -4,7 +4,7 @@
 
 use LaravelTrace\LaravelTrace\Span\SpanError;
 
-it('creates an error from a throwable', function () {
+it('creates an error from a throwable', function (): void {
     $exception = new RuntimeException(
         'Payment provider timed out',
     );

tests/Unit/Span/SpanTest.php

@@ -50,7 +50,7 @@
         ->toBe($parent->id);
 });
 
-it('completes a span', function () {
+it('completes a span', function (): void {
     $traceId = TraceId::generate();
 
     $span = Span::start(
@@ -71,7 +71,7 @@
         ->toBe(SpanStatus::Running);
 });
 
-it('fails a span', function () {
+it('fails a span', function (): void {
     $traceId = TraceId::generate();
 
     $span = Span::start(
@@ -86,7 +86,7 @@
         'Inventory service failed',
     );
 
-    $failed = $span->fail($exception,$finishedAt);
+    $failed = $span->fail($exception, $finishedAt);
 
     expect($failed->status)
         ->toBe(SpanStatus::Failed)

tests/Unit/Tracing/SpanScopeTest.php

@@ -7,11 +7,13 @@
 use LaravelTrace\LaravelTrace\Span\SpanStatus;
 use LaravelTrace\LaravelTrace\Span\SpanType;
 use LaravelTrace\LaravelTrace\Trace\TraceId;
+use LaravelTrace\LaravelTrace\Tracing\InMemorySpanRecorder;
 use LaravelTrace\LaravelTrace\Tracing\Tracer;
 
-it('restores the previous context when closed', function () {
+it('restores the previous context when closed', function (): void {
     $store = new InMemoryTraceContextStore;
-    $tracer = new Tracer($store);
+    $record = new InMemorySpanRecorder;
+    $tracer = new Tracer($store, $record);
 
     $tracer->start('CreateOrder');
 
@@ -36,9 +38,10 @@
         ->toBe($parentContext);
 });
 
-it('fails a span and restores the previous context', function () {
-    $store = new InMemoryTraceContextStore();
-    $tracer = new Tracer($store);
+it('fails a span and restores the previous context', function (): void {
+    $store = new InMemoryTraceContextStore;
+    $record = new InMemorySpanRecorder;
+    $tracer = new Tracer($store, $record);
 
     $tracer->start('CreateOrder');
 
@@ -70,7 +73,7 @@
         ->toBe($parentContext);
 });
 
-it('does not retain an error when completing a span', function () {
+it('does not retain an error when completing a span', function (): void {
     $traceId = TraceId::generate();
 
     $span = Span::start(
@@ -80,7 +83,7 @@
     );
 
     $completed = $span->complete(
-        new DateTimeImmutable(),
+        new DateTimeImmutable,
     );
 
     expect($completed->status)

tests/Unit/Tracing/TracerTest.php

@@ -6,11 +6,15 @@
 use LaravelTrace\LaravelTrace\Span\SpanStatus;
 use LaravelTrace\LaravelTrace\Span\SpanType;
 use LaravelTrace\LaravelTrace\Trace\TraceStatus;
+use LaravelTrace\LaravelTrace\Tracing\InMemorySpanRecorder;
 use LaravelTrace\LaravelTrace\Tracing\Tracer;
 
-it('starts a trace', function () {
+it('starts a trace', function (): void {
+    $recorder = new InMemorySpanRecorder;
+
     $tracer = new Tracer(
-        new InMemoryTraceContextStore(),
+        new InMemoryTraceContextStore,
+        $recorder,
     );
 
     $trace = $tracer->start('CreateOrder');
@@ -21,9 +25,11 @@
         ->toBe(TraceStatus::Running);
 });
 
-it('starts a span inside a trace', function () {
+it('starts a span inside a trace', function (): void {
+    $recorder = new InMemorySpanRecorder;
     $tracer = new Tracer(
-        new InMemoryTraceContextStore(),
+        new InMemoryTraceContextStore,
+        $recorder,
     );
 
     $trace = $tracer->start('CreateOrder');
@@ -44,3 +50,55 @@
         ->and($span->status)
         ->toBe(SpanStatus::Running);
 });
+
+it('records a completed span', function (): void {
+    $recorder = new InMemorySpanRecorder;
+
+    $tracer = new Tracer(
+        new InMemoryTraceContextStore,
+        $recorder,
+    );
+
+    $tracer->start('CreateOrder');
+
+    $scope = $tracer->span(
+        'ReserveInventory',
+        SpanType::Action,
+    );
+
+    $completed = $scope->close();
+
+    expect($recorder->all())
+        ->toHaveCount(1)
+        ->and($recorder->all()[0])
+        ->toBe($completed);
+});
+
+it('records a failed span', function (): void {
+    $recorder = new InMemorySpanRecorder;
+
+    $tracer = new Tracer(
+        new InMemoryTraceContextStore,
+        $recorder,
+    );
+
+    $tracer->start('CreateOrder');
+
+    $scope = $tracer->span(
+        'ChargePayment',
+        SpanType::Action,
+    );
+
+    $exception = new RuntimeException(
+        'Payment provider failed',
+    );
+
+    $failed = $scope->fail($exception);
+
+    expect($recorder->all())
+        ->toHaveCount(1)
+        ->and($recorder->all()[0])
+        ->toBe($failed)
+        ->and($failed->status)
+        ->toBe(SpanStatus::Failed);
+});