Skip to content

feat(ember)!: Use function and ui.task span ops for route hooks and runloop #22669

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

Open
msonnb wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

feat(ember)!: Use function and ui.task span ops for route hooks and runloop #22669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
71a5e20
feat(ember)!: Use `function` span op for route hooks
msonnb Jul 27, 2026
019a544
test(e2e): Update ember route hook span assertions
msonnb Jul 27, 2026
9dcb64d
feat(ember)!: Use `ui.task` span op for runloop queues
msonnb Jul 27, 2026
8960d79
feat(ember)!: Use cross-framework span ops for component and init spans
msonnb Jul 27, 2026
d9b3e6c
use sentry.op
msonnb Jul 28, 2026
2ca3aa3
more sentry.op
msonnb Jul 28, 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
53 changes: 35 additions & 18 deletions dev-packages/e2e-tests/test-applications/ember-classic/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,14 @@ test('captures correct spans for navigation', async ({ page }) => {
});

const transitionSpans = spans.filter(span => span.op === 'ui.ember.transition');
const beforeModelSpans = spans.filter(span => span.op === 'ui.ember.route.before_model');
const modelSpans = spans.filter(span => span.op === 'ui.ember.route.model');
const afterModelSpans = spans.filter(span => span.op === 'ui.ember.route.after_model');
const renderSpans = spans.filter(span => span.op === 'ui.ember.runloop.render');
const beforeModelSpans = spans.filter(
span => span.op === 'function' && span.data?.['ember.route.hook'] === 'beforeModel',
);
const modelSpans = spans.filter(span => span.op === 'function' && span.data?.['ember.route.hook'] === 'model');
const afterModelSpans = spans.filter(
span => span.op === 'function' && span.data?.['ember.route.hook'] === 'afterModel',
);
const renderSpans = spans.filter(span => span.op === 'ui.task' && span.data?.['ember.runloop.queue'] === 'render');

expect(transitionSpans).toHaveLength(1);

