How to set up measurement of timing information

This guide explains Phenix's recommendations for gathering timing information for the purpose of optimizing video experiences. Following this methodology will allow for clear conversations and data comparisons (apples to apples) to enable quicker resolutions to issues and a faster path toward optimized experiences.

Phenix recommends using the Performance API built into modern browsers. Specifically, the performance.measure(name) function is used in several places to mark specific points in the video delivery process.

1. Add performance.measure() calls at key measurement points

2. Gather the resulting data as JSON or CSV (JSON/HTTP POST example shown below)

Place calls to performance.measure with an appropriate text identifier in at least these places:

A) First line of your JavaScript.

1performance.measure('firstLineOfJS');

B) Just before the joinChannel call is made.

1performance.measure("joinChannel");
2  channel.joinChannel(joinChannelOptions, function joinChannelCallback(error, response) {

C) First thing in the joinChannelCallback.

1channel.joinChannel(joinChannelOptions, function joinChannelCallback(error, response) {
2    performance.measure("joinChannelCallback");

D) First thing in the subscriberCallback

1}, function subscriberCallback(error, response) {
2      performance.measure("subscriberCallback");

E) Set a callback on the videoElement.ontimeupdate

1var videoElement = document.getElementById('myVideoId');
2videoElement.ontimeupdate = function () {
3  performance.measure('firstFrameOfVideo');
4  videoElement.ontimeupdate = null;
5};

After your player experience is completely loaded and in a steady state gather the information from the performance.measure() calls and send them to a backend for recording.

1var measures = performance.getEntriesByType('measure');
2var timingJson = new Object();
3timingJson.timestamp = Date.now();
4for (var m = 0; m < measures.length; m++) {
5  timingJson[measures[m].name] = measures[m].duration;
6}
7var xhr = new XMLHttpRequest();
8xhr.open('POST', 'https://logging-endpoint.com/path');
9xhr.setRequestHeader('Content-Type', 'application/json; charset=UTF-8');
10xhr.send(JSON.stringify(timingJson));

Once gathered on a backend the data can be shared in JSON or CSV format.

Example:

1[
2  {
3    "firstLineOfJS": 305.4450000054203,
4    "joinChannel": 317.17000000935514,
5    "joinChannelCallback": 727.820000000065,
6    "subscriberCallback": 1059.5500000054017,
7    "firstFrameOfVideo": 1917.670000009821
8  },
9  ...
10]