setPageViewName

Syntax

newrelic.setPageViewName(string $name[, string $host])

Groups page views to help URL structure or to capture the URL's routing information.

Requirements

• Browser Lite, Pro, or Pro+SPA agent (v593 or higher)

• If you're using npm to install the browser agent, you must enable at least one feature when instantiating the BrowserAgent class. For example, add the following in thefeatures array:

  import { Metrics } from '@newrelic/browser-agent/features/metrics'
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      Metrics
    ]
  }

  Copy

  For more information, see the npm browser installation documentation.

Description

Customized page names can help you more effectively group your page views if your URL structure does not provide useful groupings or if the browser agent doesn't capture the part of the URL where routing information is stored. When querying the PageView event, the custom name will be exposed as the browserTransactionName attribute. The custom name will also be visible in the browser monitoring UI.

To use a customized page view name instead of the page URL, format the name as a slash-delimited string. Make this call before the window load event fires in order for it to appear correctly.

Parameters

Examples

newrelic.setPageViewName('/login')
// Or
newrelic.setPageViewName('/login', 'https://www.myapp.com')