fix(otel): Add transaction source logic to otel spans (#6160)

getsentry · Nov 9, 2022 · 8214839 · 8214839
1 parent 24cfda2
commit 8214839
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 8 deletions.
diff --git a/packages/opentelemetry-node/src/spanprocessor.ts b/packages/opentelemetry-node/src/spanprocessor.ts
@@ -172,9 +172,9 @@ function updateTransactionWithOtelData(transaction: Transaction, otelSpan: OtelS
 
   transaction.setStatus(mapOtelStatus(otelSpan));
 
-  const { op, description } = parseSpanDescription(otelSpan);
+  const { op, description, source } = parseSpanDescription(otelSpan);
   transaction.op = op;
-  transaction.name = description;
+  transaction.setName(description, source);
 }
 
 function convertOtelTimeToSeconds([seconds, nano]: [number, number]): number {

diff --git a/packages/opentelemetry-node/src/utils/parse-otel-span-description.ts b/packages/opentelemetry-node/src/utils/parse-otel-span-description.ts
@@ -1,10 +1,12 @@
 import { AttributeValue, SpanKind } from '@opentelemetry/api';
 import { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import { TransactionSource } from '@sentry/types';
 
 interface SpanDescription {
   op: string | undefined;
   description: string;
+  source: TransactionSource;
 }
 
 /**
@@ -36,6 +38,7 @@ export function parseSpanDescription(otelSpan: OtelSpan): SpanDescription {
     return {
       op: 'rpc',
       description: name,
+      source: 'route',
     };
   }
 
@@ -45,16 +48,17 @@ export function parseSpanDescription(otelSpan: OtelSpan): SpanDescription {
     return {
       op: 'message',
       description: name,
+      source: 'route',
     };
   }
 
   // If faas.trigger exists then this is a function as a service span.
   const faasTrigger = attributes[SemanticAttributes.FAAS_TRIGGER];
   if (faasTrigger) {
-    return { op: faasTrigger.toString(), description: name };
+    return { op: faasTrigger.toString(), description: name, source: 'route' };
   }
 
-  return { op: undefined, description: name };
+  return { op: undefined, description: name, source: 'custom' };
 }
 
 function descriptionForDbSystem(otelSpan: OtelSpan, _dbSystem: AttributeValue): SpanDescription {
@@ -65,7 +69,7 @@ function descriptionForDbSystem(otelSpan: OtelSpan, _dbSystem: AttributeValue):
 
   const description = statement ? statement.toString() : name;
 
-  return { op: 'db', description };
+  return { op: 'db', description, source: 'task' };
 }
 
 function descriptionForHttpMethod(otelSpan: OtelSpan, httpMethod: AttributeValue): SpanDescription {
@@ -82,15 +86,19 @@ function descriptionForHttpMethod(otelSpan: OtelSpan, httpMethod: AttributeValue
       break;
   }
 
+  const httpTarget = attributes[SemanticAttributes.HTTP_TARGET];
+  const httpRoute = attributes[SemanticAttributes.HTTP_ROUTE];
+
   // Ex. /api/users
-  const httpPath = attributes[SemanticAttributes.HTTP_ROUTE] || attributes[SemanticAttributes.HTTP_TARGET];
+  const httpPath = httpRoute || httpTarget;
 
   if (!httpPath) {
-    return { op: opParts.join('.'), description: name };
+    return { op: opParts.join('.'), description: name, source: 'custom' };
   }
 
   // Ex. description="GET /api/users".
   const description = `${httpMethod} ${httpPath}`;
+  const source: TransactionSource = httpRoute ? 'route' : 'url';
 
-  return { op: opParts.join('.'), description };
+  return { op: opParts.join('.'), description, source };
 }
diff --git a/packages/opentelemetry-node/test/spanprocessor.test.ts b/packages/opentelemetry-node/test/spanprocessor.test.ts
@@ -443,6 +443,36 @@ describe('SentrySpanProcessor', () => {
       });
     });
 
+    it('adds transaction source `url` for HTTP_TARGET', async () => {
+      const tracer = provider.getTracer('default');
+
+      tracer.startActiveSpan('GET /users', otelSpan => {
+        const sentrySpan = getSpanForOtelSpan(otelSpan);
+
+        otelSpan.setAttribute(SemanticAttributes.HTTP_METHOD, 'GET');
+        otelSpan.setAttribute(SemanticAttributes.HTTP_TARGET, '/my/route/123');
+
+        otelSpan.end();
+
+        expect(sentrySpan?.transaction?.metadata.source).toBe('url');
+      });
+    });
+
+    it('adds transaction source `url` for HTTP_ROUTE', async () => {
+      const tracer = provider.getTracer('default');
+
+      tracer.startActiveSpan('GET /users', otelSpan => {
+        const sentrySpan = getSpanForOtelSpan(otelSpan);
+
+        otelSpan.setAttribute(SemanticAttributes.HTTP_METHOD, 'GET');
+        otelSpan.setAttribute(SemanticAttributes.HTTP_ROUTE, '/my/route/:id');
+
+        otelSpan.end();
+
+        expect(sentrySpan?.transaction?.metadata.source).toBe('route');
+      });
+    });
+
     it('updates based on attributes for DB_SYSTEM', async () => {
       const tracer = provider.getTracer('default');