Mobile Replay: beforeXyz options

[kahest]

This issue is to discuss/track, which beforeXyz options we want to add to Mobile SDKs for Session Replay (if any).

Background

We currently provide a few beforeXyz options that users can use to adapt specific behaviours. From the docs:

• beforeAddRecordingEvent: Filter additional recording events that include console logs and network requests/responses.
• beforeErrorSampling: Filter error events which should be skipped for error sampling. Return false if error sampling should be skipped for this error event, or true to sample for this error. Will only be called in buffer mode.

For Mobile, we identified a few options we think might be valuable to add to support more varied use cases. Note that none of these are implemented and no alignment on naming, signature, etc. has happened until now:

• onRenderedScreenshot: called after taking, before masking screenshot; e.g. remove screenshot, write to disk for debugging, add timestamp (draft PR we use for debugging)
• onMaskedScreenshot: called after masking screenshot; e.g. remove screenshot, write to disk for debugging (draft PR we use for debugging)
• onEncodedVideoSegment: called after a video segment has been generated from previously taken frames (could solve the request of Locally export session replay during development sentry-cocoa#4835)
• beforeCaptureSessionReplay: called before Replay is captured; e.g. don't capture Replays for specific users, screens, feature flags, app states (requested by user in Add a before hook to session replay sentry-cocoa#4834)
• beforeSendSessionReplay: called before Replay is sent; e.g. remove replay that's too long/short, don't send for specific user (requested by user in Add a before hook to session replay sentry-cocoa#4834)

[getsantry]

Routing to @getsentry/product-owners-replays for triage ⏲️

[philprime]

I believe this one also relates to the topic by introducing a hook to get the encoded video segment, like onEncodedVideoSegment or similar.

getsentry/sentry-cocoa#4835

[bruno-garcia]

beforeSendSessionReplay

Not sure how this one would work? We tried to offer this through beforeAddRecordingEvent. But "the replay" is made of segments. So we need to be sure we're not giving the wrong impression here that you can "drop" the replay once it has started/

[romtsn]

beforeSendSessionReplay

Not sure how this one would work? We tried to offer this through beforeAddRecordingEvent. But "the replay" is made of segments. So we need to be sure we're not giving the wrong impression here that you can "drop" the replay once it has started/

I guess we'd have to educate that you'd need to hold onto replay_id and drop all events for the same one if you wanna drop a replay entirely.

[cobyeastwood183]

https://sentry.zendesk.com/agent/tickets/147392

[cruddell001]

Our team is interested in the beforeSessionReplay event for mobile. Specifically, we want to limit the types of exceptions that qualify for session replays, and this seems like the most likely roadmap item to accomplish that. We are holding off using session replays until we can have such functionality.