https://github.com/opsway/magento-mod-rum
Real-User-Monitoring module that gather information with Boomerang and send it Google Analytics
https://github.com/opsway/magento-mod-rum
Last synced: 8 months ago
JSON representation
Real-User-Monitoring module that gather information with Boomerang and send it Google Analytics
- Host: GitHub
- URL: https://github.com/opsway/magento-mod-rum
- Owner: opsway
- Created: 2013-12-13T04:52:38.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-14T05:56:08.000Z (about 12 years ago)
- Last Synced: 2025-01-19T11:17:56.050Z (over 1 year ago)
- Language: JavaScript
- Size: 6.56 MB
- Stars: 3
- Watchers: 45
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Magento module for site performance real-user monitoring (RUM) using GoogleAnalytics
==========
Module is based on [boomerang.js library](https://github.com/lognormal/boomerang/) and it is inspired by [great presentation done by Philip Tellis](http://www.slideshare.net/bluesmoon/boomerang-how-fast-do-users-think-your-site-is)
How does it work?
-----------
1. On every page load module is trying to page type using Magento layout handles.
Page types includes: homepage, category page, product page, my account, etc
2. Once in a while for defined %% of users we try to find out user Bandwidth and Latency and put it in Google Analytics Custom variables.
Check js/boomerang/boomerang.js for details, see formatBwLatency() function
Currently the list of bandwidth and latency variants is the following:
Bandwidth:
* <64Kb/s
* 64Kb/s-512Kb/s
* 512Kb/s-2Mb/s
* 2Mb/s-6Mb/s
* 6Mb/s-10Mb/s
* >10Mb/s
Latency:
* <50ms
* 50-100ms
* 100-200ms
* 200-400ms
* 400-1000ms
* >1000ms
Usage
-----------
1. Install to Magento by copying to directory structure
2. Enable GoogleAnalytics in Magento: System->Congirugration->Google API->Google Analytics->
2. You can specify site domain in System->Configuration->Web->Cookie domain
Boomerang.js will save calculated bandwidth/latency for a user in cookie, using this cookie domain.
This option is needed if you plan to use module when you have multiple sub-domains
3. By default bandwidth and latency is captured for 3% of users. You can change this number now in code of boomerang.phtml
4. Finally you can go to Google Analytics and find:
* User timings for each page type
* Events (basically clicks) for each page type
* Events flow
* Custom variables 1 and 2, which hold bandwidth and latency respectively. You can the build advanced segments arond
TODO
-----------
1. Specify %% of users to measure bandwidth & latency via Magento backoffice
2. Make getPageType() extensible through extending the class
3. Specify CustomVar keys (hardcoded to 4 and 5) through Admin
4. Specify page load noise treshold (set to 60s) through Admin