Set up mPulse at the origin

If you require mPulse at the origin, you'll need to tag your site with the mPulse snippet. You can either manually copy and paste the snippet on your site (at the origin server) or use a tag manager service.

A tag manager such as Tealium, provides automation and reduces placement errors. Following best practice, use a common template that all webpages can pick up, such as header.jsp.

After the setup, mPulse starts to collect beacons within seconds. You'll see live dashboards in mPulse with your own data right away, except in the Waterfall dashboard and with historical data collected more than 24 hours earlier, both of which can take a few more minutes to load.

How to

  1. Create an mPulse app.

  2. Add the mPulse snippet to your pages manually or Leverage tag management.

📘

Note

The content for these steps is explained in further detail, below.

Next steps

Once mPulse receives your data beacons and you've had a chance to get familiar with the product, customize your web app configuration for more in-depth analysis on your site.

Create an mPulse app

An mPulse app is the configuration that's used to get performance and business data (for example, page group definitions, custom timers, and custom metrics) from your website into mPulse for data analysis.

Before you begin

You must have mPulse App Administrator privileges to create an app. For assistance, contact your organization's ​Akamai​ Administrator or support.

When you create an mPulse app, a unique API key is automatically generated with in the app's JavaScript code snippet (see How mPulse works). That key combined with your app or domain name (for example, android-gradle-app, or example.edgesuite.net) is what uniquely identifies your data (beacons).

mPulse supports the following app configurations:

  • HTML5 for multi-page websites

  • AngluarJS, Backbone.js, Ember.js, React.js, and other single page applications (SPAs)

How to

  1. Log in to mPulse.

  2. On the Homepage, click New > App to open the Configure Your App dialog.

Configure your app dialogConfigure your app dialog

  1. Select an app type for your website:

🚧

Caution

The instructions for a multi-page website and a SPA website are listed in this step as bullet items. Read the instructions for each one carefully.

For a multi-page website:

a. Click the HTML5 icon, enter your domain name in the field at he bottom of the dialog, click Next. The mPulse snippet code appears in the Configure Your App dialog.

mPulse snippet code in Configure Your App dialogmPulse snippet code in Configure Your App dialog

b. Click Next, then click Advanced to open the Configure Web App dialog.

Configure Web App dialogConfigure Web App dialog

  • For a single page application website:

a. Select one of the supported SPA frameworks.

b. Enter your domain name in the field at the bottom of the dialog, then click Next.

c. Follow the instructions in the dialogs, as shown in the following AngularJS dialog examples. For more information on setting up a single page application, see Single Page Apps.

Configure Your App dialogConfigure Your App dialog

d. When you're done, click Next, then click Advanced. Once mPulse receives your data beacons and you've had a chance to get familiar with the product, add some customization to your web app configuration for more in-depth analysis.

e. When you're done, click Next, then click Advanced.

Next steps

To set up mPulse at the origin, add the mPulse snippet to your pages manually or leverage tag management (details below).

Add the mPulse snippet to your pages manually

If ​Akamai​ does not deliver your traffic, manually tag your site's pages at the origin with the mPulse JavaScript snippet.

Before you begin

Before you start, make sure that your mPulse app configuration is open to the General tab (see Create an mPulse app steps, above).

How to

  1. On the General tab, to the right of the API key, select the Show JavaScript checkbox to view the mPulse snippet.

The JavaScript code that you see in the in dialog is the mPulse snippet. The snippet includes the boomerang code and your unique 25-character API key that mPulse uses to identify your site's beacons. The API key value is enclosed in double quotation marks near the bottom of the snippet.

mPulse JavaScript snippetmPulse JavaScript snippet

  1. Using the HTML <script>tag, place the snippet in the HTML document as close to the opening <HEAD> statement as possible, but after any position-sensitive METAtags so the boomerang library loads before the browsers onload event fires.

  2. Click Cancel to close the Configure Your App dialog.

After you tag your site correctly, it'll be several minutes before mPulse receives your data beacons. While you wait, explore mPulse and remember to check out a few of the dashboards. They'll show you how to use mPulse to see your performance in real time.

Next steps

Once mPulse receives your data beacons and you've had a chance to get familiar with the product, add some customization to your web app configuration for more in-depth analysis on your site.

Leverage tag management

Follow these guidelines and best practices when using a tag management service to insert the mPulse snippet on your webpages.

Tag management services

If ​Akamai​ does not deliver your web traffic, consider using one of these tag management services:

  • Tealium
  • Tagman
  • Ensighten
  • BrightTag
  • Google Tag Manager
  • Adobe Marketing Cloud
  • WordPress

Don't use a tag management service:

  • if you know that the boomerang.js library only loads content after the onload event is fired, which defers the JavaScript until much later
  • if you're uncertain that the boomerang.js library can be inserted into all pages (for example, if rules are only set for subsets of pages)
  • if the tag management service library itself is loaded very late on the page

Once mPulse receives your data beacons and you've had a chance to get familiar with the product, add some customization to your web app configuration for more in-depth analysis on your site.


Did this page help you?