Documentation / WebPageReplay
- Why using WebPageReplay
- How does it work?
- The metrics
- Using WebPageReplay on desktop
- Using WebPageReplay on mobile (Chrome on Android)
WebPageReplay is a proxy that first records your web site and then replay it locally. That can help you find performance regression in the front-end code easier: Latency/server timings are constant. We have integrated WebPageReplay in both Browsertime and sitespeed.io Docker containers to make it easier to use.
There also other replay proxies like mahimahi but that version doesn’t support HTTP2 by default. We will happily include other proxies in the future.
Why using WebPageReplay #
Using WebPageReplay we get more stable metrics. This is super useful if you want to make sure you find front end performance regressions. However testing without a proxy is good since you will then get the same variations as your user will get.
How does it work? #
What’s cool about how we include WebPageReplay is that the only thing you need to do is to start the container with a couple of extra parameters! Inside the Docker container this is what happens:
- WebPageReplay is started in record mode
- Browsertime access the URLs you choose one time (so it is recorded)
- WebPageReplay is closed down
- WebPageReplay in replay mode is started on localhost
- The latency is setup on accessing localhost
- Sitespeed.io (using Browsertime) test the URL so many times you choose (with the current latency)
- WebPageReplay in replay mode is closed down
You can pass on any parameter to sitespeed.io/browsertime as usual.
--pageCompleteCheck you need to change that. We do that by default.
The metrics #
How stable metrics will you get? It depends on your page and how it is built. We have seen pages with super stable metrics and we have seen pages with not so stable metrics. You really need to test it yourself.
Using WebPageReplay on desktop #
You need to give Docker access to the network with
--cap-add=NET_ADMIN so that you can set the latency on the replay server. You need to add
-e REPLAY=true so that the Docker container know to start WebPageReplay. And then you set the latency
-e LATENCY=100. In this example we set the latency to 100 ms.
To run a simple test:
docker run --cap-add=NET_ADMIN --rm -v "$(pwd)":/sitespeed.io -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io:8.6.2 -n 5 -b chrome https://en.wikipedia.org/wiki/Barack_Obama
Remember to verify the HAR files produced so that it looks like it should: Verify that WebPageReplay replays your website correct. If it does, then use it :)
Using WebPageReplay on mobile (Chrome on Android) #
Using WebPageReplay in Docker and your Android phone only works on Linux. This is because mounting the USB port doesn’t work on Mac OS X.
docker run --privileged -v /dev/bus/usb:/dev/bus/usb -e START_ADB_SERVER=true --cap-add=NET_ADMIN --shm-size=1g --rm -v "$(pwd)":/sitespeed.io -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io:8.6.2 https://en.m.wikipedia.org/wiki/Barack_Obama --browsertime.chrome.android.package com.android.chrome --browsertime.xvfb false --browsertime.chrome.args ignore-certificate-errors-spki-list=PhrPvGIaAMmd29hj8BCZOq096yj7uMpRNHpn5PDxI6I= --browsertime.chrome.args user-data-dir=/data/tmp/chrome -n 11
docker run --privileged -v /dev/bus/usb:/dev/bus/usb -e START_ADB_SERVER=true --cap-add=NET_ADMIN --shm-size=1g --rm -v "$(pwd)":/browsertime -e REPLAY=true -e LATENCY=100 sitespeedio/browsertime:4.4.6 https://en.m.wikipedia.org/wiki/Barack_Obama --chrome.android.package com.android.chrome --xvfb false --chrome.args ignore-certificate-errors-spki-list=PhrPvGIaAMmd29hj8BCZOq096yj7uMpRNHpn5PDxI6I= --chrome.args user-data-dir=/data/tmp/chrome -n 11
A couple of things:
- You need to run the container in privileged mode to be able to mount USB ports
-e START_ADB_SERVER=trueto start the adb server inside the container (that makes it possible to talk to your phone)
- Make sure xvfb is turned off
- To ignore HTTPS certificate errors add
--chrome.args user-data-dir=/data/tmp/chrome(they only work together).
If you want to drive multiple phones from omne instance, you can change the ports WebPageReplay is using (making sure they do not collide between phones). You can do that with
-e WPR_HTTP_PORT=XXX and
-e WPR_HTTPS_PORT=YYY. The default ports are 8080 and 8081.