URL whitelists: Grouping browser metrics

New Relic Browser uses URL patterns for metrics that appear on the Page views page and AJAX page. Benefits of using URL patterns include:

  • Present timings for page views and AJAX calls by using helpful groupings of similar pages.
  • Use a format that is intuitive based on the site's URLs.

URL grouping can be done automatically based on New Relic Browser's analysis of the website's URL space. This results in URL patterns such as www.foo.com/users/*/profile, which omit the varying user ID parameter and group similar "user profile" page views together. You can also create your own URL groups.

When creating URL groups, the intent is to capture those parts of the URL that are similar across many different individual page views, and provide information about the code path that generated the URL's content.

Input to whitelists

The inputs to New Relic Browser's grouping algorithm are the URLs that users access on your site, and the AJAX endpoints that your site makes calls to (whether those are your own endpoints or third-party endpoints). When a URL is loaded or an AJAX call is recorded, the URL is first filtered by stripping any query parameters out of the URL. Hash fragments will also be stripped unless you are using SPA monitoring. These parameters may contain sensitive information, and in many cases they vary too extensively to create useful groupings.

URL groups are created automatically when an application first reports data to New Relic.

Automatic grouping behavior

After the URL has been filtered, New Relic Browser analyzes requests and splits URLs into segments on separator characters (dots for domains, slashes for paths). Useful terms will be preserved and used in the automated grouping. Domain information is separated by port number automatically, so that (for example) HTTP and HTTPS endpoints are listed separately.

Adding URL groupings

You can modify how New Relic Browser groups your metrics by adding to your application's URL whitelist. Adding segments to the whitelist makes these terms always appear in your URL groups for new data reported to New Relic, and never be rolled up to *.

screen url segments
Browser > Browser apps > (selected app) > Settings > Segment whitelists: To override how New Relic Browser groups your metrics, you can add domain and path segments to the URL segment whitelist.

To add new URL segments to your application's whitelist:

  1. From the New Relic menu bar, select Browser > Browser apps > (selected app) > Settings > Segment whitelists.
  2. In the Whitelisted segments, select the plus plus-circle icon, and type the segments you want to appear in groupings on the Page views and AJAX pages. Enter domain segments (elements of the domain betwen dots) or path segments (elements of the URL path between slashes). Order is not important when whitelisting multiple segments.
  3. Your changes will be automatically saved.

Make sure the segments you add exactly match the way the segments appear in your URLs. If a URL path segment ends in .html or .jsp, the extension must be included in the segment. Segments are case-sensitive.

Creating rules

Follow these guidelines for creating your URL whitelist.

If you want to... Do this...
Whitelist a segment you're not seeing

Enter the segment in the whitelist. For example, if you're seeing /users/* and you have a path /users/edit that you don't see, enter edit in the whitelist.

You cannot whitelist numbers, GUIDs, or extremely long segments (100 or more characters).

Whitelist a domain

Enter each segment of the domain. For example, to whitelist www.newrelic.com, enter www, newrelic, and com.

Whitelist a path

Whitelist every term for that path. For example, to see www.domain1.com/bar/foo, if you already see www.domain1.com, enter bar and foo as segments.

Maintaining URL whitelists

Over time, the URLs or domains for your application may change. New Relic will automatically adapt your application's groupings based on these changes, but you may also want to make some changes yourself. You can use the techniques above of adding or removing segments from the whitelist to change the way your URLs are grouped to better meet your needs.

The automated grouping algorithm aims to group URLs usefully, and in some cases you may see more different groupings than you expect. If you are seeing too many URL groupings, or terms that are not useful to you, or if you are having trouble grouping your URLs appropriately, get support at support.newrelic.com.

Connecting page views to controller names

As of October 2014, New Relic Browser uses URL patterns for metric grouping instead of server-side controller action names, such as ApplicationsController#show. New Relic Browser continues to include links to related back-end New Relic APM metrics as applicable. However, they are not the primary grouping strategy for New Relic Browser as a standalone product.

For more help

Additional documentation resources include:

Discuss Browser monitoring in the New Relic Online Technical Community! Troubleshoot and ask questions, or discuss JavaScript error reporting or AJAX timing in detail.

If you need additional help, get support at support.newrelic.com.