feat(tracing): Add transaction name to tracestate value (#3937)

Author: lobsterkatie

packages/core/test/lib/request.test.ts

@@ -87,12 +87,13 @@ describe('eventToSentryRequest', () => {
           //   public_key: 'dogsarebadatkeepingsecrets',
           //   release: 'off.leash.park',
           //   user: { id: '1121', segment: 'bigs' },
+          //   transaction: '/dogs/are/great/',
           // }),
           tracestate: {
             sentry:
               'sentry=eyJ0cmFjZV9pZCI6IjEyMzEyMDEyMTEyMTIwMTIiLCJlbnZpcm9ubWVudCI6ImRvZ3BhcmsiLCJwdWJsaWNfa2V5Ijo' +
               'iZG9nc2FyZWJhZGF0a2VlcGluZ3NlY3JldHMiLCJyZWxlYXNlIjoib2ZmLmxlYXNoLnBhcmsiLCJ1c2VyIjp7ImlkIjoiMTEyM' +
-              'SIsInNlZ21lbnQiOiJiaWdzIn19',
+              'SIsInNlZ21lbnQiOiJiaWdzIn0sInRyYW5zYWN0aW9uIjoiL2RvZ3MvYXJlL2dyZWF0LyJ9',
           },
         },
         spans: [],
@@ -135,6 +136,7 @@ describe('eventToSentryRequest', () => {
           public_key: 'dogsarebadatkeepingsecrets',
           release: 'off.leash.park',
           user: { id: '1121', segment: 'bigs' },
+          transaction: '/dogs/are/great/',
         });
       });
     });

packages/tracing/src/span.ts

@@ -393,6 +393,7 @@ export class Span implements SpanInterface {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       public_key: dsn.publicKey!,
       user,
+      transaction: this.transaction?.name,
     })}`;
   }
 

packages/tracing/src/utils.ts

@@ -157,6 +157,7 @@ type SentryTracestateData = {
   release?: string;
   public_key: string;
   user?: { id?: string; segment?: string };
+  transaction?: string;
 };
 
 /**

packages/tracing/test/span.test.ts

@@ -110,14 +110,20 @@ describe('Span', () => {
     const environment = 'dogpark';
     const traceId = '12312012123120121231201212312012';
     const user = { id: '1121', segment: 'bigs' };
+    const transactionName = 'FETCH /ball';
 
-    const computedTracestate = `sentry=${computeTracestateValue({
+    const baseTracestateData = {
       trace_id: traceId,
       environment,
       release,
       public_key: publicKey,
       user,
+    };
+    const computedTracestate = `sentry=${computeTracestateValue({
+      ...baseTracestateData,
+      transaction: transactionName,
     })}`;
+    const computedOrphanTracestate = `sentry=${computeTracestateValue(baseTracestateData)}`;
     const thirdpartyData = 'maisey=silly,charlie=goofy';
 
     const hub = new Hub(
@@ -134,14 +140,14 @@ describe('Span', () => {
     });
 
     test('no third-party data', () => {
-      const transaction = new Transaction({ name: 'FETCH /ball', traceId }, hub);
+      const transaction = new Transaction({ name: transactionName, traceId }, hub);
       const span = transaction.startChild({ op: 'dig.hole' });
 
       expect(span.getTraceHeaders().tracestate).toEqual(computedTracestate);
     });
 
     test('third-party data', () => {
-      const transaction = new Transaction({ name: 'FETCH /ball' }, hub);
+      const transaction = new Transaction({ name: transactionName }, hub);
       transaction.setMetadata({ tracestate: { sentry: computedTracestate, thirdparty: thirdpartyData } });
       const span = transaction.startChild({ op: 'dig.hole' });
 
@@ -153,7 +159,7 @@ describe('Span', () => {
       const span = new Span({ op: 'dig.hole' });
       span.traceId = traceId;
 
-      expect(span.getTraceHeaders().tracestate).toEqual(computedTracestate);
+      expect(span.getTraceHeaders().tracestate).toEqual(computedOrphanTracestate);
     });
   });