iOS SDK nuu:bit Portal Configuration Management

The SDK can be found here: https://github.com/nuubit/SDK/

Self Service Signup: https://portal.revapm.net/#/signup/plans

 

Purpose

This document provides information to facilitate the nuu:bit iOS SDK configuration settings manager. For information the capabilities and benefits of the SDK, please see the ‘Introduction to the nuu:bit SDK’.

 

nuu:bit Portal Configuration Menu



SDK Release versions

Since it is expected that over time the nuu:bit SDK functionality will change and extend, possibly with changes not fully compatible between different SDK versions it is possible to specify different application configurations for different SDK release versions.

Operation mode

The operation mode is selected via a pull down menu in the portal interface that controls the SDKs primary operation. The modes are:

Transfer (transfer_only)

Interception and acceleration of mobile application traffic is enabled. The transfer of traffic mode will be based on the allowed protocols and their availability on individual mobile devices.   The transferred traffic will also be based on the domain white lists, black lists and provisioned list.   

Report (report_only)

In the report mode, there is no interception of traffic. Reporting will be enabled based on the logging level settings.   Reports will also be sent based on the reporting interval, configured in seconds.

Transfer and Report

In the reporting and transfer modes, intercepted traffic will be reported.  The transfer of traffic will based on the allowed protocols.   The transferred traffic will be based on the domain white lists, black lists and provisioned list. Reporting will be enabled based on the logging will depending on setting.   Logs will also be sent based on the reporting interval, configured in seconds.

Off

The SDK interception and reporting functionalities will be turned off and the SDK will transparently send all data transfer request directly to data origin servers.

 

SDK Configuration Refresh Interval

The refresh interval determines the amount of time the SDK waits between checking if there is a new configuration.   The recommended value is 3600 seconds or once a day after setup and initial testing is complete.  This will keep the SDK from using the radio and draining the device battery unnecessarily.  Shorter intervals should be used on initial deployment (the default value is 1 hour).

 

SDK Configuration Stale Timeout

The configuration stale timeout is a safeguard for the App and SDK.  If this timeout is reached it indicates that the SDK on a mobile device failed to fetch a new configuration during the specified period of time since the last configuration update, and at that point the SDK will stop sending any data or stats requests to the nuu:bit platform. Data requests then will be sent directly to customer origin servers (transparent mode of SDK operation). This should be set to a high value depending on the App usage (the default value is 10 hours).

 

Allowed transport protocols

The SDK can function using either of two protocols – an UDP-based protocol NMP (nuu:bit Mobile Protocol) or TCP-based protocol DOTS (Dynamically Optimized Transport System). For more information on these two options, please see the Introduction to nuu:bit SDK document. [include link to KB]

This option is a radio button.

 

Initial transport protocol

The two choices are DOTS or NMP.  Since DOTS is a TCP variant, it is fully compatible with any network conditions.  Using NMP first could cause the App to start slower in some network conditions, such as using Wi-Fi in an enterprise environment.  That said, NMP will provide faster performance for the App on initialization.  

 

Reporting interval

The reporting interval is time between sending reporting data to the nuu:bit platform. The default value is 120 seconds.

 

Domain white-list

The white list is a basic access control mechanism that accelerated (transfers via nuu:bit global network) only 3rd party traffic that is contained in this list. Domains in the white list will have cacheable content cached on the nuu:bit edge. nuu:bit will respect the rules of the caching headers for the given content.

 

Domain black list

The blacklist is a basic access control mechanism that transfers all content, to include 3rd party content, except for the domain of the black list (i.e. list of denied accesses). Content is still downloaded, the black list will bypass the nuu:bit SDK. This is a JSON array. All other domain that are NOT in this list will have cacheable content cached at the nuu:bit edge.  nuu:bit will cache 3rd content based on the contents caching headers.  As an example, you see mathtag.com and google-analytics.com excluded from the transport. 

 

Domains provisioned list

A provisioned domain is configured in the nuu:bit platform.  The domain will be able to be managed by the nuu:bit APIs and the content caching can be controlled by nuu:bit’s caching rules.

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk