Skip to content

feat(vue): Set navigation.route.id from the route name #22372

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

Draft
msonnb wants to merge 1 commit into
base: develop
Choose a base branch
from
+16 −2
Draft

feat(vue): Set navigation.route.id from the route name #22372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/vue-3/tests/performance.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ test('sends a pageload transaction with a route name as transaction name if avai
'sentry.source': 'custom',
'sentry.origin': 'auto.pageload.vue',
'sentry.op': 'pageload',
'navigation.route.id': 'AboutView',
'url.path': '/about',
'url.full': expect.stringMatching(/^https?:\/\/localhost:\d+\/about$/),
},
Expand Down
11 changes: 10 additions & 1 deletion packages/vue/src/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { captureException, getAbsoluteUrl } from '@sentry/browser';
import { PARAMS_KEY_BASE, URL_PATH_PARAMETER_KEY_BASE, URL_TEMPLATE } from '@sentry/conventions/attributes';
import {
NAVIGATION_ROUTE_ID,
PARAMS_KEY_BASE,
URL_PATH_PARAMETER_KEY_BASE,
URL_TEMPLATE,
} from '@sentry/conventions/attributes';
import type { Span, SpanAttributes, StartSpanOptions, TransactionSource } from '@sentry/core';
import {
getActiveSpan,
Expand Down Expand Up @@ -101,6 +106,10 @@ export function instrumentVueRouter(
attributes[URL_TEMPLATE] = spanName;
}

if (to.name) {
attributes[NAVIGATION_ROUTE_ID] = to.name.toString();
}

getCurrentScope().setTransactionName(spanName);

// Update the existing page load span with parametrized route information
Expand Down
6 changes: 5 additions & 1 deletion packages/vue/test/router.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as SentryBrowser from '@sentry/browser';
import type { Span, SpanAttributes } from '@sentry/core';
import * as SentryCore from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import { URL_TEMPLATE } from '@sentry/conventions/attributes';
import { NAVIGATION_ROUTE_ID, URL_TEMPLATE } from '@sentry/conventions/attributes';
import { afterEach, describe, expect, it, vi } from 'vitest';
import type { Route } from '../src/router';
import { instrumentVueRouter } from '../src/router';
Expand Down Expand Up @@ -465,5 +465,9 @@ function getAttributesForRoute(route: Route, urlTemplate?: string): SpanAttribut
attributes[URL_TEMPLATE] = urlTemplate;
}

if (route.name) {
attributes[NAVIGATION_ROUTE_ID] = route.name.toString();
}

return attributes;
}
Loading