Set status code on the span for failures

Author: w1am

packages/opentelemetry/src/instrumentation.ts

@@ -267,15 +267,42 @@ export class Instrumentation extends InstrumentationBase {
 
         try {
           const result = await original.apply(this, [requests]);
+
+          const requestEndTime: TimeInput = Date.now();
+
+          if (result.success) {
+            requestSpans.forEach((span) => span.end(requestEndTime));
+          } else {
+            const failures: kurrentdb.AppendStreamFailure[] = result.output;
+            const failedStreamNames = new Set(
+              failures.map((f) => f.streamName)
+            );
+
+            requestSpans.forEach((span, index) => {
+              const request = requests[index];
+              let errorMessage = "This request did not go through successfully";
+
+              if (failedStreamNames.has(request.streamName)) {
+                const details = failures.find(
+                  (f) => f.streamName === request.streamName
+                )!.details;
+                errorMessage = details.type;
+              }
+
+              span.setStatus({
+                code: SpanStatusCode.ERROR,
+                message: errorMessage,
+              });
+              span.end(requestEndTime);
+            });
+          }
+
           return result;
         } catch (error) {
           requestSpans.forEach((span) => {
             Instrumentation.handleError(error, span);
           });
           throw error;
-        } finally {
-          const requestEndTime: TimeInput = Date.now();
-          requestSpans.forEach((span) => span.end(requestEndTime));
         }
       };
     };

packages/test/src/samples/opentelemetry.ts

@@ -29,6 +29,7 @@ import {
 import * as kurrentdb from "@kurrent/kurrentdb-client";
 import { KurrentAttributes } from "@kurrent/opentelemetry/src/attributes";
 import { v4 } from "uuid";
+import { SpanStatusCode } from "@opentelemetry/api";
 
 const memoryExporter = new InMemorySpanExporter();
 const otlpExporter = new OTLPTraceExporter({ url: "http://localhost:4317" }); // change this to your OTLP receiver address
@@ -214,5 +215,76 @@ describe("[sample] opentelemetry", () => {
         [KurrentAttributes.DATABASE_OPERATION]: "multiStreamAppend",
       });
     });
+
+    test("does not trace if result contains failures", async () => {
+      // Arrange
+      const defer = new Defer();
+
+      const { KurrentDBClient, jsonEvent } = await import(
+        "@kurrent/kurrentdb-client"
+      );
+
+      const client = KurrentDBClient.connectionString(node.connectionString());
+
+      const firstOrderReq: kurrentdb.AppendStreamRequest = {
+        streamName: `order-${v4()}`,
+        events: [
+          jsonEvent({
+            type: "OrderPlaced",
+            data: { id: v4() },
+          }),
+          jsonEvent({
+            type: "PaymentProcessed",
+            data: { id: v4() },
+          }),
+        ],
+        expectedState: kurrentdb.ANY,
+      };
+
+      const secondOrderReq: kurrentdb.AppendStreamRequest = {
+        streamName: `order-${v4()}`,
+        events: [
+          jsonEvent({
+            type: "OrderPlaced",
+            data: { customerId: "cust-456" },
+          }),
+        ],
+        expectedState: kurrentdb.STREAM_EXISTS,
+      };
+
+      // Act
+      const appendResponse = await client.multiStreamAppend([
+        firstOrderReq,
+        secondOrderReq,
+      ]);
+
+      expect(appendResponse.success).toBeFalsy();
+
+      // Assert
+      const firstOrderAppendSpans = getSpans(
+        KurrentAttributes.STREAM_APPEND,
+        firstOrderReq.streamName
+      );
+      const secondOrderAppendSpans = getSpans(
+        KurrentAttributes.STREAM_APPEND,
+        secondOrderReq.streamName
+      );
+
+      expect(firstOrderAppendSpans).toHaveLength(1);
+      expect(secondOrderAppendSpans).toHaveLength(1);
+
+      expect(firstOrderAppendSpans[0].attributes).toMatchObject({
+        [KurrentAttributes.KURRENT_DB_STREAM]: firstOrderReq.streamName,
+        [KurrentAttributes.SERVER_ADDRESS]: node.endpoints[0].address,
+        [KurrentAttributes.SERVER_PORT]: node.endpoints[0].port.toString(),
+        [KurrentAttributes.DATABASE_SYSTEM]: moduleName,
+        [KurrentAttributes.DATABASE_OPERATION]: "multiStreamAppend",
+      });
+
+      expect(secondOrderAppendSpans[0].status.code).toBe(SpanStatusCode.ERROR);
+      expect(secondOrderAppendSpans[0].status.message).toBe(
+        "wrong_expected_revision"
+      );
+    });
   });
 });