feat(tracing): Add user data to tracestate header (#3343)

Author: lobsterkatie

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

@@ -28,7 +28,7 @@ describe('eventToSentryRequest', () => {
     environment: 'dogpark',
     event_id: '0908201304152013',
     release: 'off.leash.park',
-    user: { id: '1121', username: 'CharlieDog', ip_address: '11.21.20.12' },
+    user: { id: '1121', username: 'CharlieDog', ip_address: '11.21.20.12', segment: 'bigs' },
   };
 
   describe('error/message events', () => {
@@ -65,13 +65,15 @@ describe('eventToSentryRequest', () => {
           // computeTracestateValue({
           //   trace_id: '1231201211212012',
           //   environment: 'dogpark',
-          //   release: 'off.leash.park',
           //   public_key: 'dogsarebadatkeepingsecrets',
+          //   release: 'off.leash.park',
+          //   user: { id: '1121', segment: 'bigs' },
           // }),
           tracestate: {
             sentry:
-              'sentry=eyJ0cmFjZV9pZCI6IjEyMzEyMDEyMTEyMTIwMTIiLCJlbnZpcm9ubWVudCI6ImRvZ3BhcmsiLCJyZWxlYXNlIjoib2ZmLmxlYXNo' +
-              'LnBhcmsiLCJwdWJsaWNfa2V5IjoiZG9nc2FyZWJhZGF0a2VlcGluZ3NlY3JldHMifQ',
+              'sentry=eyJ0cmFjZV9pZCI6IjEyMzEyMDEyMTEyMTIwMTIiLCJlbnZpcm9ubWVudCI6ImRvZ3BhcmsiLCJwdWJsaWNfa2V5Ijo' +
+              'iZG9nc2FyZWJhZGF0a2VlcGluZ3NlY3JldHMiLCJyZWxlYXNlIjoib2ZmLmxlYXNoLnBhcmsiLCJ1c2VyIjp7ImlkIjoiMTEyM' +
+              'SIsInNlZ21lbnQiOiJiaWdzIn19',
           },
         },
         spans: [],
@@ -160,10 +162,11 @@ describe('eventToSentryRequest', () => {
 
           expect(envelope.envelopeHeader.trace).toBeDefined();
           expect(envelope.envelopeHeader.trace).toEqual({
+            trace_id: '1231201211212012',
             environment: 'dogpark',
             public_key: 'dogsarebadatkeepingsecrets',
             release: 'off.leash.park',
-            trace_id: '1231201211212012',
+            user: { id: '1121', segment: 'bigs' },
           });
         });
       });

packages/tracing/src/span.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-lines */
-import { getCurrentHub } from '@sentry/hub';
-import { Hub, Primitive, Span as SpanInterface, SpanContext, TraceHeaders, Transaction } from '@sentry/types';
+import { getCurrentHub, Hub } from '@sentry/hub';
+import { Primitive, Span as SpanInterface, SpanContext, TraceHeaders, Transaction } from '@sentry/types';
 import { dropUndefinedKeys, logger, timestampWithMs, uuid4 } from '@sentry/utils';
 
 import { SpanStatus } from './spanstatus';
@@ -288,6 +288,14 @@ export class Span implements SpanInterface {
    * @inheritDoc
    */
   public getTraceHeaders(): TraceHeaders {
+    // if this span is part of a transaction, but that transaction doesn't yet have a tracestate value, create one
+    if (this.transaction && !this.transaction?.metadata.tracestate?.sentry) {
+      this.transaction.metadata.tracestate = {
+        ...this.transaction.metadata.tracestate,
+        sentry: this._getNewTracestate(),
+      };
+    }
+
     const tracestate = this._toTracestate();
 
     return {
@@ -357,8 +365,11 @@ export class Span implements SpanInterface {
    *
    * @returns The new Sentry tracestate entry, or undefined if there's no client or no dsn
    */
-  protected _getNewTracestate(hub: Hub = getCurrentHub()): string | undefined {
+  protected _getNewTracestate(): string | undefined {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+    const hub = ((this.transaction as any)?._hub as Hub) || getCurrentHub();
     const client = hub.getClient();
+    const { id: userId, segment: userSegment } = hub.getScope()?.getUser() || {};
     const dsn = client?.getDsn();
 
     if (!client || !dsn) {
@@ -372,11 +383,12 @@ export class Span implements SpanInterface {
     // `dsn.publicKey` required and remove the `!`.
 
     return `sentry=${computeTracestateValue({
-      traceId: this.traceId,
+      trace_id: this.traceId,
       environment,
       release,
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      publicKey: dsn.publicKey!,
+      public_key: dsn.publicKey!,
+      user: { id: userId, segment: userSegment },
     })}`;
   }
 
@@ -392,9 +404,11 @@ export class Span implements SpanInterface {
   }
 
   /**
-   * Return a tracestate-compatible header string. Returns undefined if there is no client or no DSN.
+   * Return a tracestate-compatible header string, including both sentry and third-party data (if any). Returns
+   * undefined if there is no client or no DSN.
    */
   private _toTracestate(): string | undefined {
+    // if this is an orphan span, create a new tracestate value
     const sentryTracestate = this.transaction?.metadata?.tracestate?.sentry || this._getNewTracestate();
     let thirdpartyTracestate = this.transaction?.metadata?.tracestate?.thirdparty;
 

packages/tracing/src/transaction.ts

@@ -40,11 +40,6 @@ export class Transaction extends SpanClass implements TransactionInterface {
     this._trimEnd = transactionContext.trimEnd;
     this._hub = hub || getCurrentHub();
 
-    // create a new sentry tracestate value if we didn't inherit one
-    if (!this.metadata.tracestate?.sentry) {
-      this.metadata.tracestate = { ...this.metadata.tracestate, sentry: this._getNewTracestate(this._hub) };
-    }
-
     // this is because transactions are also spans, and spans have a transaction pointer
     this.transaction = this;
   }
@@ -117,6 +112,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
       }).endTimestamp;
     }
 
+    // ensure that we have a tracestate to attach to the envelope header
+    if (!this.metadata.tracestate?.sentry) {
+      this.metadata.tracestate = { ...this.metadata.tracestate, sentry: this._getNewTracestate() };
+    }
+
     const transaction: Event = {
       contexts: {
         trace: this.getTraceContext(),

packages/tracing/src/utils.ts

@@ -145,10 +145,11 @@ export function secToMs(time: number): number {
 export { stripUrlQueryAndFragment } from '@sentry/utils';
 
 type SentryTracestateData = {
-  traceId: string;
+  trace_id: string;
   environment: string | undefined | null;
   release: string | undefined | null;
-  publicKey: string;
+  public_key: string;
+  user: { id: string | undefined | null; segment: string | undefined | null };
 };
 
 /**
@@ -159,9 +160,11 @@ type SentryTracestateData = {
  */
 export function computeTracestateValue(data: SentryTracestateData): string {
   // `JSON.stringify` will drop keys with undefined values, but not ones with null values, so this prevents
-  // `environment` and `release` from being dropped if they haven't been set by `Sentry.init`
+  // these values from being dropped if they haven't been set by `Sentry.init`
   data.environment = data.environment || null;
   data.release = data.release || null;
+  data.user.id = data.user.id || null;
+  data.user.segment = data.user.segment || null;
 
   // See https://www.w3.org/TR/trace-context/#tracestate-header-field-values
   // The spec for tracestate header values calls for a string of the form