Operational Telemetry service for AEM as a Cloud Service real-use-monitoring-service-for-aem-as-a-cloud-service
Overview overview
The Operational Telemetry service is a performance monitoring technology that monitors the client-side traffic on a website or an application in real-time. This service focuses on collecting metrics and data that are key to optimize performance by monitoring website engagements, rather than the users themselves. With Operational Telemetry, key performance metrics are tracked right from the initiation of the URL until the request is served back to the browser.
Who can benefit from the Operational Telemetry service? who-can-benefit-from-operational-telemetry-service
Operational Telemetry helps customers and Adobe to understand how end-users interact with AEM sites. Operational Telemetry preserves the privacy of visitors through limited data collection and sampling - only a small portion of all page views is monitored.
Operational Telemetry service data sampling operational-telemetry-service-data-sampling
Traditional web analytics solutions try to collect data on every single visitor. AEM’s Operational Telemetry service only captures information from a small fraction of page views. The service is meant to be sampled and anonymized rather than a replacement for analytics. By default, pages have a 1:100 sampling ratio. Site operators cannot increase or decrease the sampling rate at this time. To estimate total traffic accurately, for every 100 page views, data is gathered from 1, giving you a reliable approximation of overall traffic.
As the decision of whether the data is collected, it is made on a page view by page view basis, and it becomes virtually impossible to track interactions across multiple pages. By design, Operational Telemetry has no concept of visitors or sessions, only of page views.
What data is collected? what-data-is-being-collected
The Operational Telemetry service is designed to minimize data collection. The full set of information collected by Operational Telemetry is listed below:
- The host name of the site being visited, for example:
experienceleague.adobe.com - The broad user agent type and operating system that is used to display the page, such as:
desktop:windowsormobile:ios - The time of the data collection, such as:
2021-06-26 06:00:02.596000 UTC (in order to preserve privacy, we round all minutes to the previous hour, so that only seconds and milliseconds are tracked) - The URL of the page being visited, for instance:
https://experienceleague.adobe.com/docs - The Referrer URL (the URL of the page that linked to the current page, if the user followed a link)
- A randomly generated ID of the page view, in a format similar to:
2Ac6 - The weight or inverse of the sampling rate, such as:
100. It means only one in one hundred page views is recorded - The checkpoint, or name, of a particular event in the sequence of loading the page. Or, interacting with it as a visitor
- The source, or identifier, of the DOM element that the user interacts with for the checkpoint mentioned above. For instance, it could be an image
- The target, or link to an external page or resource that the user interacts with for the checkpoint mentioned above. For example:
https://blog.adobe.com/jp/publish/2022/06/29/media_162fb947c7219d0537cce36adf22315d64fb86e94.png - The Core Web Vitals (CWV) performance metrics Largest Contentful Paint (LCP), Interaction to Next Paint (INP) and Cumulative Layout Shift (CLS) that describe the visitor’s quality of experience.
How Operational Telemetry works for a customer how-operational-telemetry-works-for-a-customer
Operational Telemetry automatically monitors client-side traffic. As an Adobe customer, you do not need to take any additional steps, as this service is seamlessly integrated into your existing setup. With Operational Telemetry service being generally available , you automatically benefit from this new feature. Operational Telemetry service does not expose any customer facing metrics today to monitor. We are working to deliver this functionality to you as soon as possible.
How Adobe uses Operational Telemetry how-operational-telemetry-data-is-being-used
Operational Telemetry data is used for the following purposes:
- To identify and fix performance bottlenecks for customer sites
- To understand how AEM interacts with other scripts (such as analytics, targeting, or external libraries) on the same page, to increase compatibility.
FAQ faq
-
Are “Interaction to next paint,” “Time to first byte,” and “First contentful paint” metrics being collected?
Interaction to next paint (INP) and Time To First Byte (TTFB) are collected. First contentful paint is not collected at this time.
-
The
/.rumpath is blocked on my site, how should I fix?The
/.rumpath is required for Operational Telemetry collection to work. If you use a CDN in front of Adobe’s AEM as a Cloud Service, ensure that the/.rumpath forwards to the same AEM origin as your other AEM content. And, ensure that it is not adjusted in any way. Alternatively, you can change the host to be used for Operational Telemetry torum.hlx.pageby setting an environment variable in Cloud Manager namedAEM_OPTEL_EXTERNALto the valuetrue. If you want to change back to same domain requests at a later point, simply remove that environment variable again. -
Does Operational Telemetry collection count toward content requests for contractual purposes?
The Operational Telemetry library and the Operational Telemetry collection do not count as content requests and do not increase the reported number of page views or API calls. Additionally, for customers who use out-of-the-box CDN with AEM as a Cloud Service, server-side collection is the basis for content requests.
-
How can I disable Operational Telemetry?
Adobe recommends using the Operational Telemetry due to its significant benefits and that it will allow Adobe to help you optimize your digital experiences by improving website performance. The service is designed to be seamless and has no impact on your website’s performance.
Opting out may mean missing out a chance to improve traffic engagement on your website. However, if you encounter any issues, you can disable Operational Telemetry by setting an environment variable in Cloud Manager named
AEM_OPTEL_DISABLEDto the valuetrue. If you want to enable Operational Telemetry again at a later point, simply remove that environment variable again. -
**Can I use a Content Security Policy with a nonce?
The support for Operational Telemetry contains an experimental feature to support a Content Security Policy with a nonce. This feature can be enabled by setting an environment variable in Cloud Manager named
AEM_OPTEL_NONCEto the valuetrue. If you want to disable this again at a later point, simply remove that environment variable again.If you encounter any issues with this feature, contact Adobe Support.
-
How can I enable Operational Telemetry only for certain pages?
By default, Operational Telemetry is enabled for all pages below the
/contentfolder in the repository. By setting an environment variable in Cloud Manager namedAEM_OPTEL_INCLUDED_PATHSto a list of comma-separate paths in the repository, Operational Telemetry will only be enabled for those pages. In addition you can setAEM_OPTEL_EXCLUDED_PATHSto a list of paths in the repository that will be excluded. With the combination of those two settings, you can adjust the inclusion of Operational Telemetry to your requirements.