From f6e5f7c1874c90cc16c4d2598d6fc36a719ff918 Mon Sep 17 00:00:00 2001 From: Billy Vong Date: Tue, 17 Jan 2023 12:38:31 -0500 Subject: [PATCH] feat(replay): Remove advanced configuration 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. --- .../common/session-replay/configuration.mdx | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/src/platforms/javascript/common/session-replay/configuration.mdx b/src/platforms/javascript/common/session-replay/configuration.mdx index f8ae6fc208317e..ea9855a09ff31c 100644 --- a/src/platforms/javascript/common/session-replay/configuration.mdx +++ b/src/platforms/javascript/common/session-replay/configuration.mdx @@ -26,16 +26,6 @@ The following options can be configured as options to the integration, in `new R | ------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 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. | -## Optimization Configuration - -The following options can be configured as options to the integration, in `new Replay({})`: - -| Key | Type | Default | Description | -| ---------------- | ------- | ------- | ----------------------------------------------- | -| collectFonts | boolean | `false` | Should collect fonts used on the website | -| inlineImages | boolean | `false` | Should inline `` content | -| inlineStylesheet | boolean | `true` | Should inline stylesheets used in the recording | - ## Identifying Users 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 Identifying User Docs. @@ -44,16 +34,6 @@ You can use the Sentry SDK to set the user of a session. To associate a user ide Sentry.setUser({ email: "jane.doe@example.com" }); ``` -## rrweb Configuration - -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: - -```javascript -new Replay({ - // any further configuration here is passed directly to rrweb -}); -``` - ## Start and Stop Recording 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()`: