Skip to content

feat(ember): Set url.template, url.path and url.full on router spans #22095

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 4 commits into from
Jul 9, 2026
Merged

feat(ember): Set url.template, url.path and url.full on router spans #22095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7efb50
feat(ember): Set url.template, url.path and url.full on router spans
Lms24 Jul 8, 2026
8c71aa7
fix(ember): Avoid stale url attributes on navigation spans
Lms24 Jul 9, 2026
54d077c
format
Lms24 Jul 9, 2026
220eed0
fix(ember): Preserve hash fragment in url.full on router spans
Lms24 Jul 9, 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
35 changes: 35 additions & 0 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 @@ -15,6 +15,13 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
trace: {
op: 'pageload',
origin: 'auto.pageload.ember',
data: {
'sentry.origin': 'auto.pageload.ember',
'sentry.source': 'route',
'url.template': '/',
'url.path': '/',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/$/),
},
},
},
transaction: 'route:index',
Expand Down Expand Up @@ -43,6 +50,13 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/tracing',
'url.path': '/tracing',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/tracing$/),
},
},
},
transaction: 'route:tracing',
Expand Down Expand Up @@ -75,6 +89,13 @@ test('sends a navigation transaction even if the pageload span is still active',
trace: {
op: 'pageload',
origin: 'auto.pageload.ember',
data: {
'sentry.origin': 'auto.pageload.ember',
'sentry.source': 'route',
'url.template': '/',
'url.path': '/',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/$/),
},
},
},
transaction: 'route:index',
Expand All @@ -88,6 +109,13 @@ test('sends a navigation transaction even if the pageload span is still active',
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/tracing',
'url.path': '/tracing',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/tracing$/),
},
},
},
transaction: 'route:tracing',
Expand Down Expand Up @@ -124,6 +152,13 @@ test('captures correct spans for navigation', async ({ page }) => {
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/slow-loading-route',
'url.path': '/slow-loading-route',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/slow-loading-route$/),
},
},
},
transaction: 'route:slow-loading-route.index',
Expand Down
35 changes: 35 additions & 0 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 @@ -15,6 +15,13 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
trace: {
op: 'pageload',
origin: 'auto.pageload.ember',
data: {
'sentry.origin': 'auto.pageload.ember',
'sentry.source': 'route',
'url.template': '/',
'url.path': '/',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/$/),
},
},
},
transaction: 'route:index',
Expand Down Expand Up @@ -43,6 +50,13 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/tracing',
'url.path': '/tracing',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/tracing$/),
},
},
},
transaction: 'route:tracing',
Expand Down Expand Up @@ -75,6 +89,13 @@ test('sends a navigation transaction even if the pageload span is still active',
trace: {
op: 'pageload',
origin: 'auto.pageload.ember',
data: {
'sentry.origin': 'auto.pageload.ember',
'sentry.source': 'route',
'url.template': '/',
'url.path': '/',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/$/),
},
},
},
transaction: 'route:index',
Expand All @@ -88,6 +109,13 @@ test('sends a navigation transaction even if the pageload span is still active',
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/tracing',
'url.path': '/tracing',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/tracing$/),
},
},
},
transaction: 'route:tracing',
Expand Down Expand Up @@ -124,6 +152,13 @@ test('captures correct spans for navigation', async ({ page }) => {
trace: {
op: 'navigation',
origin: 'auto.navigation.ember',
data: {
'sentry.origin': 'auto.navigation.ember',
'sentry.source': 'route',
'url.template': '/slow-loading-route',
'url.path': '/slow-loading-route',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/slow-loading-route$/),
},
},
},
transaction: 'route:slow-loading-route.index',
Expand Down
80 changes: 78 additions & 2 deletions packages/ember/addon/utils/instrumentEmberAppInstanceForPerformance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,22 @@ import type {
startBrowserTracingNavigationSpan as startBrowserTracingNavigationSpanType,
startBrowserTracingPageLoadSpan as startBrowserTracingPageLoadSpanType,
} from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, startInactiveSpan } from '@sentry/browser';
import {
getAbsoluteUrl,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
startInactiveSpan,
} from '@sentry/browser';
import type { Client, Span } from '@sentry/core';
import type { EmberRouterMain } from '../types';
import { getBackburner } from './performance';

