docs

Author: vaind

packages/replay/metrics/README.md

@@ -2,6 +2,10 @@
 
 Evaluates Replay impact on website performance by running a web app in Chromium via Playwright and collecting various metrics.
 
+The general idea is to run a web app without Sentry Replay and then run the same app again with Replay included.
+For both scenarios, we collect some metrics (CPU, memory, vitals) and later compare them and post as a comment in a PR.
+Changes in the collected, compared to previous runs from the main branch, should be evaluated on case-by-case basis when preparing and reviewing the PR.
+
 ## Resources
 
 * https://github.com/addyosmani/puppeteer-webperf

packages/replay/metrics/configs/ci/collect.ts

@@ -21,8 +21,8 @@ function checkStdDev(stats: MetricsStats, name: string, provider: NumberProvider
 const collector = new MetricsCollector({ headless: true, cpuThrottling: 2 });
 const result = await collector.execute({
   name: 'jank',
-  a: new JankTestScenario(false),
-  b: new JankTestScenario(true),
+  a: new JankTestScenario(false), // No sentry
+  b: new JankTestScenario(true),  // Sentry + Replay
   runs: 10,
   tries: 10,
   async shouldAccept(results: Metrics[]): Promise<boolean> {