Menu

Lumen help

Monitoring tools for Android

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:

Statsview For CDN Load Balancer

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

                // /!\ Optional package for stats view. Not intended for production /!\
implementation "io.streamroot.lumen.delivery.client:orchestrator-sdk-utils:$dc_version"
            
                // /!\ Optional package for stats view. Not intended for production /!\
implementation "io.streamroot.lumen.delivery.client:orchestrator-sdk-utils:$dc_version"

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.

                // /!\ Optional package including Stat View. Not intended for production /!\
implementation "io.streamroot.lumen.delivery.client:orchestrator-plugin-exoplayer-$exo_version-utils:$dc_version.$plugin_patch"

Add the LumenStatsView to your layout, ideally over the biggest surface. You can do this freely as it won’t intercept user interaction.

                <io.streamroot.lumen.delivery.client.utils.LumenStatsView
    android:id="@+id/dcStatsView"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />
            
                <io.streamroot.lumen.delivery.client.utils.LumenStatsView
    android:id="@+id/dcStatsView"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />
            
                <io.streamroot.lumen.delivery.client.utils.LumenStatsView
    android:id="@+id/dcStatsView"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Finally, you will need to retrieve your view by your preferred method and link it with a LumenDeliveryClient or LumenDeliveryClientPlugin instance

                // Helper function to initializing the stats view
private fun initStatsView(dcStatsView: View) {
    dcStatsView.apply {
        // Instantiate a LumenStatsVie
        val statsView = LumenStatsView(context)
        lumenDeliveryClient?.addStateStatsListener(statsView)

        // Display the stat view. Otherwise it is hidden by default
        statsView.showStats()

        addView(statsView, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT)
    }
}

dcStatsView = ...
initStatsView(dcStatsView)
            
                // Helper function to initializing the stats view
private void showStatsView(LumenDeliveryClient dc) {
    ViewGroup svc = bindings.statsviewContainer;
    svc.removeAllViews();
    final LumenStatsView statsView = new LumenStatsView(this);
    dc.addStateStatsListener(statsView);
    statsView.showStats();
    svc.addView(statsView, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT);
}

dcStatsView = ...
initStatsView(dcStatsView)
            
                // Helper function to initializing the stats view
private fun initStatsView(dcStatsView: View) {
    dcStatsView.apply {
        // Instanciate a LumenStatsVie
        val statsView = LumenStatsView(context)
        plugin?.addStateStatsListener(statsView)

        // Display the stat view. Otherwise it is hidden by default
        statsView.showStats()

        addView(statsView, ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT)
    }
}

dcStatsView = ...
initStatsView(dcStatsView)

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


The estimated bandwidth of the CDN

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.

 

 

Learn how you can configure CDN Load Balancer for Android to best suit your needs