Skip to content

Latest commit

 

History

History
127 lines (82 loc) · 5.02 KB

README.md

File metadata and controls

127 lines (82 loc) · 5.02 KB
Raw

CMCD-Analyzer

¡

The CMCD-Analyzer allows any developer or tester to collect and analyze data from any type of player that has CMCD implemented. To be more specific, it will intercept players requests to check if the CMCD keys sent to the CDN are valid or not regarding the CMCD Standard.

This project uses Elasticsearch to store the data and Kibana for data visualization and graphing.

Table of Contents

Run the enviroment

To run the CMCD-Analyzer enviroment you will need to have installed and running:

When everything's ready, use docker-compose in your preferred command line running the command:

docker-compose up

NOTE: It takes a while for the system to be up the first time the command is run because Docker has to download all the images to create the containers.

After everyting is up and running you will have a full system to valdidate and analyze CMCD throw this tools:

To stop the system and remove the containers you have to press Ctrl+c and then run the command:

docker-compose down

Analyzing CMCD through the Web

This is the simplest way to extract and analyze CMCD using this project. After having the service running in your environment, follow these steps:

Example using hls.js as player

  1. Access the web via http://<your-ip>:5173

If you're running it on your own PC, just go to http://localhost:5173

  1. Enter the video you want to use to analyze the CMCD implementation in "Video URL"
  2. Verify that the IP is accessible from the device you're testing on. If you're testing on the same PC, you can use "localhost," which is the default value.
  3. Click "Generate URL" and copy the final URL.
  4. Enter the URL in the player you want to test and hit play!
  5. If the playback is correct, you'll see the results of the CMCD value extraction on the web

Analyzing CMCD through Kibana

Using Kibana, it's possible to view the data obtained by the CMCD extractor and create different charts. This data is stored in Elasticsearch using the cmcd-<id> index pattern, where <id> corresponds to a playback (see Build a modified URL for more information).

The Kibana instance comes with pre-configured indices and a dashboard named CMCD that generates a set of basic charts.

In this chapter we will mention to the Discover and the Dashbaord tool that can be found in Kibana's menu

Discover tool

With this tool you can search and explore the CMCD collected. Checkout this guide to learn more about Discover

  1. Go to the Kibana Discover view (http://<your-ip>:5601/app/discover).
  2. Change the index pattern to cmcd-* as shown in red in the previous image.
  3. Change the time filter if needed to find your data.

CMCD pre-loaded dashboard

In the dashbaord menu you will find a pre-loadad dashbard called CMCD Dashboards. Here you will find some basic charts to start exploring your data.

To learn more about dahsbards in Kibana take a look at this guide

Advanced topics

High-level architecture of the solution

Below you can find the architecture diagram of the solution and the interaction diagram between the various components to achieve the extraction of CMCD generated by a video player.

Build a modified URL

A modified URL should be structured like this:

<ip>:<port>/video/<id>/<base_64_encoded>/<file-name>

NOTE: The 'base_64_encoded' is the url of the video without it's name, put into a json and encoded to base64.

Non-modified URL example:

https://dxclj9vp3m44c.cloudfront.net/hls/Costa_Rica_144.m3u8

NOTE: The part of this URL you should build as a JSON and encode is: https://dxclj9vp3m44c.cloudfront.net/hls/

It would look like this:

{
“url”: “https://dxclj9vp3m44c.cloudfront.net/hls/"
}

To encode it you can use Base64 Encode

URL example modified:

http://localhost:3000/video/1/ew0KIOKAnHVybOKAnTog4oCcaHR0cHM6Ly9keGNsajl2cDNtNDRjLmNsb3VkZnJvbnQubmV0L2hscyINCn0=/Costa_Rica_144.m3u8