Skip to content

feat(browser): Emit low-cardinality ui span names #24578

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
Lms24 merged 8 commits into from
Sep 23, 2026
Merged

feat(browser): Emit low-cardinality ui span names #24578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
25930c7
feat: Port UI span names to low-cardinality conventions
Lms24 Sep 22, 2026
5c71041
update
Lms24 Sep 22, 2026
3631c99
test(e2e): Adjust UI span expectations to the low-cardinality names
Lms24 Sep 22, 2026
20c0f75
adjust angular
Lms24 Sep 22, 2026
d26d47a
test(e2e): Assert the UI attributes next to the renamed spans
Lms24 Sep 22, 2026
9842b99
update after conventions pr update
Lms24 Sep 22, 2026
c1a59f1
fix(browser-utils): Deduplicate the INP attributes after the #24573 r…
Lms24 Sep 22, 2026
0d1a3f7
fix(browser-utils): Omit the INP target attribute for unknown elements
Lms24 Sep 22, 2026
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
76 changes: 45 additions & 31 deletions MIGRATION.md
View file
Open in desktop

Large diffs are not rendered by default.

17 changes: 12 additions & 5 deletions ...ts/suites/tracing/browserTracingIntegration/spotlight-interaction-filter-streamed/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import { sentryTest } from '../../../../utils/fixtures';
import { shouldSkipCdnBundleTest, shouldSkipTracingTest } from '../../../../utils/helpers';
import { getSpanOp, observeStreamedSpan, waitForStreamedSpan, waitForStreamedSpans } from '../../../../utils/spanUtils';

// Interaction spans are named after the component, so the element is on `browser.web_vital.inp.target`.
// The click handler adds the `clicked` class before the event timing entry is recorded.
const SPOTLIGHT_BUTTON = 'body > div#sentry-spotlight > button.clicked';
const REGULAR_BUTTON = 'body > button.clicked';

