RUM page labels

Specify page labels for your RUM page views

When analyzing website performance it's often desirable to analyze a specific type of page. The way to do this in RUM is with page labels. All of the RUM dashboards let you drill down to specific pages using the 'Page Label' select list:


By default, RUM uses the page's title (document.title) as the page label. This works pretty well for many sites, but for others it can be too specific. For example, a media site might want to analyze "article" pages, but each article has a different title. 

In order to create better page categories, you can use the RUM JS API

LUX = window.LUX || {};
LUX.label = "article";

This is a great solution. It gives you the flexibility to create whatever page labels you want. One downside is that you have to add LUX.label to every page. Some teams have already labelled their pages in some other way using JavaScript. If this is your situation, an easy way for you to get your existing page labels into RUM is the Page Label JS setting. You can access this setting by clicking Edit RUM on your Settings page: 


Checking Labels

Once you've configured page labels there are a couple of ways to check they're working as expected

  • Log into RUM, and view the Live Dashboard – the table has Label as the last column

  • Use RUM's debugging calls in the DevTools console - Troubleshooting RUM page labels


Important notes

  • If a page has both LUX.label and the page label JS variable, then LUX.label takes precedence.

  • For security reasons, the page label JS can not call functions. Arrays and properties are supported.

  • If the page label JS variable is not defined on a specific page, RUM will still check for it and then fallback to using the page title.

  • Changes to your page label JS setting are pushed live within 15 minutes. However, it can take days to rollout to 100% of users (because it requires them to download a new version of lux.js). For testing purposes, if you'd like to see your changes sooner simply clear lux.js from your cache.

Did this page help you?