Skip to content

Commit a925029

Browse files
drguthalsbruno-garciajas-kas
authored
January 6 Session Replay for Mobile GA (#12202)
* Update Android for SR4M GA * Update iOS for SR4M GA * Update SR4M GA for Flutter * Update SR4M GA for React Native * Update SR4M Banner * Update index.mdx * Update index.mdx * Apply suggestions from code review * Update docs/platforms/flutter/session-replay/index.mdx * add GA versions for 3 SDKs, and latest preview of flutter * android options * Apply suggestions from code review * rn min version * min rn version --------- Co-authored-by: Bruno Garcia <[email protected]> Co-authored-by: Jasmin <[email protected]>
1 parent c924f0d commit a925029

File tree

7 files changed

+28
-79
lines changed

7 files changed

+28
-79
lines changed

docs/platforms/android/session-replay/index.mdx

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,9 @@
22
title: Set Up Session Replay
33
sidebar_order: 5500
44
notSupported:
5-
description: "Learn how to enable the Beta of Mobile Session Replay in your app."
5+
description: "Learn how to enable Session Replay in your mobile app."
66
---
77

8-
<Note>
9-
10-
Mobile support for Session Replay is in beta until January 6th, 2025. Features available in beta are still work-in-progress and may have bugs. We recognize the irony.
11-
12-
All beta users will continue to receive 2 months free of Session Replay for Mobile once we transition to GA.
13-
14-
If you have any questions, feedback or would like to report a bug, please open a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml) with a link to a relevant replay in Sentry if possible.
15-
16-
</Note>
17-
188
[Session Replay](/product/explore/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a reproduction of what was happening in the user's device before, during, and after the issue. You can rewind and replay your application's state and see key user interactions, like taps, swipes, network requests, and console entries, in a single UI.
199

2010
By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. To learn more, see [product docs](/product/explore/session-replay/).
@@ -64,15 +54,14 @@ SentryAndroid.init(context) { options ->
6454
options.dsn = "___PUBLIC_DSN___"
6555
options.isDebug = true
6656

67-
// Currently under experimental options:
68-
options.experimental.sessionReplay.onErrorSampleRate = 1.0
69-
options.experimental.sessionReplay.sessionSampleRate = 1.0
57+
options.sessionReplay.onErrorSampleRate = 1.0
58+
options.sessionReplay.sessionSampleRate = 0.1
7059
}
7160
```
7261

7362
```XML {filename:AndroidManifest.xml}
7463
<meta-data android:name="io.sentry.session-replay.on-error-sample-rate" android:value="1.0" />
75-
<meta-data android:name="io.sentry.session-replay.session-sample-rate" android:value="1.0" />
64+
<meta-data android:name="io.sentry.session-replay.session-sample-rate" android:value="0.1" />
7665
```
7766

7867
## Verify
@@ -108,11 +97,8 @@ If you find that any other data isn't being masked with the default settings, pl
10897
To disable masking altogether (not to be used on applications with sensitive data):
10998

11099
```kotlin
111-
options.experimental.sessionReplay.maskAllText = false
112-
options.experimental.sessionReplay.maskAllImages = false
113-
// if you're on version < 7.15.0
114-
// options.experimental.sessionReplay.redactAllText = false
115-
// options.experimental.sessionReplay.redactAllImages = false
100+
options.sessionReplay.maskAllText = false
101+
options.sessionReplay.maskAllImages = false
116102
```
117103

118104
```XML {filename:AndroidManifest.xml}

docs/platforms/apple/guides/ios/session-replay/index.mdx

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,9 @@
22
title: Set Up Session Replay
33
sidebar_order: 5500
44
notSupported:
5-
description: "Learn how to enable the Beta of Mobile Session Replay in your app."
5+
description: "Learn how to enable Session Replay in your mobile app."
66
---
77

8-
<Note>
9-
10-
Mobile support for Session Replay is in beta until January 6th, 2025. Features available in beta are still work-in-progress and may have bugs. We recognize the irony.
11-
12-
All beta users will continue to receive 2 months free of Session Replay for Mobile once we transition to GA.
13-
14-
If you have any questions, feedback or would like to report a bug, please open a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml) with a link to a relevant replay in Sentry if possible.
15-
16-
</Note>
17-
188
[Session Replay](/product/explore/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a reproduction of what was happening in the user's device before, during, and after the issue. You can rewind and replay your application's state and see key user interactions, like taps, swipes, network requests, and console entries, in a single UI.
199

2010
By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. To learn more, see [product docs](/product/explore/session-replay/).
@@ -48,9 +38,8 @@ SentrySDK.start(configureOptions: { options in
4838
options.dsn = "___PUBLIC_DSN___"
4939
options.debug = true
5040

51-
// Currently under experimental options:
52-
options.experimental.sessionReplay.onErrorSampleRate = 1.0
53-
options.experimental.sessionReplay.sessionSampleRate = 1.0
41+
options.sessionReplay.onErrorSampleRate = 1.0
42+
options.sessionReplay.sessionSampleRate = 0.1
5443
})
5544
```
5645

@@ -88,8 +77,8 @@ If you encounter any data not being redacted with the default settings, please l
8877
To disable redaction altogether (not to be used on applications with sensitive data):
8978

9079
```swift
91-
options.experimental.sessionReplay.redactAllText = false
92-
options.experimental.sessionReplay.redactAllImages = false
80+
options.sessionReplay.redactAllText = false
81+
options.sessionReplay.redactAllImages = false
9382
```
9483

9584
## Error Linking

docs/platforms/flutter/session-replay/index.mdx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,12 @@
22
title: Set Up Session Replay
33
sidebar_order: 5500
44
notSupported:
5-
description: "Learn how to enable the Mobile Session Replay Beta in your app."
5+
description: "Learn how to enable Session Replay in your mobile app."
66
---
77

88
<Note>
99

10-
Flutter Session Replay is available on **iOS** and **Android**.
11-
12-
Mobile support for Session Replay is in beta until January 6th, 2025. Features available in beta are still work-in-progress and may have bugs. We recognize the irony.
13-
14-
All beta users will continue to receive 2 months free of Session Replay for Mobile once we transition to GA.
15-
16-
If you have any questions, feedback or would like to report a bug, please open a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml) with a link to a relevant replay in Sentry if possible.
10+
Flutter Session Replay is available on **iOS** and **Android**. This SDK support is still experimental as we iron out any bugs that are reported. If you encounter any issues please let us know via a GitHub ticket.
1711

1812
</Note>
1913

docs/platforms/react-native/session-replay/index.mdx

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,16 @@
22
title: Set Up Session Replay
33
sidebar_order: 5500
44
notSupported:
5-
description: "Learn how to enable the Beta of Mobile Session Replay in your app."
5+
description: "Learn how to enable Session Replay in your mobile app."
66
---
77

8-
<Note>
9-
10-
Mobile support for Session Replay is in beta until January 6th, 2025. Features available in beta are still work-in-progress and may have bugs. We recognize the irony.
11-
12-
All beta users will continue to receive 2 months free of Session Replay for Mobile once we transition to GA.
13-
14-
If you have any questions, feedback or would like to report a bug, please open a [GitHub issue](https://github.com/getsentry/sentry-java/issues/new?assignees=&labels=Platform%3A+Android%2CType%3A+Bug&projects=&template=bug_report_android.yml) with a link to a relevant replay in Sentry if possible.
15-
16-
</Note>
17-
188
[Session Replay](/product/explore/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a reproduction of what was happening in the user's device before, during, and after the issue. You can rewind and replay your application's state and see key user interactions, like taps, swipes, network requests, and console entries, in a single UI.
199

2010
By default, our Session Replay SDK masks all text content, images, and user input, giving you heightened confidence that no sensitive data will leave the device. To learn more, see [product docs](/product/explore/session-replay/).
2111

2212
## Pre-requisites
2313

24-
Make sure your Sentry React Native SDK version is at least 5.26.0.
14+
Make sure your Sentry React Native SDK version is at least 6.5.0.
2515

2616
## Install
2717

@@ -48,10 +38,8 @@ import * as Sentry from "@sentry/react-native";
4838

4939
Sentry.init({
5040
dsn: "___PUBLIC_DSN___",
51-
_experiments: {
52-
replaysSessionSampleRate: 1.0,
53-
replaysOnErrorSampleRate: 1.0,
54-
},
41+
replaysSessionSampleRate: 0.1,
42+
replaysOnErrorSampleRate: 1.0,
5543
integrations: [Sentry.mobileReplayIntegration()],
5644
});
5745
```

docs/product/explore/session-replay/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_order: 70
44
description: "Use Session Replay to get reproductions of user sessions to improve your app experience."
55
---
66

7-
Sentry has Session Replay for both Web and Mobile. But while Session Replay for Web has been available and stable, Mobile Replay is a recent addition and is currently in Beta.
7+
Sentry has Session Replay for both Web and Mobile. Both are generally available and stable.
88

99
Learn more here:
1010

docs/product/explore/session-replay/mobile/index.mdx

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
---
22
title: "Session Replay for Mobile"
33
sidebar_order: 20
4-
description: "Use Session Replay for mobile to get video-like reproductions of user sessions. You'll be able to repro issues faster and get a better understanding of user impact."
4+
description: "Use Session Replay for Mobile to get reproductions of user sessions. You'll be able to repro issues faster and get a better understanding of user impact."
55
---
66

7-
<Note>
8-
9-
Session Replay for mobile is currently in open beta for all plans except Enterprise. (If you’re on an Enterprise plan, please reach out to your Customer Success Manager for more information).
10-
11-
Beta features are still in progress and may have bugs. We recognize the irony. If you have any questions, feedback, or would like to report a bug, please open a GitHub issue with a link to a relevant replay ([Android](https://github.com/getsentry/sentry-java/issues/new/choose), [iOS](https://github.com/getsentry/sentry-cocoa/issues/new/choose), [React Native](https://github.com/getsentry/sentry-react-native/issues/new/choose) and [Flutter](https://github.com/getsentry/sentry-dart/issues/new/choose)).
12-
13-
</Note>
14-
157
Session Replay allows you to see reproductions of user sessions, which can help you understand what happened before, during, and after an error or performance issue occurred. As you play back each session, you'll be able to see every user interaction in relation to network requests, frontend and backend errors, backend spans, and more.
168

179
Replays help you see exactly how the user experience is impacted by errors. Because they're integrated with our Issues product, you'll be able to see session replays connected to error events on the [Issue Details](/product/issues/issue-details/) page in Sentry. To make sure backend errors are also included in the replay, see our [backend set up instructions](/product/explore/session-replay/getting-started/#replays-for-backend-errors).
@@ -20,7 +12,7 @@ Replays help you see exactly how the user experience is impacted by errors. Beca
2012

2113
## What is Session Replay?
2214

23-
Session Replay for mobile works by taking snapshots of the view hierarchy as well as a screenshot within the same frame, at the rate of one per second. These screenshots are then compressed into a video file representing a segment of the user’s session. All these small segments are then streamed into Sentry with additional trace identifiers, breadcrumbs, and other useful debugging information to compose the full user session.
15+
Session Replay for Mobile works by taking snapshots of the view hierarchy as well as a screenshot within the same frame, at the rate of one per second. These screenshots are then compressed into a video file representing a segment of the user’s session. All these small segments are then streamed into Sentry with additional trace identifiers, breadcrumbs, and other useful debugging information to compose the full user session.
2416

2517
The user session (replay) lasts until the user closes the app, the app crashes, the user puts the app in the background for over 30 seconds, or the session reaches 60 minutes in duration. The result is a video playback that can help you reproduce bugs in your mobile app, including hard-to-debug issues related to backend APIs and microservices.
2618

@@ -60,10 +52,10 @@ Session Replay for mobile is currently available for Android and iOS on both nat
6052

6153
We recommend updating to the latest version, but the minimum versions supported are:
6254

63-
- [iOS](/platforms/apple/guides/ios/session-replay/), [8.31.1](https://github.com/getsentry/sentry-cocoa/releases)
64-
- [Android](/platforms/android/session-replay/), [7.12.0](https://github.com/getsentry/sentry-java/releases)
65-
- [React Native](/platforms/react-native/session-replay/), [5.26.0](https://github.com/getsentry/sentry-react-native/releases)
66-
- [Flutter](/platforms/flutter/session-replay/), [8.9.0](https://github.com/getsentry/sentry-dart/releases)
55+
- [iOS](/platforms/apple/guides/ios/session-replay/), [8.43.0](https://github.com/getsentry/sentry-cocoa/releases)
56+
- [Android](/platforms/android/session-replay/), [7.20.0](https://github.com/getsentry/sentry-java/releases)
57+
- [React Native](/platforms/react-native/session-replay/), [6.5.0](https://github.com/getsentry/sentry-react-native/releases)
58+
- [Flutter](/platforms/flutter/session-replay/), [8.12.0](https://github.com/getsentry/sentry-dart/releases)
6759

6860
## Frequently Asked Questions
6961

@@ -82,12 +74,12 @@ If you experience any performance degradations after installing Session Replay,
8274

8375
**How much does it cost to use Session Replay for mobile?**
8476

85-
Session Replay for mobile is currently in open beta and can be used **free of charge**. At some point in the future, it will become a paid solution (similar to [Session Replay for web](https://sentry.io/pricing/)). The exact release date and pricing have yet to be determined.
77+
Session Replay for Mobile is currently available for all plans. Check out our [pricing page](https://sentry.io/pricing/) for details.
8678

8779
**Are unhandled exceptions (for example, crashes) available as part of Session Replay for mobile?**
8880

8981
Currently, only handled exceptions will include a replay. We’re actively working on covering replays for crashes and ANRs and plan to support them for mobile in the coming weeks. Please refer to the SDK release notes for updates.
9082

9183
**How does Session Replay for mobile work if my app is offline?**
9284

93-
Session Replay for mobile currently doesn’t work in offline mode. We plan on adding support for at least a few segments leading up to errors and crashes. Please subscribe to this [GitHub issue](https://github.com/getsentry/sentry/issues/68287) for updates.
85+
Session Replay for Mobile currently doesn’t work in offline mode. We plan on adding support for at least a few segments leading up to errors and crashes. Please subscribe to this [GitHub issue](https://github.com/getsentry/sentry/issues/68287) for updates.

src/components/banner/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ const BANNERS: BannerType[] = [
6767
'^/platforms/android/',
6868
'^/platforms/apple/guides/ios/',
6969
],
70-
text: 'Session Replay for Mobile beta ends January 6, 2025.',
70+
text: 'Session Replay is now generally available for mobile.',
7171
linkURL: 'https://docs.sentry.io/product/explore/session-replay/mobile/',
72-
linkText: 'Try beta for free now.',
72+
linkText: 'Get started today.',
7373
},
7474
];
7575

0 commit comments

Comments
 (0)