Syntax
newrelic.setCurrentRouteName(string $name)Gives SPA routes more accurate names than default names. Monitors specific routes rather than by default grouping.
Requirements
Agent version nr-998 or higher.
Description
This method names the current route. This can be useful to:
- Give routes more accurate names than they would have by default.
- Monitor a route that might otherwise be grouped with other routes by default.
Currently this method applies only to SPA BrowserInteraction events. Using this API creates two new custom attributes that track the previous route and the target route:
previousRouteNametargetRouteName
When using this API, the browserInteractionName attribute will take the targetRouteName value. If setName is used to set the browser interaction name, that will take precedence.
The setCurrentRouteName() API determines the name attributes for BrowserInteraction events, so this API must be called every time there is a route change. This will ensure that BrowserInteraction events have the correct attributes.
Tip
Compare with setName(), which sets a name for a browser interaction, not a route.
Parameters
Parameter | Description |
|---|---|
string | Required. Current route name for the page. Route names passed to If |
Examples
router.onChange(function (route) { newrelic.setCurrentRouteName(route.name)})For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.