Guide
TrainingSupportCommunity

Configure the Augment insights rule

Suggest Edits

Use this rule to control the settings related to monitoring and reporting. This gives you additional visibility into your traffic and audiences.

Set up Traffic reporting

Required

Here, you need to set up a unique ​Akamai​ content provider (CP) code that's used to track reporting and billing data for traffic delivered through this Ion property.

Pick a CP code

You should have been given at least one CP code when you provisioned Ion with your account team. Just click the Content Provider Code field and select it.

You can also select an existing CP code to add traffic and reporting data from this property to it. Before you do this, consider the following points:

  • Both billing and reporting for content delivered through a property are tracked through a CP code. If you select an existing CP code that's already delivering Ion traffic, reporting and billing information for this property will be merged with that one. For better granularity in your tracking, we recommend that you set up a new CP code for a new Ion property.

  • Log Delivery Service and CP codes. If you want to add Log Delivery Service support, the CP code you select can't be applied to another property that's already on the production network. However, the CP code can be applied to another property that's still on the staging network.

To help separate your data we recommend that you create and apply a new CP code.

Create a new CP code

If you'd like, you can create a new CP code for use:

  1. Click Create new... The Create a new CP Code window opens.

📘

Your contract is limited to a specific number of CP codes for use. If you don't have access to a new one, an error message is displayed. Reach out to your account team for help in getting access to more.

  1. Enter a friendly name for the CP code. It defaults to what you've named your Ion property. With a name set, click Create.

The new CP code is added to the Content Provider Code field, along with a unique numeric value. This value is used to:

  • Review traffic report data via the Reporting tool in ​Akamai Control Center​—you can filter report output using this specific CP code.

  • Optionally add Log Delivery Service support.

Set up mPulse RUM

Optional

mPulse is a real-user monitoring (RUM) solution that collects and analyzes detailed information about your users' experience whenever they visit your site or app. When a visitor looks at a page on your site, mPulse captures over 200 business and performance facts about that experience, directly from the visitor's browser or mobile application. It sends the data back to ​Akamai​ so you can see how your site's performing for real users, in real-time.

📘

mPulse is required with other Ion features

How mPulse works

Before you start applying settings in this behavior, take a few minutes to review How mPulse works. This will give you a good understanding of the mPulse process.

Set up mPulse

This behavior is enabled by default and all remaining options are at their recommended setting. If you keep these defaults, the following data is collected and sent back to ​​Akamai​​ in the "mPulse beacon" for access via mPulse dashboards:

  • Top-level information. This includes the domain, timestamp, and IP address of the end user.
  • Session information. This includes the sessionID and session start time.
  • User agent information. This includes the browser family, major version, and device type.
  • Geographical. This includes the country and region, if applicable.
  • Bandwidth. This includes the total in kbps and bandwidth block, if applicable.
  • Timer. This includes the response time and DOM loaded, if applicable.
  • Custom metrics. This includes conversion and revenue, if applicable.
  • Custom dimensions. This could include values such as a store number, logged in status, or the origin server used.
  • Third-party analytics. This could include Google, Adobe, and IBM Digital Analytics, as applicable for your site.
  • Resource timing data. This includes the startTime, dns_start, and dns_end.

See this list of available parameters for complete details on what the mPulse beacon collects for web sites or apps.

📘

Do you need PCI compliance?

Set Boomerang PCI Configuration to On to have mPulse use the boomerang javascript library (boomerang.js) when requesting data. This option sets it to "PCI mode." This restricts the transfer of boomerang.js to TLS 1.2. It automatically detects certain types of cardholder inputs and blocks any attempt to include those input values in the mPulse beacon. For more information on enabling PCI Mode, visit the ​Akamai​ Community.

Customize the options in this behavior

While leaving the options at their default is the recommended procedure, you can customize these options.

  • Loader Snippet Version. This is the version of the "mPulse snippet" used to support mPulse. ​Akamai​ injects the snippet into instances of your pages at the ​Akamai​ edge server when an end user requests your website or app. The snippet is comprised of the boomerang.js and other identifier information, including the mPulse API Key. You can select from the following:

    • Version 12 (IFRAME-less in supported browsers, CSP support, Not Auto-Updated). This is the default value and what's recommended. It applies to the most recent, stable, and tested version of the snippet.

    • Version 10 (IFRAME, Not Auto-Updated). This should only apply to existing Ion properties that already had this version of the snippet selected. You shouldn't select this for a new property.

    • Latest (Auto-Updated). Select this to always use the most recent, stable, and tested version of the snippet. As new versions are added, your Ion property will automatically update to use it.

  • Beta (Auto-Updated). Select this to use any new beta version of the snippet that's added. These are typically in perpetual testing and aren't guaranteed to deliver consistent results. As new beta versions are added, your Ion property will automatically update to use it.

  • mPulse API Key. This is a unique value used to identify the mPulse instance for your Ion property. It's used in one of two ways:

    • Create a new mPulse instance. Leave this field blank to create a new "mPulse app" that corresponds to your Ion property. The mPulse app represents your site in the actual mPulse dashboards. ​Akamai​ automatically generates a unique, alphanumeric API key value in the mPulse app that's used for verification. As a request is fielded by your Ion property, the mPulse API key is injected into the mPulse snippet. This key is compared against the API key set in the mPulse app for your website or app. If they resolve, data is gathered in mPulse beacons that are sent to your mPulse app instance.

    • Use an existing mPulse instance. You can include the mPulse API key for an existing mPulse app. The data that's gathered for the site you configure in this property will be included in the existing mPulse app's dashboard. To get the mPulse API key for an existing mPulse app:

      1. Log in to mPulse.
      2. From the Home page, select the mPulse app that you want to direct your traffic to.
      3. Click the General tab to view the API Key.
      4. Copy the API key to your clipboard.
      5. Paste the API key into the mPulse API Key field here in your Ion property.

