feat(vue): Allow to set routeLabel: 'path' to opt-out of using name
#7326
Conversation
packages/vue/src/types.ts
Outdated
|
|
||
| /** | ||
| * What to use for route labels. | ||
| * By default, we use route.name (if set) and else the path. | ||
| * | ||
| * Default: 'name' | ||
| */ | ||
| routeLabel: 'name' | 'path'; |
There was a problem hiding this comment.
h: Instead of making this a top level option, wdyt about adding this as an option to the routing instrumentation?
packages/vue/src/router.ts
Outdated
| @@ -38,6 +39,9 @@ interface VueRouter { | |||
| * @param router The Vue Router instance that is used | |||
| */ | |||
| export function vueRouterInstrumentation(router: VueRouter): VueRouterInstrumentation { | |||
There was a problem hiding this comment.
RE other comment:
I'd add a second optional parameter with a VueRouterInstrumentationOptions object here, in which routeLabel would live
There was a problem hiding this comment.
This is actually a much better idea 👍
|
Updated it to be an option for the router, which makes much more sense! |
| expect(mockStartTransaction).toHaveBeenLastCalledWith({ | ||
| name: '/login', | ||
| metadata: { | ||
| source: 'route', |
There was a problem hiding this comment.
Is this actually 'route' or shouldn't this be 'url' now? This has an impact on dynamic sampling and the performance product.
There was a problem hiding this comment.
This just disables using the name, so it uses the parametrized route when available and falls back to the URL if not.
See:
This adds a new option
routeLabelfor the vue SDK which allows to configure if you want to use the routename, if it is set.When setting this to
path(default isname), we'll always use the path of the route even if a name exists.Usage:
Closes #5013