Skip to content

docs: Update replay docs for end of beta #7349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 7, 2023
Merged

docs: Update replay docs for end of beta #7349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a3f4f7
docs: Update replay docs for end of beta
mydea Mar 6, 2023
df55431
Apply suggestions from code review
mydea Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions packages/replay/MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,47 @@
# End of Replay Beta

Sentry Replay is now out of Beta. This means that the usual stability guarantees apply.

Because of experimentation and rapid iteration, during the Beta period some bugs and problems came up which have since been fixed/improved.
We **strongly** recommend anyone using Replay in a version before 7.39.0 to update to 7.39.0 or newer, in order to prevent running Replay with known problems that have since been fixed.

Below you can find a list of relevant replay issues that have been resolved until 7.39.0:

## New features / improvements

- Remove `autoplay` attribute from audio/video tags ([#59](https://github.com/getsentry/rrweb/pull/59))
- Exclude fetching scripts that use `<link rel="modulepreload">` ([#52](https://github.com/getsentry/rrweb/pull/52))
- With maskAllText, mask the attributes: placeholder, title, `aria-label`
- Lower the flush max delay from 15 seconds to 5 seconds (#6761)
- Stop recording when retry fails (#6765)
- Stop without retry when receiving bad API response (#6773)
- Send client_report when replay sending fails (#7093)
- Stop recording when hitting a rate limit (#7018)
- Allow Replay to be used in Electron renderers with nodeIntegration enabled (#6644)
- Do not renew session in error mode (#6948)
- Remove default sample rates for replay (#6878)
- Add `flush` method to integration (#6776)
- Improve compression worker & fallback behavior (#6988, #6936, #6827)
- Improve error handling (#7087, #7094, #7010, getsentry/rrweb#16, #6856)
- Add more default block filters (#7233)

## Fixes

- Fix masking inputs on change when `maskAllInputs:false` ([#61](https://github.com/getsentry/rrweb/pull/61))
- More robust `rootShadowHost` check ([#50](https://github.com/getsentry/rrweb/pull/50))
- Fix duplicated textarea value ([#62](https://github.com/getsentry/rrweb/pull/62))
- Handle removed attributes ([#65](https://github.com/getsentry/rrweb/pull/65))
- Change LCP calculation (#7187, #7225)
- Fix debounced flushes not respecting `maxWait` (#7207, #7208)
- Fix svgs not getting unblocked (#7132)
- Fix missing fetch/xhr requests (#7134)
- Fix feature detection of PerformanceObserver (#7029)
- Fix `checkoutEveryNms` (#6722)
- Fix incorrect uncompressed recording size due to encoding (#6740)
- Ensure dropping replays works (#6522)
- Envelope send should be awaited in try/catch (#6625)
- Improve handling of `maskAllText` selector (#6637)

# Upgrading Replay from 7.34.0 to 7.35.0 - #6645

This release will remove the ability to change the default rrweb recording options (outside of privacy options). The following are the new configuration values all replays will use:
Expand Down
6 changes: 2 additions & 4 deletions packages/replay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)
[![npm dt](https://img.shields.io/npm/dt/@sentry/replay.svg)](https://www.npmjs.com/package/@sentry/replay)

**Note: Session Replay is currently in beta.** Functionality may change outside of major version bumps - while we try our best to avoid any breaking changes, semver cannot be guaranteed before Replay is out of beta. You can find more information about upgrading in [MIGRATION.md](./MIGRATION.md).

## Pre-requisites

`@sentry/replay` requires Node 12+, and browsers newer than IE11.
Expand Down Expand Up @@ -112,11 +110,11 @@ The `replay.(min.)js` bundle will be removed in v8 of the JS SDKs.

```html
<script
src="https://browser.sentry-cdn.com/7.31.1/bundle.min.js"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😬 - how do we keep this up to date?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we don't 😬 maybe it's time to remove this from these docs and instead just link to docs? We can do this in a follow up.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me

src="https://browser.sentry-cdn.com/7.41.0/bundle.min.js"
crossorigin="anonymous"
></script>
<script
src="https://browser.sentry-cdn.com/7.31.1/replay.min.js"
src="https://browser.sentry-cdn.com/7.41.0/replay.min.js"
crossorigin="anonymous"
></script>
```
Expand Down