mPulse Setup

Document created by DPM Admin Employee on Jul 14, 2017Last modified by Lauren Younger on Sep 26, 2017
Version 4Show Document
  • View in full screen mode

SOASTA mPulse combines the power behind SOASTA's real-time analytics with real user measurement (RUM) beacons for web sites and native apps in iOS. With just a few simple project modifications, you can add mPulse capabilities to your native app projects and web sites to collect mPulse beacons that reveal how real users interact within your apps and sites.

For administration, mPulse™ provides the App Administrator role. A user with this role can create or edit an app. For more information, see User Creation in mPulse and Users & Groups .



Creating a Web App

1. To get started, login as the user with App Administration rights.

2. Click Add Your App from the Home page



3. The Configure Your App box appears with Web App checked by default. 
4. Enter your domain name, and click Next.



General Tab

5. Go the advanced configuration of your app, then select the General tab.

6. Enter a name.

7. Optionally, enter any A/B tests variable name in use in your app. For example, MyWebApp.ab_test.  For more information, see Configuring mPulse to measure A/B (Bucket) Tests

8. Optionally, enter a development server list or a domain or a site separated by comma. The information entered in this field is not counted into your mPulse data, and it does not appear on your Dashboards. This list is to avoid malfunctioning of the staging or test environments skewing data in your mPulse dashboards.

9. Akamai users, please follow tagging instructions here!

10. Optionally, non-Akamai customers, click the Show JavaScript checkbox to inspect and copy your JavaScript code. Copy your app's code for use in both multi-page sites and single-page sites. For multi-page sites, paste this code into the site or page using the <SCRIPT> tag. For single-page sites some additional steps are necessary. See Instrumenting Single Page Apps below. An example of the full JavaScript snippet is shown here.

11. Optionally, check the Auto Instrument XHR checkbox.  For more information, see Enabling XHR.

12. Select the SPA Framework. For more information, see Single Page Apps.

13. Optionally, check the Enable bandwidth testing, and then provide the images location on your server. For more information, see Configuring mPulse to measure user Bandwidth.

14. Optionally, click the Enable REST API checkbox. Once you click this button, you will see the REST API Secret Key field and the Generate Secret Key button, which you can use in the mpulse.js library.



Additional Tabs

Using mPulse JavaScript on the Web

Once an mPulse App is created using the Configure Apps box (found in Central > Apps) it can be used in the <HEAD> tag for each page whose beacons you'd like to collect.

  • For multi-page sites, as noted above, simply copy the JavaScript from the Configure Apps > field and use it in the <HEAD> tag for each page.
  • For single-page sites additional steps are necessary. Use the following guidelines:

Sending Beacons Manually

The mPulse beacon can be triggered manually to collect data for applications that rely on the firing of AJAX requests to refresh page content within a single page container.

This can also be used to capture the performance of JavaScript functions that occur after the onload event of a traditional page.

The process below requires the following items:

  • The process that is to be timed must be assigned to its own page group.
  • The process to be timed has clear JavaScript events indicating the start and end of the process that can be used to trigger the transmission of the beacon.

Note: The following items that are marked in yellow are required for the timing mechanism.


// Immediately before the AJAX request is sent off: 
if (BOOMR) {
            var mPtimer = BOOMR.requestStart("[YOUR PAGE GROUP NAME HERE]"); 
           } (... YOUR FUNCTION GOES HERE ...)
// Immediately after AJAX / JavaScript request returns (for example, in the readyStateChange event handler) 
// Add the following line only if you want it to track the event as a Custom Metric 
//BOOMR.addVar("cmet.MYCUSTOMMETRIC", 1);
if (mPtimer){ mPtimer.loaded(); } 

2 people found this helpful