Do not trace events with non json metadata (#386)

EventStore · Aug 30, 2024 · 6836848 · 6836848
1 parent c54e366
commit 6836848
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 15 deletions.
diff --git a/packages/opentelemetry/src/instrumentation.ts b/packages/opentelemetry/src/instrumentation.ts
@@ -228,9 +228,9 @@ export class Instrumentation extends InstrumentationBase {
       const resolvedEvent = resolved as ResolvedEvent;
       const metadata = resolvedEvent?.event?.metadata;
 
-      if (!resolvedEvent.event?.isJson) return;
+      if (typeof metadata !== "object" || metadata === null) return resolved;
 
-      const parentContext = Instrumentation.restoreContext(metadata!);
+      const parentContext = Instrumentation.restoreContext(metadata);
 
       const { hostname, port } = Instrumentation.getServerAddress(uri);
 
@@ -360,14 +360,18 @@ export class Instrumentation extends InstrumentationBase {
     };
   }
 
-  private static restoreContext = (metadata: esdb.MetadataType): Context => {
+  private static restoreContext = (
+    metadata: esdb.MetadataType,
+    isRemote = true
+  ): Context => {
     const traceId = metadata[TRACE_ID] as string;
     const spanId = metadata[SPAN_ID] as string;
 
     const parentContext = trace.setSpanContext(context.active(), {
       traceId,
       spanId,
       traceFlags: TraceFlags.SAMPLED,
+      isRemote,
     });
 
     return parentContext;

diff --git a/packages/test/src/opentelemetry/instrumentation.test.ts b/packages/test/src/opentelemetry/instrumentation.test.ts
@@ -1,10 +1,4 @@
-import {
-  createTestNode,
-  Defer,
-  delay,
-  jsonTestEvents,
-  binaryTestEvents,
-} from "@test-utils";
+import { createTestNode, Defer, delay, jsonTestEvents } from "@test-utils";
 import {
   NodeTracerProvider,
   InMemorySpanExporter,
@@ -28,7 +22,6 @@ instrumentation.disable();
 import * as esdb from "@eventstore/db-client";
 import {
   AppendToStreamOptions,
-  binaryEvent,
   ResolvedEvent,
   streamNameFilter,
   WrongExpectedVersionError,
@@ -264,7 +257,7 @@ describe("instrumentation", () => {
       });
     });
 
-    test("non json events are not instrumented in subscription", async () => {
+    test.only("events with non-json metadata are not traced in subscriptions", async () => {
       const defer = new Defer();
       const { EventStoreDBClient, jsonEvent, binaryEvent } = await import(
         "@eventstore/db-client"
@@ -292,10 +285,16 @@ describe("instrumentation", () => {
       const event1 = binaryEvent({
         type: "SomeType",
         data: Buffer.from("hello"),
+        metadata: {
+          "some-data": "some-value",
+        },
       });
       const event2 = jsonEvent({
         type: "SomeType",
-        data: {},
+        data: {
+          "some-data": "some-value",
+        },
+        metadata: 2,
       });
 
       await client.appendToStream(STREAM, [event1, event2]);
@@ -317,22 +316,28 @@ describe("instrumentation", () => {
 
       const spans = memoryExporter.getFinishedSpans();
 
+      const parentSpans = spans.filter(
+        (span) => span.name === EventStoreDBAttributes.STREAM_APPEND
+      );
+
       const childSpans = spans.filter(
         (span) => span.name === EventStoreDBAttributes.STREAM_SUBSCIBE
       );
 
       expect(handleConfirmation).toHaveBeenCalledTimes(1);
 
+      expect(parentSpans.length).toBe(1);
+
       expect(childSpans).toBeDefined();
 
       expect(childSpans).toHaveLength(1);
 
       expect(
         childSpans[0].attributes[EventStoreDBAttributes.EVENT_STORE_EVENT_ID]
-      ).toBe(event2.id);
+      ).toBe(event1.id);
       expect(
         childSpans[0].attributes[EventStoreDBAttributes.EVENT_STORE_EVENT_TYPE]
-      ).toBe(event2.type);
+      ).toBe(event1.type);
     });
   });