Skip to content

Commit ea61856

Browse files
authored
doc(replay): Remove advanced configuration (#6830)
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 shouldn't need to be configured.
1 parent 98038da commit ea61856

File tree

1 file changed

+0
-22
lines changed

1 file changed

+0
-22
lines changed

packages/replay/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -199,28 +199,6 @@ The following options can be configured as options to the integration, in `new R
199199
| maskTextClass | string \| RegExp | `'sentry-mask'` | Mask all elements that match the class name. See [privacy](#masking) section for an example. |
200200
| maskTextSelector | string | `undefined` | Mask all elements that match the given DOM selector. See [privacy](#masking) section for an example. |
201201

202-
### Optimization Configuration
203-
204-
The following options can be configured as options to the integration, in `new Replay({})`:
205-
206-
| key | type | default | description |
207-
| ---------------- | ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
208-
| collectFonts | boolean | `false` | Should collect fonts used on the website |
209-
| inlineImages | boolean | `false` | Should inline `<image>` content |
210-
| inlineStylesheet | boolean | `true` | Should inline stylesheets used in the recording |
211-
212-
213-
### rrweb Configuration
214-
215-
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:
216-
217-
```js
218-
new Replay({
219-
// any further configuration here is passed directly to rrweb
220-
});
221-
```
222-
223-
224202
## Privacy
225203
There are several ways to deal with PII. By default, the integration will mask all text content with `*` and block all media elements (`img, svg, video, object, picture, embed, map, audio`). This can be disabled by setting `maskAllText` to `false`. It is also possible to add the following CSS classes to specific DOM elements to prevent recording its contents: `sentry-block`, `sentry-ignore`, and `sentry-mask`. The following sections will show examples of how content is handled by the differing methods.
226204

0 commit comments

Comments
 (0)