Skip to content

Commit 10b57ce

Browse files
More SR GA Updates (#1981)
1 parent 7285ca0 commit 10b57ce

File tree

3 files changed

+455
-164
lines changed

3 files changed

+455
-164
lines changed

pages/docs/session-replay/implement-session-replay/session-replay-ios.mdx

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ You can capture replay data using a sampling method (recommended), or customize
8787

8888
We recommend using our sampling functionality unless you need custom logic to decide when to record sessions.
8989

90-
To enable Session Replay and set your sampling rate, create a `MPSessionReplayConfig` object and set the `autoStartRecordingSessionsPercent` with a value between `0.0` and `100.0`. At `0.0` no sessions will be recorded, at `100.0` (default) all sessions will be recorded.
90+
To enable Session Replay and set your sampling rate, create a `MPSessionReplayConfig` object and set the `recordingSessionsPercent` with a value between `0.0` and `100.0`. At `0.0` no sessions will be recorded, at `100.0` (default) all sessions will be recorded.
9191

9292
Start with a low sampling rate, then adjust according to your specific analytics needs.
9393

@@ -97,7 +97,7 @@ Upon initialization, recording starts automatically if the sampling check passes
9797

9898
```swift Swift
9999
// records 1% of all sessions
100-
MPSessionReplayConfig(autoStartRecordingSessionsPercent: 1.0)
100+
MPSessionReplayConfig(recordingSessionsPercent: 1.0)
101101
```
102102

103103
### Manual Recording
@@ -106,7 +106,7 @@ To programatically start and stop replay capture, use the `.startRecording()` an
106106

107107
#### Start Recording Replay Data
108108

109-
Calling `.startRecording()` will force recording to begin regardless of the `autoStartRecordingSessionsPercent` sampling check.
109+
Calling `.startRecording()` will force recording to begin regardless of the `recordingSessionsPercent` sampling check.
110110

111111
Recording automatically stops when the app goes into the background. If `autoStartRecording` is `true` (default) recording automatically re-starts when the app comes back to the foreground.
112112

@@ -120,7 +120,7 @@ MPSessionReplay.getInstance()?.startRecording()
120120

121121
```swift Swift
122122
// manually force recording to begin with a 50% sampling rate
123-
MPSessionReplay.getInstance()?.startRecording(recordSessionsPercent: 50.0)
123+
MPSessionReplay.getInstance()?.startRecording(sessionsPercent: 50.0)
124124
```
125125

126126
#### Stop Recording Replay Data
@@ -169,7 +169,7 @@ Currently, there are six config options:
169169
| `wifiOnly` | When `true`, replay events will only be flushed to the server when the device has a WiFi connection. If there is no wifi, flushes are skipped and the events remain in the in-memory queue until wifi is restored (or until the queue reaches its limit and the oldest events are evicted to make room for newer events). <br/> When `false`, replay events will be flushed with any network connection, including cellular. | `true` |
170170
| `autoMaskedViews` | This is a `Set` of enum options for the types of views that should be masked by the SDK automatically. | `[.image, .text, .web, .map]` |
171171
| `autoStartRecording` | This is a boolean value that determines whether or not recording begins automatically upon initialization and when returning to the foreground. | `true` |
172-
| `autoStartRecordingSessionsPercent` | This is a value between `0.0` and `100.0` (default) that controls the sampling rate for automatically triggered session replays. <br/> At `0.0` no sessions will be recorded. At `100.0` all sessions will be recorded. | `100.0` |
172+
| `recordingSessionsPercent` | This is a value between `0.0` and `100.0` (default) that controls the sampling rate for automatically triggered session replays. <br/> At `0.0` no sessions will be recorded. At `100.0` all sessions will be recorded. | `100.0` |
173173
| `flushInterval` | Specifies the flush interval (in seconds) at which session replay events are sent to the Mixpanel server. | `10` |
174174
| `enableLogging` | This is a boolean value that determines whether or not debugging logs are printed to the console. | `false` |
175175

@@ -341,12 +341,6 @@ bgImage.mpReplaySensitive = false
341341

342342
By default, Mixpanel retains Session Replays for 30 days from the date the replay is ingested and becomes available for viewing within Mixpanel. Customers on our [Enterprise plan](https://mixpanel.com/pricing/) can customize this retention period between 7 days and 360 days. Once a replay is expired, there is no way to view that replay.
343343

344-
### Legal (Beta Terms)
345-
346-
Our Session Replay Beta Service Addendum can be found [here](https://mixpanel.com/legal/session-replay-beta-service-addendum/).
347-
348-
The alpha and beta of Mixpanel's mobile session replay SDK will track certain events and send them to Mixpanel so that Mixpanel can understand and improve the alpha and beta mobile session replay feature experience. These events include starting and stopping a session, adding and removing sensitive classes, adding sensitive views and adding safe views. Nothing about your application will be included in this tracking; only your usage of the Mixpanel Session Replay SDK.
349-
350344
## FAQ
351345

352346
#### How does Session Replay work in iOS?

0 commit comments

Comments
 (0)