Report browser monitoring custom events and attributes

You can use browser monitoring in New Relic to add custom events and attributes.

Page actions and views

Use the Browser API's addPageAction call to capture events, actions, route changes, or any end-user interactions with your application. The addPageAction call adds an event named PageAction that contains the action name and any custom attribute names and values you capture along with it. The PageAction event also contains any custom attributes you added to the PageView event.

Add custom attributes to the PageView event so you can query or filter your data to answer more questions about your application.

Prerequisites

In order to report PageAction events, verify these prerequisites:

Create PageAction events

To create a PageAction event:

1. Ensure the Browser agent is installed for your app.
2. Call the newrelic.addPageAction function in the relevant part of your application's JavaScript.
3. Wait a couple minutes for the application to run and report relevant PageAction events.
4. Run a NRQL query of the PageAction event that includes the actionName attribute you used to capture the event (and any associated attributes you sent along with the action).

Add custom attributes to PageView event

The PageView event is a default Browser-reported event. You can add custom attributes to the PageView event. Any custom attributes you add to the PageView event are also automatically added to the PageAction event.

There are two ways to add custom attributes to the PageView event:

Use setCustomAttribute Browser API call

To add a custom attribute to the PageView event via the Browser agent, use the setCustomAttribute Browser API call. This allows you to capture an attribute to be annotated on any PageAction event.

Forward custom attributes from APM data

If you added custom attributes to the APM Transaction event via an APM agent, you can forward those custom attributes to the PageView event automatically:

1. Insert custom attributes by following the agent-specific instructions.

2. Enable attribute forwarding in your agent configuration file:

   Agent	Enable attribute forwarding
   C SDK	Not supported.
   Go	To enable attributes, add this to your config (disabled by default): cfg.BrowserMonitoring.Attributes.Enabled = true Then add the attributes you want to include: cfg.BrowserMonitoring.Attributes.Include = []string{"request.*"}
   Java	Add the attributes.enabled option in the browser_monitoring stanza and set it to true.
   .NET	Add the <attributes enabled="true"> element as a child of the browserMonitoring element: <configuration xmlns="urn:newrelic-config"> ... <browserMonitoring autoInstrument="true"> ... <attributes enabled="true"> ... </attributes> </browserMonitoring> ... </configuration> If you are using manual Browser instrumentation the attribute needs to be created before the GetBrowserTimingHeader() call.
   Node.js	Add attributes: {enabled: true} to the browser_monitoring: { section of your app's newrelicjs configuration file.
   PHP	Add the newrelic.browser_monitoring.attributes.enabled option and set it to true.
   Python	Add the browser_monitoring.attributes.enabled option and set it to true.
   Ruby	Add the browser_monitoring.attributes.enabled option and set it to true.

PageAction and PageView attributes

To see the default attributes of PageAction and PageView, see Browser events.

Troubleshooting

Here are some troubleshooting tips:

For more help