sentryTest(
'filters ui.interaction.click spans for spotlight elements via ignoreSpans in streaming mode',
async ({ getLocalTestUrl, page }) => {
Expand All @@ -16,7 +21,10 @@ sentryTest(
// Set up an observer that fails if a spotlight interaction span is ever sent
let sawSpotlightInteractionSpan = false;
await observeStreamedSpan(page, span => {
if (getSpanOp(span) === 'ui.interaction.click' && span.name?.includes('#sentry-spotlight')) {
if (
getSpanOp(span) === 'ui.interaction.click' &&
span.attributes['browser.web_vital.inp.target']?.value === SPOTLIGHT_BUTTON
) {
sawSpotlightInteractionSpan = true;
return true;
}
Expand All @@ -39,18 +47,17 @@ sentryTest(

// Click on the regular button — its ui.interaction.click child should be kept
const regularInteractionSpansPromise = waitForStreamedSpans(page, spans =>
spans.some(span => getSpanOp(span) === 'ui.interaction.click' && !span.name?.includes('#sentry-spotlight')),
spans.some(span => span.attributes['browser.web_vital.inp.target']?.value === REGULAR_BUTTON),
);

await page.locator('[data-test-id=regular-button]').click();
await page.locator('.clicked[data-test-id=regular-button]').isVisible();

const regularSpans = await regularInteractionSpansPromise;
const regularInteractionSpan = regularSpans.find(
span => getSpanOp(span) === 'ui.interaction.click' && !span.name?.includes('#sentry-spotlight'),
span => span.attributes['browser.web_vital.inp.target']?.value === REGULAR_BUTTON,
);
expect(regularInteractionSpan).toBeDefined();
expect(regularInteractionSpan!.name).toContain('button');
expect(getSpanOp(regularInteractionSpan!)).toBe('ui.interaction.click');

// Verify no spotlight interaction span was ever sent
expect(sawSpotlightInteractionSpan).toBe(false);
Expand Down
20 changes: 14 additions & 6 deletions dev-packages/browser-integration-tests/suites/tracing/interactions/spans/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
SENTRY_SDK_VERSION,
SENTRY_TRACE_LIFECYCLE,
USER_AGENT_ORIGINAL,
URL_PATH,
} from '@sentry/conventions/attributes';
import { sentryTest } from '../../../../utils/fixtures';
import { shouldSkipTracingTest } from '../../../../utils/helpers';
Expand Down Expand Up @@ -70,6 +71,10 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
type: 'string',
value: expect.any(String),
},
[URL_PATH]: {
type: 'string',
value: '/index.html',
},
[SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: {
type: 'string',
value: 'idleTimeout',
Expand Down Expand Up @@ -100,11 +105,11 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
},
[SENTRY_SEGMENT_NAME]: {
type: 'string',
value: 'Pageload',
value: 'Click',

@Lms24 Lms24 Sep 22, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

this fixes a bug previously, since we took the "Pageload" low card. name from the active pageload span previously. "Click" is better than that IMHO

},
[SENTRY_SEGMENT_NAME_SOURCE]: {
type: 'string',
value: 'url',
value: 'custom',
},
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: {
type: 'string',
Expand All @@ -113,8 +118,7 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
},
end_timestamp: expect.any(Number),
is_segment: true,
// Interaction spans are named after the current route, which is the pageload span's name.
name: 'Pageload',
name: 'Click',
span_id: interactionSegmentSpan!.span_id,
start_timestamp: expect.any(Number),
status: 'ok',
Expand Down Expand Up @@ -157,16 +161,20 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
},
[SENTRY_SEGMENT_NAME]: {
type: 'string',
value: 'Pageload',
value: 'Click',
},
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: {
type: 'string',
value: 'production',
},
'browser.web_vital.inp.target': {
type: 'string',
value: 'body > button.clicked',
},
},
end_timestamp: expect.any(Number),
is_segment: false,
name: 'body > button.clicked',
name: 'Click',
parent_span_id: interactionSegmentSpan!.span_id,
span_id: expect.stringMatching(/^[\da-f]{16}$/),
start_timestamp: expect.any(Number),
Expand Down
3 changes: 2 additions & 1 deletion dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'NormalButton', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
'sentry.transaction': { value: 'test-url', type: 'string' },
Expand Down
5 changes: 3 additions & 2 deletions ...packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-navigate/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'NavigationLink', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > nav#navigation > NavigationLink', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > nav#navigation > NavigationLink', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
'sentry.transaction': { value: 'test-url', type: 'string' },
Expand Down Expand Up @@ -163,9 +164,9 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > nav#navigation > NavigationLink', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > nav#navigation > NavigationLink', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
'sentry.transaction': { value: 'test-url', type: 'string' },
Expand Down
3 changes: 2 additions & 1 deletion ...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'NormalButton', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
// the parametrized route name flows onto the INP span
Expand Down
3 changes: 2 additions & 1 deletion ...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'NormalButton', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
// the parametrized route name flows onto the INP span
Expand Down
8 changes: 6 additions & 2 deletions ...es/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-streamed-spans/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ sentryTest('captures INP click as a streamed span', async ({ getLocalTestUrl, pa

expect(inpSpan.attributes['sentry.exclusive_time']?.value).toBeGreaterThan(0);

expect(inpSpan.name).toBe('body > NormalButton');
expect(inpSpan.name).toBe('NormalButton');
expect(inpSpan.attributes['ui.component_name']).toEqual({ type: 'string', value: 'NormalButton' });
expect(inpSpan.attributes['browser.web_vital.inp.target']).toEqual({ type: 'string', value: 'body > NormalButton' });

expect(inpSpan.end_timestamp).toBeGreaterThan(inpSpan.start_timestamp);

Expand Down Expand Up @@ -75,7 +77,9 @@ sentryTest('captures the slowest interaction as streamed INP span', async ({ get

const inpSpan = await inpSpanPromise;

expect(inpSpan.name).toBe('body > SlowButton');
expect(inpSpan.name).toBe('SlowButton');
expect(inpSpan.attributes['ui.component_name']).toEqual({ type: 'string', value: 'SlowButton' });
expect(inpSpan.attributes['browser.web_vital.inp.target']).toEqual({ type: 'string', value: 'body > SlowButton' });
expect(inpSpan.attributes['sentry.exclusive_time']?.value).toBeGreaterThan(400);

const inpValue = inpSpan.attributes['browser.web_vital.inp.value']?.value as number;
Expand Down
6 changes: 4 additions & 2 deletions dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'NormalButton', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > NormalButton', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
'sentry.transaction': { value: 'test-url', type: 'string' },
Expand Down Expand Up @@ -148,9 +149,10 @@ sentryTest(
attributes: {
'sentry.origin': { value: 'auto.http.browser.inp', type: 'string' },
'sentry.op': { value: 'ui.interaction.click', type: 'string' },
'ui.component_name': { value: 'SlowButton', type: 'string' },
'browser.web_vital.inp.target': { value: 'body > SlowButton', type: 'string' },
'sentry.exclusive_time': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.value': { value: inpValue, type: expect.stringMatching(/^(integer)|(double)$/) },
'browser.web_vital.inp.target': { value: 'body > SlowButton', type: 'string' },
'browser.web_vital.inp.interaction_type': { value: 'click', type: 'string' },
'browser.navigation.type': { value: 'navigate', type: 'string' },
'sentry.transaction': { value: 'test-url', type: 'string' },
Expand Down
12 changes: 9 additions & 3 deletions dev-packages/e2e-tests/test-applications/angular-17/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,17 +275,21 @@ test.describe('TraceDirective', () => {
expect(traceDirectiveSpans).toEqual(
expect.arrayContaining([
expect.objectContaining({
name: '<sample-component>', // custom component name passed to trace directive
name: 'sample-component', // custom component name passed to trace directive
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_directive' },
'ui.component_name': { type: 'string', value: 'sample-component' },
'sentry.description': { type: 'string', value: '<sample-component>' },
}),
}),
expect.objectContaining({
name: '<app-sample-component>', // fallback selector name
name: 'app-sample-component', // fallback element tag name
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_directive' },
'ui.component_name': { type: 'string', value: 'app-sample-component' },
'sentry.description': { type: 'string', value: '<app-sample-component>' },
}),
}),
]),
Expand Down Expand Up @@ -318,10 +322,12 @@ test.describe('TraceClass Decorator', () => {
expect(classDecoratorSpan).toBeDefined();
expect(classDecoratorSpan).toEqual(
expect.objectContaining({
name: '<ComponentTrackingComponent>',
name: 'ComponentTrackingComponent',
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_class_decorator' },
'ui.component_name': { type: 'string', value: 'ComponentTrackingComponent' },
'sentry.description': { type: 'string', value: '<ComponentTrackingComponent>' },
}),
}),
);
Expand Down
8 changes: 6 additions & 2 deletions dev-packages/e2e-tests/test-applications/angular-18/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,12 @@ test.describe('TraceDirective', () => {
expect(traceDirectiveSpan).toBeDefined();
expect(traceDirectiveSpan).toEqual(
expect.objectContaining({
name: '<sample-component>',
name: 'sample-component',
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_directive' },
'ui.component_name': { type: 'string', value: 'sample-component' },
'sentry.description': { type: 'string', value: '<sample-component>' },
}),
}),
);
Expand Down Expand Up @@ -308,10 +310,12 @@ test.describe('TraceClass Decorator', () => {
expect(classDecoratorSpan).toBeDefined();
expect(classDecoratorSpan).toEqual(
expect.objectContaining({
name: '<ComponentTrackingComponent>',
name: 'ComponentTrackingComponent',
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_class_decorator' },
'ui.component_name': { type: 'string', value: 'ComponentTrackingComponent' },
'sentry.description': { type: 'string', value: '<ComponentTrackingComponent>' },
}),
}),
);
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/angular-19/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@ test.describe('TraceDirective', () => {
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.mount',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
'ui.component_name': 'sample-component',
},
description: '<sample-component>', // custom component name passed to trace directive
op: 'ui.mount',
Expand All @@ -278,6 +279,7 @@ test.describe('TraceDirective', () => {
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.mount',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_directive',
'ui.component_name': 'app-sample-component',
},
description: '<app-sample-component>', // fallback selector name
op: 'ui.mount',
Expand Down Expand Up @@ -311,6 +313,7 @@ test.describe('TraceClass Decorator', () => {
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.mount',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.angular.trace_class_decorator',
'ui.component_name': 'ComponentTrackingComponent',
},
description: '<ComponentTrackingComponent>',
op: 'ui.mount',
Expand Down
12 changes: 9 additions & 3 deletions dev-packages/e2e-tests/test-applications/angular-20/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,17 +275,21 @@ test.describe('TraceDirective', () => {
expect(traceDirectiveSpans).toEqual(
expect.arrayContaining([
expect.objectContaining({
name: '<sample-component>', // custom component name passed to trace directive
name: 'sample-component', // custom component name passed to trace directive
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_directive' },
'ui.component_name': { type: 'string', value: 'sample-component' },
'sentry.description': { type: 'string', value: '<sample-component>' },
}),
}),
expect.objectContaining({
name: '<app-sample-component>', // fallback selector name
name: 'app-sample-component', // fallback element tag name
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_directive' },
'ui.component_name': { type: 'string', value: 'app-sample-component' },
'sentry.description': { type: 'string', value: '<app-sample-component>' },
}),
}),
]),
Expand Down Expand Up @@ -318,10 +322,12 @@ test.describe('TraceClass Decorator', () => {
expect(classDecoratorSpan).toBeDefined();
expect(classDecoratorSpan).toEqual(
expect.objectContaining({
name: '<ComponentTrackingComponent>',
name: 'ComponentTrackingComponent',
attributes: expect.objectContaining({
'sentry.op': { type: 'string', value: 'ui.mount' },
'sentry.origin': { type: 'string', value: 'auto.ui.angular.trace_class_decorator' },
'ui.component_name': { type: 'string', value: 'ComponentTrackingComponent' },
'sentry.description': { type: 'string', value: '<ComponentTrackingComponent>' },
}),
}),
);
Expand Down
Loading
Loading