Skip to content

Commit

Permalink
Add Replay performance overhead numbers and messaging (#7451)
Browse files Browse the repository at this point in the history
Add a bit more details (and hard numbers) for performance overhead of Replay.


Closes #6297

---------

Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
  • Loading branch information
4 people authored Jul 21, 2023
1 parent 17565c8 commit 198ef82
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions src/docs/product/session-replay/performance-overhead.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,42 @@ Session Replay works by observing and recording changes to your web application'

**For most web applications, the performance overhead of our client SDK is imperceptible to end-users.**

Below, you can learn more about the individual measures we've taken to ensure smooth performance of our Session Replay SDK.
Performance overhead depends on the complexity of your application. Applications with a large DOM and numerous DOM node mutations will have a higher overhead than a more simpler and mostly static site. The only way to get accurate overhead metrics is to measure it yourself. We have written a blog post, [Measuring Session Replay Overhead](https://sentry.engineering/blog/measuring-session-replay-overhead), that outlines how you can get started measuring overhead of Replay on your applications without deploying to production. We measured the overhead of the Replay SDK on Sentry's web UI using the methodology from the blog. Here are the results (median values are shown):

## How is Session Replay optimized?
| Metric | Without Sentry | Sentry SDK only | Sentry + Replay SDK |
| -------------------------------- | -------------- | --------------- | ------------------- |
| Largest Contentful Paint (LCP)\* | 1336.05 ms | 1896.80 ms | 1643.00 ms |
| Cumulative Layout Shift (CLS) | 0.39 ms | 0.39 ms | 0.39 ms |
| First Input Delay (FID) | 1.30 ms | 1.30 ms | 1.60 ms |
| Total Blocking Time (TBT) | 2629.00 ms | 2742.00 ms | 3267.50 ms |
| Average Memory | 118.79 MB | 113.79 MB | 132.05 MB |
| Max Memory | 311.4 MB | 316.57 MB | 334.82 MB |
| Network Upload | 21 B | 3.79 KB | 392.98 KB |
| Network Download | 7.11 MB | 6.93 MB | 6.87 MB |

<p>
<sub>
* The standard deviation for LCP was 386, 511, and 354 ms, respectively.
This means that the LCP values are quite spread out and explains why the
Sentry standalone LCP value is higher than the Sentry with Replay value.
</sub>
</p>

The benchmarks were run on an Apple M1 MacBook Pro against a remote preview server and a remote API backend with 100 iterations. The scenario can be summarized as loading Sentry, navigating to Discover, adding 4 columns, waiting for results, adding another column, and finally waiting for results a second time.

The benchmark test was a strenuous recording scenario (the Discover data table is one of our most complex, in regards to DOM nodes and mutations). A simpler scenario consisting of navigation to four different "Settings" pages was also ran and produced an increase of ~100 ms of total JS blocking time.

<Note>
There is a known performance issue that happens when replays with many DOM
mutations are recorded. It generally occurs when rendering large data grids.
We're working on a fix, but in the meantime we recommend you{" "}
<Link to="https://docs.sentry.io/platforms/javascript/session-replay/privacy/#blocking">
use the blocking feature
</Link>
to avoid recording large mutations which can degrade performance for your customers.
</Note>

## How Is Session Replay Optimized?

Sentry's Session Replay SDK takes several measures to avoid negatively impacting the performance of the page on which it's running:

Expand Down

1 comment on commit 198ef82

@vercel
Copy link

@vercel vercel bot commented on 198ef82 Jul 21, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

sentry-docs – ./

docs.sentry.io
sentry-docs.sentry.dev
sentry-docs-git-master.sentry.dev

Please sign in to comment.