feat(replay): Move sample rate tags into replay_event

Similar to #6658 but waiting on getsentry/replay-backend#226

Author: billyvg

packages/replay/src/util/sendReplayRequest.ts

@@ -52,6 +52,8 @@ export async function sendReplayRequest({
     replay_id: replayId,
     segment_id,
     replay_type: session.sampled,
+    session_sample_rate: options.sessionSampleRate,
+    error_sample_rate: options.errorSampleRate,
   };
 
   const replayEvent = await prepareReplayEvent({ scope, client, replayId, event: baseEvent });
@@ -63,12 +65,6 @@ export async function sendReplayRequest({
     return;
   }
 
-  replayEvent.tags = {
-    ...replayEvent.tags,
-    sessionSampleRate: options.sessionSampleRate,
-    errorSampleRate: options.errorSampleRate,
-  };
-
   /*
   For reference, the fully built event looks something like this:
   {
@@ -86,6 +82,8 @@ export async function sendReplayRequest({
       "replay_id": "eventId",
       "segment_id": 3,
       "replay_type": "error",
+      "session_sample_rate": 1,
+      "error_sample_rate": 0,
       "platform": "javascript",
       "event_id": "eventId",
       "environment": "production",
@@ -98,10 +96,6 @@ export async function sendReplayRequest({
           "version": "7.25.0"
       },
       "sdkProcessingMetadata": {},
-      "tags": {
-          "sessionSampleRate": 1,
-          "errorSampleRate": 0,
-      }
   }
   */
 

packages/replay/test/integration/errorSampleRate.test.ts

@@ -63,10 +63,8 @@ describe('Integration | errorSampleRate', () => {
       recordingPayloadHeader: { segment_id: 0 },
       replayEventPayload: expect.objectContaining({
         replay_type: 'error',
-        tags: expect.objectContaining({
-          errorSampleRate: 1,
-          sessionSampleRate: 0,
-        }),
+        error_sample_rate: 1,
+        session_sample_rate: 0,
       }),
       recordingData: JSON.stringify([
         { data: { isCheckout: true }, timestamp: BASE_TIMESTAMP, type: 2 },
@@ -93,10 +91,8 @@ describe('Integration | errorSampleRate', () => {
       recordingPayloadHeader: { segment_id: 1 },
       replayEventPayload: expect.objectContaining({
         replay_type: 'error',
-        tags: expect.objectContaining({
-          errorSampleRate: 1,
-          sessionSampleRate: 0,
-        }),
+        error_sample_rate: 1,
+        session_sample_rate: 0,
       }),
       recordingData: JSON.stringify([{ data: { isCheckout: true }, timestamp: BASE_TIMESTAMP + 5020, type: 2 }]),
     });

packages/replay/test/integration/events.test.ts

@@ -130,11 +130,9 @@ describe('Integration | events', () => {
     expect(replay).toHaveLastSentReplay({
       replayEventPayload: expect.objectContaining({
         replay_start_timestamp: (BASE_TIMESTAMP - 10000) / 1000,
+        error_sample_rate: 0,
+        session_sample_rate: 1,
         urls: ['http://localhost/'], // this doesn't truly test if we are capturing the right URL as we don't change URLs, but good enough
-        tags: expect.objectContaining({
-          errorSampleRate: 0,
-          sessionSampleRate: 1,
-        }),
       }),
     });
   });

packages/replay/test/unit/util/createReplayEnvelope.test.ts

@@ -24,10 +24,9 @@ describe('Unit | util | createReplayEnvelope', () => {
       version: '7.25.0',
     },
     replay_type: 'error',
-    tags: {
-      sessionSampleRate: 1,
-      errorSampleRate: 0,
-    },
+    error_sample_rate: 0,
+    session_sample_rate: 1,
+    tags: {},
   };
 
   const payloadWithSequence = 'payload';
@@ -56,13 +55,15 @@ describe('Unit | util | createReplayEnvelope', () => {
           {
             environment: 'production',
             error_ids: ['errorId'],
+            error_sample_rate: 0,
             event_id: REPLAY_ID,
             platform: 'javascript',
             replay_id: REPLAY_ID,
             replay_type: 'error',
             sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
             segment_id: 3,
-            tags: { errorSampleRate: 0, sessionSampleRate: 1 },
+            session_sample_rate: 1,
+            tags: {},
             timestamp: 1670837008.634,
             trace_ids: ['traceId'],
             type: 'replay_event',
@@ -90,13 +91,15 @@ describe('Unit | util | createReplayEnvelope', () => {
           {
             environment: 'production',
             error_ids: ['errorId'],
+            error_sample_rate: 0,
             event_id: REPLAY_ID,
             platform: 'javascript',
             replay_id: REPLAY_ID,
             sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
             segment_id: 3,
             replay_type: 'error',
-            tags: { errorSampleRate: 0, sessionSampleRate: 1 },
+            session_sample_rate: 1,
+            tags: {},
             timestamp: 1670837008.634,
             trace_ids: ['traceId'],
             type: 'replay_event',

packages/types/src/replay.ts

@@ -11,6 +11,8 @@ export interface ReplayEvent extends Event {
   replay_id: string;
   segment_id: number;
   replay_type: ReplayRecordingMode;
+  session_sample_rate: number;
+  error_sample_rate: number;
 }
 
 /**