add other properties, only attach baggage to transaction events

Author: Lms24

packages/core/src/envelope.ts

@@ -2,6 +2,7 @@ import {
   DsnComponents,
   Event,
   EventEnvelope,
+  EventEnvelopeHeaders,
   EventItem,
   SdkInfo,
   SdkMetadata,
@@ -10,7 +11,7 @@ import {
   SessionEnvelope,
   SessionItem,
 } from '@sentry/types';
-import { createBaggage, createEnvelope, dsnToString, serializeBaggage } from '@sentry/utils';
+import { BaggageObj, createBaggage, createEnvelope, dsnToString, serializeBaggage } from '@sentry/utils';
 
 /** Extract sdk info from from the API metadata */
 function getSdkMetadataForEnvelopeHeader(metadata?: SdkMetadata): SdkInfo | undefined {
@@ -101,15 +102,29 @@ export function createEventEnvelope(
   // TODO: This is NOT part of the hack - DO NOT DELETE
   delete event.sdkProcessingMetadata;
 
-  const baggage = createBaggage({ environment: event.environment, release: event.release });
-
-  const envelopeHeaders = {
+  let envelopeHeaders: EventEnvelopeHeaders = {
     event_id: event.event_id as string,
     sent_at: new Date().toISOString(),
-    baggage: serializeBaggage(baggage),
     ...(sdkInfo && { sdk: sdkInfo }),
     ...(!!tunnel && { dsn: dsnToString(dsn) }),
   };
+
+  if (eventType === 'transaction') {
+    const baggage = createBaggage({
+      environment: event.environment,
+      release: event.release,
+      transaction: event.transaction,
+      userid: event.user && event.user.id,
+      // TODO user.segment currently doesn't exist explicitly in interface User (just as a record key)
+      usersegment: event.user && event.user.segment,
+    } as BaggageObj);
+
+    envelopeHeaders = {
+      ...envelopeHeaders,
+      baggage: serializeBaggage(baggage),
+    };
+  }
+
   const eventItem: EventItem = [
     {
       type: eventType,

packages/types/src/envelope.ts

@@ -56,7 +56,7 @@ export type SessionItem =
   | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
 export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;
 
-type EventEnvelopeHeaders = { event_id: string; sent_at: string; baggage?: string };
+export type EventEnvelopeHeaders = { event_id: string; sent_at: string; baggage?: string };
 type SessionEnvelopeHeaders = { sent_at: string };
 type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
 

packages/types/src/index.ts

@@ -15,6 +15,7 @@ export type {
   EnvelopeItemType,
   EnvelopeItem,
   EventEnvelope,
+  EventEnvelopeHeaders,
   EventItem,
   SessionEnvelope,
   SessionItem,

packages/utils/src/baggage.ts

@@ -1,4 +1,4 @@
-export type AllowedBaggageKeys = 'environment' | 'release'; // TODO: Add remaining allowed baggage keys | 'transaction' | 'userid' | 'usersegment';
+export type AllowedBaggageKeys = 'environment' | 'release' | 'userid' | 'transaction' | 'usersegment';
 export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;
 
 /**