Lumen help
Introduction
On top of the stats API exposed by the SDK, we created a view helper called LumenStatsView
to help you integrate and understand CDN Load Balancer faster. The LumenStatsView
will inform you about the different states of the SDK lifecycle and Lumen metrics.
The view looks like the following:
Note: LumenStatsView
is NOT intended for production
Adding a LumenStatsView
is really simple, but varies slightly if you chose to integrate with our Kotlin SDK, Java SDK, or our ExoPlayer Plugin. Choose the correct code below corresponding to your integration of choice.
First, you will need to add the following dependency to the build.gradle
Add the utils dependency to your module’s build.gradle
by changing the name of the artifact. Append -utils
to the artifact name to pull the utils package as well.
Add the LumenStatsView
to your layout, ideally over the biggest surface. You can do this freely as it won’t intercept user interaction.
Finally, you will need to retrieve your view by your preferred method and link it with a LumenDeliveryClient
or LumenDeliveryClientPlugin
instance
What do the stats tell you?
The LumenStatsView
shows the following information regarding the performance and scores for each CDN in the CDN list being used.
Parameter | Description | Unit |
Download |
Total amount of bytes downloaded from the CDN |
MB |
Bandwidth |
|
MB/s |
Global score |
Global CDN score, calculated as global score = QoS score * business score |
|
Business score |
User defined score which controls the level of priority of a CDN based on your own business requirements. It can take an integer value between 1 and 100 |
|
QoS score |
Denotes a score for the quality of service that the user is receiving. Each session can have a different QoS score and is measured from actual performance (like rebuffering events, dropped frames, etc.) |
|
Error count |
Number of HTTP errors received from the CDN. |
|