Traditional real user monitoring? Please no! Who cares about the average server response time? We want more, we want smarter data.
DO NOT USE YET. Work in progress
More details soon...
There are two ways to configure RSUM. You cannot mix these two methods.
Add HTML parameters to the script's tag
<script src="rsum.min.js"
data-rsum-host="http://mydomain.com:8383/rsum"
data-rsum-session-timeout="120"
data-rsum-sample="0.2"
data-rsum-conversion="true"
></script>
All three parameters are optional.
Set the global variable RSUM_SETTINGS
before the script is loaded and executed.
<script>
window.RSUM_SETTINGS = {
host: 'http://mydomain.com:8383/rsum',
sessionTimeout: 120,
sample: 0.2,
conversion: true
}
</script>
...
<script src="rsum.min.js"></script>
The RSUM server root (ex: "http://mydomain.com:8383/rsum"). Default value is /rsum
.
The duration of a session in minutes. Default value is 120
minutes.
The fraction of clients who should actually send data (0 > sample >= 1). Default value is 1`.
Set this option to true
only if you want the page to be a conversion page. Default value is false.
If you want to send the conversion event yourself in javascript, you can call the RSUM.conversion()
function at any time after the page is loaded.
You will need an elasticsearch instance. It can be hosted on the same machine as the server. Don't worry, it's pretty easy to install, just follow this guide.
npm install rsum -g
The server will read the /config/config.json
file on startup. Edit this file to change the default config.
Enables debug mode
Root URL of the website that will call RSUM. It must include the protocol (http://
or https://
but won't work with both for the moment).
Duration of a user session (in minutes). After that time, a user coming back will be counted as a new user.
Elasticsearch REST API path. If you installed it on the same machine with the default port, use http://localhost:9200
.
(todo)
- Avoid browser compatibility errors and write a chapter in README about compatibility
- Ignore search engines bots
- Measure time in background ratio
- Give access to the UX score client-side, so the website can make some optimizations (example: remove ads when user has a bad user experience)
- Add a way to filter IP addresses, so it can ignore you visiting your own website
- 2014-04-28 v0.1.0 initial release
Gaël Métais. I'm a webperf freelance based in Paris. If you understand french, you can visit my website.