const URL_FULL = 'url.full';
const URL_PATH = 'url.path';
const URL_TEMPLATE = 'url.template';

type TransitionWithIntent = Transition & { intent?: { url?: string } };

export function instrumentEmberAppInstanceForPerformance(
client: Client,
appInstance: ApplicationInstance,
Expand All @@ -22,6 +33,7 @@ export function instrumentEmberAppInstanceForPerformance(
let routerService = appInstance.lookup('service:router') as RouterService & {
externalRouter?: RouterService;
_hasMountedSentryPerformanceRouting?: boolean;
currentURL?: string;
};

if (routerService.externalRouter) {
Expand Down Expand Up @@ -60,6 +72,52 @@ function getTransitionInformation(
};
}

function getUrlPathFromEmberLocation(url: string): string {
if (!url) {
return '/';
}

const withoutQuery = url.split('?')[0] ?? url;

if (withoutQuery.includes('#')) {
const hashPart = withoutQuery.substring(withoutQuery.indexOf('#') + 1);
return hashPart.startsWith('/') ? hashPart : `/${hashPart}`;
}
Comment thread
cursor[bot] marked this conversation as resolved.

return withoutQuery.startsWith('/') ? withoutQuery : `/${withoutQuery}`;
}

function buildUrlTemplate(path: string, params: Record<string, unknown> = {}): string {
let template = path;

const paramEntries = Object.entries(params)
.filter((entry): entry is [string, string] => typeof entry[1] === 'string' && entry[1].length > 0)
.sort(([, a], [, b]) => b.length - a.length);

for (const [key, value] of paramEntries) {
template = template.replace(`/${value}`, `/:${key}`);
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
sentry[bot] marked this conversation as resolved.
}

return template;
}

// Only exported for testing
export function _getRouteUrlAttributes(
url: string,
params: Record<string, unknown> = {},
fullUrl: string = url,
): Record<string, string> {
const path = getUrlPathFromEmberLocation(url);

// `url.full` is derived from the unstripped URL so that hash-location apps keep their `#/...`
// fragment (e.g. `https://host/#/tracing`), which would otherwise be lost by `getUrlPathFromEmberLocation`.
return {
[URL_PATH]: path,
[URL_FULL]: getAbsoluteUrl(fullUrl),
[URL_TEMPLATE]: buildUrlTemplate(path, params),
Comment thread
cursor[bot] marked this conversation as resolved.
};
}

// Only exported for testing
export function _getLocationURL(location: EmberRouterMain['location']): string {
if (!location?.getURL || !location?.formatURL) {
Expand All @@ -76,7 +134,7 @@ export function _getLocationURL(location: EmberRouterMain['location']): string {

function _instrumentEmberRouter(
client: Client,
routerService: RouterService,
routerService: RouterService & { currentURL?: string },
routerMain: EmberRouterMain,
config: { disableRunloopPerformance?: boolean; instrumentPageLoad?: boolean; instrumentNavigation?: boolean },
startBrowserTracingPageLoadSpan: typeof startBrowserTracingPageLoadSpanType,
Expand All @@ -96,6 +154,7 @@ function _instrumentEmberRouter(
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.ember',
..._getRouteUrlAttributes(url, routeInfo.params),
Comment thread
sentry[bot] marked this conversation as resolved.
url,
toRoute: routeInfo.name,
},
Expand Down Expand Up @@ -124,11 +183,19 @@ function _instrumentEmberRouter(

activeRootSpan?.end();

// Only `intent.url` reliably reflects the *destination* URL at `routeWillChange` time. The
// router's location still points at the current (pre-transition) route here, so falling back to
// it would tag the navigation span with the previous route's `url.*` attributes. When we don't
// have a trustworthy target URL, we omit them and let `routeDidChange` set them from `currentURL`.
const targetUrl = (transition as TransitionWithIntent).intent?.url;
const urlAttributes = targetUrl ? _getRouteUrlAttributes(targetUrl, transition.to?.params) : {};

activeRootSpan = startBrowserTracingNavigationSpan(client, {
name: `route:${toRoute}`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.ember',
...urlAttributes,
Comment thread
cursor[bot] marked this conversation as resolved.
fromRoute,
toRoute,
},
Expand All @@ -150,6 +217,15 @@ function _instrumentEmberRouter(
}
transitionSpan.end();

const url = routerService.currentURL ?? _getLocationURL(location);
if (url) {
const routeInfo = routerService.recognize(url);
// `currentURL` is the normalized route path and never includes the hash fragment, so we source
// `url.full` from the location URL (which preserves `#/...` for hash-location apps) when available.
const fullUrl = _getLocationURL(location) || url;
activeRootSpan.setAttributes(_getRouteUrlAttributes(url, routeInfo.params ?? transition.to?.params, fullUrl));
}

if (disableRunloopPerformance) {
activeRootSpan.end();
return;
Expand Down
35 changes: 34 additions & 1 deletion packages/ember/tests/unit/instrument-router-location-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { EmberRouterMain } from '@sentry/ember/addon/types';
import { _getLocationURL } from '@sentry/ember/utils/instrumentEmberAppInstanceForPerformance';
import { _getLocationURL, _getRouteUrlAttributes } from '@sentry/ember/utils/instrumentEmberAppInstanceForPerformance';
import { setupTest } from 'ember-qunit';
import { module, test } from 'qunit';
import type { SentryTestContext } from '../helpers/setup-sentry';
Expand Down Expand Up @@ -97,4 +97,37 @@ module('Unit | Utility | instrument-router-location', function (hooks) {
const result = _getLocationURL(mockLocation);
assert.strictEqual(result, '', 'Should return empty string when formatURL is not available');
});

test('_getRouteUrlAttributes handles history location paths', function (this: SentryTestContext, assert) {
const result = _getRouteUrlAttributes('/tracing');

assert.strictEqual(result['url.path'], '/tracing');
assert.strictEqual(result['url.template'], '/tracing');
assert.ok(result['url.full']?.includes('/tracing'), 'url.full includes the path');
});

test('_getRouteUrlAttributes parameterizes dynamic segments', function (this: SentryTestContext, assert) {
const result = _getRouteUrlAttributes('/users/123', { user_id: '123' });

assert.strictEqual(result['url.path'], '/users/123');
assert.strictEqual(result['url.template'], '/users/:user_id');
assert.ok(result['url.full']?.includes('/users/123'), 'url.full includes the path');
});

test('_getRouteUrlAttributes handles hash location paths', function (this: SentryTestContext, assert) {
const result = _getRouteUrlAttributes('/#/tracing');

assert.strictEqual(result['url.path'], '/tracing');
assert.strictEqual(result['url.template'], '/tracing');
assert.ok(result['url.full']?.includes('/#/tracing'), 'url.full preserves the hash fragment');
});

test('_getRouteUrlAttributes sources url.full from an explicit fullUrl', function (this: SentryTestContext, assert) {
// Mirrors `routeDidChange`, where the route path (`currentURL`) has no hash but the location URL does.
const result = _getRouteUrlAttributes('/tracing', {}, '/#/tracing');

assert.strictEqual(result['url.path'], '/tracing');
assert.strictEqual(result['url.template'], '/tracing');
assert.ok(result['url.full']?.includes('/#/tracing'), 'url.full preserves the hash fragment from fullUrl');
});
});
Loading