Skip to content

feat(browser): Send CLS as standalone span (experimental) #13056

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 13 commits into from
Aug 13, 2024
Merged

feat(browser): Send CLS as standalone span (experimental) #13056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5dd1f31
feat(browser): Send CLS as standalone span (experimental)
Lms24 Jul 25, 2024
4ff0ddf
cleanup
Lms24 Jul 25, 2024
5322816
use own perofrmance observer to decouple from replay
Lms24 Jul 26, 2024
53d8486
remove unused startStandaloneWebVitalSpan option
Lms24 Jul 26, 2024
97ff097
use `reportAllChanges: true` - compatible approach; extract to new file
Lms24 Jul 26, 2024
be31dc1
biome
Lms24 Jul 26, 2024
98ab3bc
remove unnecessary readme section
Lms24 Jul 26, 2024
7103fb2
add test for 0-CLS value
Lms24 Jul 26, 2024
b7eac3e
add new cls file, oops
Lms24 Jul 26, 2024
8494bc4
save a couple of bytes
Lms24 Jul 26, 2024
0d4ad0a
add pageload span id
Lms24 Aug 9, 2024
28a3028
remove todo
Lms24 Aug 9, 2024
585a7ac
adjust size-limit
Lms24 Aug 13, 2024
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
8 changes: 4 additions & 4 deletions .size-limit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration'),
gzip: true,
limit: '90 KB',
limit: '91 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
Expand Down Expand Up @@ -143,7 +143,7 @@ module.exports = [
name: 'CDN Bundle (incl. Tracing)',
path: createCDNPath('bundle.tracing.min.js'),
gzip: true,
limit: '37 KB',
limit: '38 KB',
},
{
name: 'CDN Bundle (incl. Tracing, Replay)',
Expand All @@ -170,7 +170,7 @@ module.exports = [
path: createCDNPath('bundle.tracing.min.js'),
gzip: false,
brotli: false,
limit: '110 KB',
limit: '111 KB',
},
{
name: 'CDN Bundle (incl. Tracing, Replay) - uncompressed',
Expand All @@ -193,7 +193,7 @@ module.exports = [
import: createImport('init'),
ignore: ['next/router', 'next/constants'],
gzip: true,
limit: '38.05 KB',
limit: '39 KB',
},
// SvelteKit SDK (ESM)
{
Expand Down
17 changes: 17 additions & 0 deletions .../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
integrations: [
Sentry.browserTracingIntegration({
idleTimeout: 9000,
_experiments: {
enableStandaloneClsSpans: true,
},
}),
],
tracesSampleRate: 1,
debug: true,
});
17 changes: 17 additions & 0 deletions ...owser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/subject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { simulateCLS } from '../../../../utils/web-vitals/cls.ts';

// Simulate Layout shift right at the beginning of the page load, depending on the URL hash
// don't run if expected CLS is NaN
const expectedCLS = Number(location.hash.slice(1));
if (expectedCLS && expectedCLS >= 0) {
simulateCLS(expectedCLS).then(() => window.dispatchEvent(new Event('cls-done')));
}

// Simulate layout shift whenever the trigger-cls event is dispatched
// Cannot trigger cia a button click because expected layout shift after
// an interaction doesn't contribute to CLS.
window.addEventListener('trigger-cls', () => {
simulateCLS(0.1).then(() => {
window.dispatchEvent(new Event('cls-done'));
});
});
12 changes: 12 additions & 0 deletions ...er-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
</head>
<body>
<div id="content"></div>
<p>
Some content
</p>
</body>
</html>
Loading