Skip to content

feat(replay): Move sample rate tags into event context #6659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
billyvg merged 5 commits into from
Jan 31, 2023
Merged

feat(replay): Move sample rate tags into event context #6659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
93d0c46
feat(replay): Move sample rate tags into `replay_event`
billyvg Jan 4, 2023
1ec3319
tests
billyvg Jan 18, 2023
af12c6f
wip move to context
billyvg Jan 25, 2023
c1ea380
fix test
billyvg Jan 26, 2023
2404d7f
update integration test
billyvg Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/integration-tests/suites/replay/captureReplay/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ sentryTest('should capture replays', async ({ getLocalTestPath, page }) => {
},
},
platform: 'javascript',
tags: { sessionSampleRate: 1, errorSampleRate: 0 },
contexts: { replay: { session_sample_rate: 1, error_sample_rate: 0 } },
});

expect(replayEvent1).toBeDefined();
Expand Down Expand Up @@ -105,6 +105,6 @@ sentryTest('should capture replays', async ({ getLocalTestPath, page }) => {
},
},
platform: 'javascript',
tags: { sessionSampleRate: 1, errorSampleRate: 0 },
contexts: { replay: { session_sample_rate: 1, error_sample_rate: 0 } },
});
});
4 changes: 2 additions & 2 deletions packages/integration-tests/suites/replay/captureReplayViaBrowser/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
},
},
platform: 'javascript',
tags: { sessionSampleRate: 1, errorSampleRate: 0 },
contexts: { replay: { session_sample_rate: 1, error_sample_rate: 0 } },
});

expect(replayEvent1).toBeDefined();
Expand Down Expand Up @@ -106,6 +106,6 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
},
},
platform: 'javascript',
tags: { sessionSampleRate: 1, errorSampleRate: 0 },
contexts: { replay: { session_sample_rate: 1, error_sample_rate: 0 } },
});
});
21 changes: 13 additions & 8 deletions packages/replay/src/util/sendReplayRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,13 @@ export async function sendReplayRequest({
return;
}

replayEvent.tags = {
...replayEvent.tags,
sessionSampleRate: options.sessionSampleRate,
errorSampleRate: options.errorSampleRate,
replayEvent.contexts = {
...replayEvent.contexts,
replay: {
...(replayEvent.contexts && replayEvent.contexts.replay),
session_sample_rate: options.sessionSampleRate,
error_sample_rate: options.errorSampleRate,
},
};

/*
Expand Down Expand Up @@ -98,10 +101,12 @@ export async function sendReplayRequest({
"version": "7.25.0"
},
"sdkProcessingMetadata": {},
"tags": {
"sessionSampleRate": 1,
"errorSampleRate": 0,
}
"contexts": {
"replay": {
"session_sample_rate": 1,
"error_sample_rate": 0,
},
},
}
*/

Expand Down
20 changes: 12 additions & 8 deletions packages/replay/test/integration/errorSampleRate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,12 @@ describe('Integration | errorSampleRate', () => {
recordingPayloadHeader: { segment_id: 0 },
replayEventPayload: expect.objectContaining({
replay_type: 'error',
tags: expect.objectContaining({
errorSampleRate: 1,
sessionSampleRate: 0,
}),
contexts: {
replay: {
error_sample_rate: 1,
session_sample_rate: 0,
},
},
}),
recordingData: JSON.stringify([
{ data: { isCheckout: true }, timestamp: BASE_TIMESTAMP, type: 2 },
Expand All @@ -93,10 +95,12 @@ describe('Integration | errorSampleRate', () => {
recordingPayloadHeader: { segment_id: 1 },
replayEventPayload: expect.objectContaining({
replay_type: 'error',
tags: expect.objectContaining({
errorSampleRate: 1,
sessionSampleRate: 0,
}),
contexts: {
replay: {
error_sample_rate: 1,
session_sample_rate: 0,
},
},
}),
recordingData: JSON.stringify([{ data: { isCheckout: true }, timestamp: BASE_TIMESTAMP + 5020, type: 2 }]),
});
Expand Down
10 changes: 6 additions & 4 deletions packages/replay/test/integration/events.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,13 @@ describe('Integration | events', () => {
expect(replay).toHaveLastSentReplay({
replayEventPayload: expect.objectContaining({
replay_start_timestamp: (BASE_TIMESTAMP - 10000) / 1000,
contexts: {
replay: {
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,
}),
}),
});
});
Expand Down
25 changes: 20 additions & 5 deletions packages/replay/test/unit/util/createReplayEnvelope.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@ describe('Unit | util | createReplayEnvelope', () => {
version: '7.25.0',
},
replay_type: 'error',
tags: {
sessionSampleRate: 1,
errorSampleRate: 0,
contexts: {
replay: {
error_sample_rate: 0,
session_sample_rate: 1,
},
},
tags: {},
};

const payloadWithSequence = 'payload';
Expand All @@ -54,6 +57,12 @@ describe('Unit | util | createReplayEnvelope', () => {
[
{ type: 'replay_event' },
{
contexts: {
replay: {
error_sample_rate: 0,
session_sample_rate: 1,
},
},
environment: 'production',
error_ids: ['errorId'],
event_id: REPLAY_ID,
Expand All @@ -62,7 +71,7 @@ describe('Unit | util | createReplayEnvelope', () => {
replay_type: 'error',
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
segment_id: 3,
tags: { errorSampleRate: 0, sessionSampleRate: 1 },
tags: {},
timestamp: 1670837008.634,
trace_ids: ['traceId'],
type: 'replay_event',
Expand All @@ -88,6 +97,12 @@ describe('Unit | util | createReplayEnvelope', () => {
[
{ type: 'replay_event' },
{
contexts: {
replay: {
error_sample_rate: 0,
session_sample_rate: 1,
},
},
environment: 'production',
error_ids: ['errorId'],
event_id: REPLAY_ID,
Expand All @@ -96,7 +111,7 @@ describe('Unit | util | createReplayEnvelope', () => {
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
segment_id: 3,
replay_type: 'error',
tags: { errorSampleRate: 0, sessionSampleRate: 1 },
tags: {},
timestamp: 1670837008.634,
trace_ids: ['traceId'],
type: 'replay_event',
Expand Down
12 changes: 12 additions & 0 deletions packages/replay/test/unit/util/prepareReplayEvent.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ describe('Unit | util | prepareReplayEvent', () => {
replay_id: replayId,
replay_type: 'session',
segment_id: 3,
contexts: {
replay: {
error_sample_rate: 1.0,
session_sample_rate: 0.1,
},
},
};

const replayEvent = await prepareReplayEvent({ scope, client, replayId, event });
Expand All @@ -66,6 +72,12 @@ describe('Unit | util | prepareReplayEvent', () => {
platform: 'javascript',
event_id: 'replay-ID',
environment: 'production',
contexts: {
replay: {
error_sample_rate: 1.0,
session_sample_rate: 0.1,
},
},
sdk: {
name: 'sentry.javascript.testSdk',
version: '1.0.0',
Expand Down