Expand Down Expand Up @@ -202,12 +206,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(beforeModelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.before_model',
'code.function.name': 'beforeModel',
'ember.route.hook': 'beforeModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.before_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -218,12 +224,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.before_model',
'code.function.name': 'beforeModel',
'ember.route.hook': 'beforeModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.before_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -237,12 +245,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(modelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.model',
'code.function.name': 'model',
'ember.route.hook': 'model',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -253,12 +263,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.model',
'code.function.name': 'model',
'ember.route.hook': 'model',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -272,12 +284,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(afterModelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.after_model',
'code.function.name': 'afterModel',
'ember.route.hook': 'afterModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.after_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -288,12 +302,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.after_model',
'code.function.name': 'afterModel',
'ember.route.hook': 'afterModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.after_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -306,11 +322,12 @@ test('captures correct spans for navigation', async ({ page }) => {

expect(renderSpans).toContainEqual({
data: {
'sentry.op': 'ui.ember.runloop.render',
'ember.runloop.queue': 'render',
'sentry.op': 'ui.task',
'sentry.origin': 'auto.ui.ember',
},
description: 'runloop',
op: 'ui.ember.runloop.render',
op: 'ui.task',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand Down
53 changes: 35 additions & 18 deletions dev-packages/e2e-tests/test-applications/ember-embroider/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,14 @@ test('captures correct spans for navigation', async ({ page }) => {
});

const transitionSpans = spans.filter(span => span.op === 'ui.ember.transition');
const beforeModelSpans = spans.filter(span => span.op === 'ui.ember.route.before_model');
const modelSpans = spans.filter(span => span.op === 'ui.ember.route.model');
const afterModelSpans = spans.filter(span => span.op === 'ui.ember.route.after_model');
const renderSpans = spans.filter(span => span.op === 'ui.ember.runloop.render');
const beforeModelSpans = spans.filter(
span => span.op === 'function' && span.data?.['ember.route.hook'] === 'beforeModel',
);
const modelSpans = spans.filter(span => span.op === 'function' && span.data?.['ember.route.hook'] === 'model');
const afterModelSpans = spans.filter(
span => span.op === 'function' && span.data?.['ember.route.hook'] === 'afterModel',
);
const renderSpans = spans.filter(span => span.op === 'ui.task' && span.data?.['ember.runloop.queue'] === 'render');

expect(transitionSpans).toHaveLength(1);

Expand Down Expand Up @@ -202,12 +206,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(beforeModelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.before_model',
'code.function.name': 'beforeModel',
'ember.route.hook': 'beforeModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.before_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -218,12 +224,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.before_model',
'code.function.name': 'beforeModel',
'ember.route.hook': 'beforeModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.before_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -237,12 +245,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(modelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.model',
'code.function.name': 'model',
'ember.route.hook': 'model',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -253,12 +263,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.model',
'code.function.name': 'model',
'ember.route.hook': 'model',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -272,12 +284,14 @@ test('captures correct spans for navigation', async ({ page }) => {
expect(afterModelSpans).toEqual([
{
data: {
'sentry.op': 'ui.ember.route.after_model',
'code.function.name': 'afterModel',
'ember.route.hook': 'afterModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route',
op: 'ui.ember.route.after_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -288,12 +302,14 @@ test('captures correct spans for navigation', async ({ page }) => {
},
{
data: {
'sentry.op': 'ui.ember.route.after_model',
'code.function.name': 'afterModel',
'ember.route.hook': 'afterModel',
'sentry.op': 'function',
'sentry.origin': 'auto.ui.ember',
'sentry.source': 'custom',
},
description: 'slow-loading-route.index',
op: 'ui.ember.route.after_model',
op: 'function',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand All @@ -306,11 +322,12 @@ test('captures correct spans for navigation', async ({ page }) => {

expect(renderSpans).toContainEqual({
data: {
'sentry.op': 'ui.ember.runloop.render',
'ember.runloop.queue': 'render',
'sentry.op': 'ui.task',
'sentry.origin': 'auto.ui.ember',
},
description: 'runloop',
op: 'ui.ember.runloop.render',
op: 'ui.task',
origin: 'auto.ui.ember',
status: 'ok',
parent_span_id: spanId,
Expand Down
28 changes: 10 additions & 18 deletions packages/ember/addon/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
import { assert } from '@ember/debug';
import type Route from '@ember/routing/route';
import { getOwnConfig } from '@embroider/macros';
import { CODE_FUNCTION_NAME, SENTRY_OP } from '@sentry/conventions/attributes';
import { GENERAL_FUNCTION_SPAN_OP } from '@sentry/conventions/op';
import type { BrowserOptions } from '@sentry/browser';
import { startSpan } from '@sentry/browser';
import * as Sentry from '@sentry/browser';
Expand Down Expand Up @@ -54,7 +56,7 @@ type RouteConstructor = new (...args: ConstructorParameters<typeof Route>) => Ro
export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute: T): T => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const instrumentFunction = async <X extends (...args: unknown[]) => any>(
op: string,
hookName: string,
name: string,
fn: X,
args: Parameters<X>,
Expand All @@ -65,8 +67,10 @@ export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.ui.ember',
[SENTRY_OP]: GENERAL_FUNCTION_SPAN_OP,
[CODE_FUNCTION_NAME]: hookName,
'ember.route.hook': hookName,

@nicohrubec nicohrubec Jul 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: same for ember.route.hook

},
op,
name,
onlyIfParent: true,
},
Expand All @@ -82,32 +86,20 @@ export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute
// @ts-expect-error TS2545 We do not need to redefine a constructor here
[routeName]: class extends BaseRoute {
public beforeModel(...args: unknown[]): void | Promise<unknown> {
return instrumentFunction(
'ui.ember.route.before_model',
this.fullRouteName,
super.beforeModel.bind(this),
args,
'custom',
);
return instrumentFunction('beforeModel', this.fullRouteName, super.beforeModel.bind(this), args, 'custom');
}

public async model(...args: unknown[]): Promise<unknown> {
return instrumentFunction('ui.ember.route.model', this.fullRouteName, super.model.bind(this), args, 'custom');
return instrumentFunction('model', this.fullRouteName, super.model.bind(this), args, 'custom');
}

public afterModel(...args: unknown[]): void | Promise<unknown> {
return instrumentFunction(
'ui.ember.route.after_model',
this.fullRouteName,
super.afterModel.bind(this),
args,
'custom',
);
return instrumentFunction('afterModel', this.fullRouteName, super.afterModel.bind(this), args, 'custom');
}

public setupController(...args: unknown[]): void | Promise<unknown> {
return instrumentFunction(
'ui.ember.route.setup_controller',
'setupController',
this.fullRouteName,
super.setupController.bind(this),
args,
Expand Down
Loading
Loading