🚧

Don't insert random values in mPulse API Key. It either needs to remain blank for a new mPulse app or be the mPulse API key for an existing mPulse app.

  • Custom ResourceTiming Buffer Size. This tells boomerang.js to raise the browser’s default resource limit. This allows mPulse to track more resources on your site. Leaving it at its default, blank setting will increase this limit to 150. You can manually input a higher value, but this can increase your memory usage so be mindful when using this feature.

  • Config Override. Manually input values here to customize boomerang.js to meet your needs. You could enable and disable single-page application (SPA) support for specific pages. As an example, {"history": {"enabled": true,"auto": true}} enables the single page application (SPA) plugin.

Customize your site or app for mPulse

You can use several recommended and optional processes, outside of your Ion property to fine-tune your website or app for mPulse. Take a look at the Customize your web app configuration category of topics in the mPulse user docs for more information.

Use the mPulse dashboards

After you activate your Ion property on the production network, the mPulse snippet is injected into your website or app. Data gathering will begin and you can view it on the mPulse dashboards.

📘

An initial mPulse property configuration can take an average of 15 minutes to deploy to the edge servers. This is based on the amount of traffic being sent, and the time to populate the data in the portal.

  1. Open mPulse.
  2. Select Home from the menu bar to see your current dashboard.
  3. Select a card for the report type you want.
  4. Click the top-left most drop-down in the mPulse menu bar. (This default displays "mPulse Demo.")
  5. Select your mPulse app name, which is typically based on the domain name for your site or app—what you set in your property hostname.

More details on mPulse

Take a look at the mPulse user documentation for full details on its configuration and the use of its dashboards.

Set up Geolocation

Optional

This is also referred to as "Content Targeting." Set this slider to On to get the geographic location, network, connection speed, and other data for each user that requests your site or app. The information is sent to your origin in the X-Akamai-Edgescape request header, and you can use it to determine the content to return to the end user.

A returned header looks similar to this:

X-Akamai-Edgescape: georegion=1,country_code=reserved,region_code=reserved,city=reserved,dma=reserved,pmsa=reserved,msa=reserved,
areacode=reserved,county=reserved,fips=reserved,lat=reserved,long=reserved,timezone=reserved,zip=reserved,
continent=reserved,throughput=reserved,network=reserved,asnum=,network_type=reserved

In the example above, most of the values have been obscured. If the value shown in the sample EdgeScape header above doesn't appear in a request to your origin, the value is empty for that request.

You can use Verify and Locate IP tool in the Edge Diagnostics interface on ​Control Center​ to review a given IP. To access this tool, you need active credentials for ​Control Center​ .

📘

If you've configured your property to change how content is cached based on the values included in the X-Akamai-Edgescape header, you may need to change this setting, or change how your origin returns content. Reach out to your ​Akamai​ team for assistance.

Set up Log Delivery

Optional

The ​Akamai​ Log Delivery Service (LDS) can be used to get server logs for Ion. ​Akamai​ constantly gathers log entries from thousands of edge servers around the world. LDS creates a copy of these logs and delivers them to you, using a format and schedule you determine. Use this sub-rule to specify the level of detail you want to be logged in your LDS reports.

Set the options

Select On for each log you want included in your Log Delivery Service reports:

  • Log Host Header. This header specifies the domain name of the server (for virtual hosting), and optionally the TCP port number on which the server is listening.

  • Log Referer Header. This header contains the address of the previous web page from which a link to the currently requested page was followed. The Referer header allows servers to identify from where people are visiting.

  • Log User-Agent Header. This header contains a characteristic string that allows the network protocol peers to identify the application type, operating system, software vendor, or software version of the requesting client.

  • Log Accept-Language Header. This header advertises which languages the client is able to understand, and which locale variant is preferred.

  • Cookie Mode. Select the cookies to be logged—Don't log any cookies, Log all cookies, or Log some cookies. Selecting the latter will reveal a separate field allowing you to select the desired cookie format to capture, sessionid or user_local.

  • Include Custom Log Field. Manually input the name of a custom header type you know to be delivered in a request for your content. You can use a variable value to represent one of these headers if you've set one up.

Add Log Delivery

To use LDS, you need to configure it for the CP code you set up for Traffic reporting. You do this in a separate application and you need to do it before you promote your Ion property to the production network.

  1. In ​Akamai Control Center​, go to ☰ > COMMON SERVICES > Log delivery.

  2. In the Filter field, enter the numeric value for your CP code and press Enter to filter results.

  3. Click ... in the Action column and select Start a log delivery > New. If you don't see the "..." your current ​Control Center​ account doesn't have access to edit logs. Talk to your local ​Akamai​ administrator, or contact your ​Akamai​ account team for assistance.

  4. Follow the wizard to set up log delivery. See the Log Delivery Service user documentation for specific information.

🚧

It takes 24-48 hours for log delivery to start from the time you activate it. Keep this in mind when configuring log delivery. Make sure it's completely set up before delivering any actual content via your Ion property. Logs can't be collected retroactively.

Updated about 1 year ago