Skip to content

Commit 3979487

Browse files
authored
feat(replay): Remove advanced configuration (#6094)
Remove the advanced recording configuration options as we want greater control over how recording should be done. The SDK API will be changed at a later point so that these options will not be passed. Instead we will provide good defaults that shouldnt need to be configured.
1 parent 80c57ff commit 3979487

File tree

1 file changed

+0
-20
lines changed

1 file changed

+0
-20
lines changed

src/platforms/javascript/common/session-replay/configuration.mdx

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,6 @@ The following options can be configured as options to the integration, in `new R
2626
| ------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2727
| stickySession | boolean | `true` | Keep track of the user across page loads. Note, a single user using multiple tabs will result in multiple sessions. Closing a tab will result in the session being closed as well. |
2828

29-
## Optimization Configuration
30-
31-
The following options can be configured as options to the integration, in `new Replay({})`:
32-
33-
| Key | Type | Default | Description |
34-
| ---------------- | ------- | ------- | ----------------------------------------------- |
35-
| collectFonts | boolean | `false` | Should collect fonts used on the website |
36-
| inlineImages | boolean | `false` | Should inline `<image>` content |
37-
| inlineStylesheet | boolean | `true` | Should inline stylesheets used in the recording |
38-
3929
## Identifying Users
4030

4131
You can use the Sentry SDK to set the user of a session. To associate a user identity to a session replay, refer to the <PlatformLink to="/enriching-events/identify-user">Identifying User Docs</PlatformLink>.
@@ -44,16 +34,6 @@ You can use the Sentry SDK to set the user of a session. To associate a user ide
4434
Sentry.setUser({ email: "[email protected]" });
4535
```
4636

47-
## rrweb Configuration
48-
49-
In addition to the options described above, you can also directly pass configuration to [rrweb](https://github.com/rrweb-io/rrweb/blob/rrweb%401.1.3/guide.md), which is the underlying library used to make the recordings:
50-
51-
```javascript
52-
new Replay({
53-
// any further configuration here is passed directly to rrweb
54-
});
55-
```
56-
5737
## Start and Stop Recording
5838

5939
Replay recording only starts automatically when it's included in the integrations key when calling `Sentry.init`. Otherwise, you can initialize the plugin and manually call the `start()` method on the integration instance. To stop recording you can call the `stop()`:

0 commit comments

Comments
 (0)