Move mPulse from the origin to the edge

This procedure assumes that you currently insert the mPulse JavaScript snippet on your website via tag manager or manually at your origin. To move mPulse from your origin to the edge, inject the mPulse JavaScript snippet at the Akamai edge server.

How to

  1. Check the JavaScript snippet for the snippetExecuted parameter, which mPulse requires. If the parameter is there, continue with this procedure. Otherwise update the snippet to the latest version (See Boomerang documentation). Once the existing snippet is compatible, continue with this procedure.

    Here’s an example of the snippet with the snippetExecuted parameter

    <script>
    (function(){
        // Boomerang Loader Snippet version 10
        if (window.BOOMR && (window.BOOMR.version || window.BOOMR.snippetExecuted)) {
            return;
        }
    
        window.BOOMR = window.BOOMR || {};
        window.BOOMR.snippetExecuted = true;
    

    and here’s an example of the snippet without the snippetExecuted parameter.

    <script>
    (function(){
        if(window.BOOMR && window.BOOMR.version){return;}
    
  2. Access Property Manager configurations associated with the selected Control Center account. Go to > CDN > Properties (or just enter Properties in the search box).
    The Property Groups page opens.
  3. Select the property that you want to use to set up mPulse, then select the version.
  4. In Property Manager Editor, complete any general setup tasks or changes required for your property configuration.
  5. In the Rules section for the property, determine which existing rules you want to add mPulse to and whether you need additional rules for mPulse data collection.
  6. Once you know which rule you want to add mPulse to, select that rule, and then click Add Behavior. You can add the mPulse behavior to either the default rule or to a rule that you create.
  7. From the available behaviors, select mPulse, then click Insert Behavior to add it to the rule. If you don't see the mPulse behavior, open a case to contact Akamai Support.
    Note: It’s recommended that you only inject one mPulse API key per rule. To use multiple mPulse applications, add a rule for each application, then add the mPulse behavior with the appropriate API key to the rule.
  8. In the mPulse API Key field, enter the API key for the existing mPulse app that you created for origin injection. To locate the API Key of an existing mPulse app, log in to mPulse, select the mPulse app from the Home page, then click the General tab to view the API Key.
    Attention: For mPulse to identify your data beacons, the API key value must exactly match the value in your mPulse web app configuration, in this format: five groups of alphanumeric characters separated by single hyphens (for example, 234aA-b5678-9B23c-4567C-dDe89). If the key's format is incorrect, you'll see an error message under the API key field in the mPulse behavior.
  9. If your site needs to comply with payment card industry (PCI) data security, turn Boomerang PCI Configuration On. For more information about this and other mPulse options, see mPulse advanced options.
  10. Save your changes to the property configuration, then activate the property on the Akamai edge staging network (see Activating on staging).
  11. It’s optional but strongly recommended that you test the functionality of your domain. If you can't test all functionality, focus on the primary use cases for your business. It’s also advised that you run your full site test plan if you have one. For example, you might:
    • Verify session management
    • Verify that personalized content for one logged-in user is not improperly displayed to another
    • Verify shopping cart and checkout functions

    At this level of testing, it’s a good idea to verify that the intended content is being cached, for the intended amount of time, using the Akamai debug headers. Check Community for information on Akamai headers.

  12. Now, check your performance data in mPulse.
  13. Go to > COMMON SERVICES > Traffic reports > mPulse real user monitoring.
  14. On the mPulse menu bar, click Summary. The number under Page Views (in the Summary widget) shows your performance data beacons flowing into mPulse from the Akamai edge server.
    If you don’t see your beacons in the Summary dashboard, it might mean that there’s an issue with the mPulse setup or a compatibility issue with Boomerang on your site. You’ll want to verify that mPulse and Boomerang are working correctly on your website:
    1. Open Chrome developer tools.
    2. Click the Network tab.
    3. Check for the following:
      • A request to JavaScript resource at https://s.go-mpulse.net/boomerang/xxx.xxx where “xxx..xxx” represents the mPulse app key. This request indicates that the Boomerang script for your mPulse associated app was successfully requested.
      • A configuration request to endpoint at https://c.go-mpulse.net/api/config.json?key . This request tells the Boomerang script on your page what sort of settings are turned on for your mPulse app.
      • An HTTP POST request to endpoint https://xxxxxxx.akstat.io/. This represents the beacon for the performance data that Boomerang has captured for your user experience, which is sent to mPulse.
  15. Activate the mPulse-enable property version on the Akamai production network (see Activating on production).
  16. After your mPulse-enabled property is active on the Akamai production network, go to mPulse and check your page views again.
  17. If your performance data is flowing into mPulse from the edge server as expected, remove the mPulse snippet from your webpages or tag manager to turn off origin injection.